org.hippoecm.hst.core.jcr.pool
Interface PooledSession

All Superinterfaces:

javax.jcr.Session

public interface PooledSession
extends javax.jcr.Session

PooledSession interface. This interface extends javax.jcr.Session, allowing to set additional attributes for internal use. For example, if a pooled session is needed to refresh just before borrowing from the pool, the pool implementation can set a specific attribute to check it later.

Note: If a pooled session is already returned to the pool, then any method invocation on this pooled session will throw java.lang.IllegalStateException.

Version:

$Id: PooledSession.java 22522 2010-04-26 11:34:28Z wko $

Field Summary

Fields inherited from interface javax.jcr.Session

ACTION_ADD_NODE, ACTION_READ, ACTION_REMOVE, ACTION_SET_PROPERTY

Method Summary

void	activate() Marks this pooled session as activated.
String	getUserID() Gets the user ID that was used to acquire this session.
long	lastRefreshed() Returns the last refreshed time millis.
void	logoutSession() Invokes logout() of the underlying session.
void	passivate() Marks this pooled session as passivated.

Methods inherited from interface javax.jcr.Session

addLockToken, checkPermission, exportDocumentView, exportDocumentView, exportSystemView, exportSystemView, getAccessControlManager, getAttribute, getAttributeNames, getImportContentHandler, getItem, getLockTokens, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getNode, getNodeByIdentifier, getNodeByUUID, getProperty, getRepository, getRetentionManager, getRootNode, getValueFactory, getWorkspace, hasCapability, hasPendingChanges, hasPermission, impersonate, importXML, isLive, itemExists, logout, move, nodeExists, propertyExists, refresh, removeItem, removeLockToken, save, setNamespacePrefix

Method Detail

activate

void activate()

Marks this pooled session as activated.

passivate

void passivate()

Marks this pooled session as passivated.

logoutSession

void logoutSession()
                   throws javax.jcr.RepositoryException

Invokes logout() of the underlying session.

Throws:

javax.jcr.RepositoryException

lastRefreshed

long lastRefreshed()

Returns the last refreshed time millis.

Returns:

getUserID

String getUserID()

Gets the user ID that was used to acquire this session. This method is free to return an "anonymous user id" or null if the Credentials used to acquire this session happens not to have provided a real user ID (for example, if instead of SimpleCredentials some other implementation of Credentials was used).

Specified by:

getUserID in interface javax.jcr.Session

Returns:

the user id from the credentials used to acquire this session.