org.apache.jackrabbit.core
Class SessionImpl

java.lang.Object
  org.apache.jackrabbit.commons.AbstractSession
      org.apache.jackrabbit.core.SessionImpl

All Implemented Interfaces:

javax.jcr.Session, JackrabbitSession, Dumpable, NamePathResolver, NameResolver, PathResolver, NamespaceResolver

Direct Known Subclasses:

XASessionImpl

public class SessionImpl
extends AbstractSession
implements JackrabbitSession, NamespaceResolver, NamePathResolver, Dumpable

A SessionImpl ...

Field Summary

protected AccessManager	accessMgr the AccessManager associated with this session
static java.lang.String	ADD_NODE_ACTION TODO deprecate as soon as present with Session interface (JSR 283)
protected boolean	alive flag indicating whether this session is alive
protected java.util.HashMap	attributes the attributes of this session
protected HierarchyManager	hierMgr the HierarchyManager associated with this session
protected ItemManager	itemMgr the item mgr associated with this session
protected SessionItemStateManager	itemStateMgr the item state mgr associated with this session
protected java.util.Map	listeners Listeners (weak references)
protected java.util.Set	lockTokens Lock tokens
protected AuthContext	loginContext the AuthContext of this session (can be null if this session was not instantiated through a login process)
protected NamePathResolver	namePathResolver Name and Path resolver
protected NodeTypeManagerImpl	ntMgr the node type manager
static java.lang.String	READ_ACTION TODO deprecate as soon as present with Session interface (JSR 283)
static java.lang.String	REMOVE_ACTION TODO deprecate as soon as present with Session interface (JSR 283)
protected RepositoryImpl	rep the repository that issued this session
static java.lang.String	SET_PROPERTY_ACTION TODO deprecate as soon as present with Session interface (JSR 283)
protected javax.security.auth.Subject	subject the Subject of this session
protected java.lang.String	userId the user ID that was used to acquire this session
protected javax.jcr.ValueFactory	valueFactory value factory
protected VersionManager	versionMgr The version manager for this session
protected WorkspaceImpl	wsp the Workspace associated with this session

Constructor Summary

protected	SessionImpl(RepositoryImpl rep, AuthContext loginContext, WorkspaceConfig wspConfig) Protected constructor.
protected	SessionImpl(RepositoryImpl rep, javax.security.auth.Subject subject, WorkspaceConfig wspConfig) Protected constructor.

Method Summary

void	addListener(SessionListener listener) Add a SessionListener
void	addLockToken(java.lang.String lt)
void	addLockToken(java.lang.String lt, boolean notify) Internal implementation of addLockToken(String).
void	checkPermission(java.lang.String absPath, java.lang.String actions)
protected AccessManager	createAccessManager(javax.security.auth.Subject subject, HierarchyManager hierarchyManager) Create the access manager.
GarbageCollector	createDataStoreGarbageCollector() Create a data store garbage collector for this repository.
protected ItemManager	createItemManager(SessionItemStateManager itemStateMgr, HierarchyManager hierMgr) Create the item manager.
javax.jcr.Session	createSession(java.lang.String workspaceName) Creates a new session with the same subject as this sessions but to a different workspace.
protected SessionItemStateManager	createSessionItemStateManager(LocalItemStateManager manager) Create the session item state manager.
protected VersionManager	createVersionManager(RepositoryImpl rep) Create the version manager.
protected void	createWorkspace(java.lang.String workspaceName) Creates a workspace with the given name.
protected void	createWorkspace(java.lang.String workspaceName, org.xml.sax.InputSource configTemplate) Creates a workspace with the given name and a workspace configuration template.
protected WorkspaceImpl	createWorkspaceInstance(WorkspaceConfig wspConfig, SharedItemStateManager stateMgr, RepositoryImpl rep, SessionImpl session) Creates the workspace instance backing this session.
void	dump(java.io.PrintStream ps) Dumps the state of this instance in a human readable format for diagnostic purposes.
void	finalize() Finalize the session.
AccessControlManager	getAccessControlManager()
AccessManager	getAccessManager() Returns the AccessManager associated with this session.
java.lang.Object	getAttribute(java.lang.String name)
java.lang.String[]	getAttributeNames()
HierarchyManager	getHierarchyManager() Returns the HierarchyManager associated with this session.
org.xml.sax.ContentHandler	getImportContentHandler(java.lang.String parentAbsPath, int uuidBehavior)
javax.jcr.Item	getItem(java.lang.String absPath) Returns the node or property at the given path.
ItemManager	getItemManager() Returns the ItemManager of this session.
protected SessionItemStateManager	getItemStateManager() Returns the SessionItemStateManager associated with this session.
java.lang.String	getJCRName(Name name) Returns the prefixed JCR name for the given qualified name.
java.lang.String	getJCRPath(Path path) Returns the prefixed JCR path for the given qualified path.
LockManager	getLockManager() Return the lock manager for this session.
javax.jcr.lock.Lock[]	getLocks() Returns all locks owned by this session.
java.lang.String[]	getLockTokens()
javax.jcr.Node	getNode(java.lang.String absPath) Returns the node at the specified absolute path in the workspace.
NodeImpl	getNodeById(NodeId id) Retrieves the Node with the given id.
javax.jcr.Node	getNodeByIdentifier(java.lang.String id) Returns the node specified by the given identifier.
javax.jcr.Node	getNodeByUUID(java.lang.String uuid)
javax.jcr.Node	getNodeByUUID(UUID uuid) Retrieves the referenceable node with the given UUID.
NodeTypeManagerImpl	getNodeTypeManager() Returns the NodeTypeManager.
java.lang.String	getPrefix(java.lang.String uri) Returns the prefix which is mapped to the given URI.
PrincipalManager	getPrincipalManager() Returns the PrincipalManager for the current Session.
javax.jcr.Property	getProperty(java.lang.String absPath) Returns the property at the specified absolute path in the workspace.
Name	getQName(java.lang.String name) Returns the qualified name for the given prefixed JCR name.
Path	getQPath(java.lang.String path) Returns the qualified path for the given prefixed JCR path.
javax.jcr.Repository	getRepository()
RetentionManager	getRetentionManager()
javax.jcr.Node	getRootNode()
javax.security.auth.Subject	getSubject() Returns the Subject associated with this session.
java.lang.String	getURI(java.lang.String prefix) Returns the URI to which the given prefix is mapped.
java.lang.String	getUserID()
UserManager	getUserManager() Returns the UserManager for the current Session.
javax.jcr.ValueFactory	getValueFactory()
VersionManager	getVersionManager() Returns the VersionManager associated with this session.
javax.jcr.Workspace	getWorkspace()
protected java.lang.String[]	getWorkspaceNames() Returns the names of all workspaces of this repository with respect of the access rights of this session.
boolean	hasPendingChanges()
boolean	hasPermission(java.lang.String absPath, java.lang.String actions)
javax.jcr.Session	impersonate(javax.jcr.Credentials otherCredentials) Logs in the same workspace with the given credentials.
boolean	isLive()
boolean	itemExists(java.lang.String absPath) Calls AbstractSession.getItem(String) with the given path and returns true if the call succeeds.
void	logout() Clears the local namespace mappings.
void	move(java.lang.String srcAbsPath, java.lang.String destAbsPath)
boolean	nodeExists(java.lang.String absPath) Returns true if a node exists at absPath and this Session has read access to it; otherwise returns false.
protected void	notifyLoggedOut() Notify the listeners that this session has been closed.
protected void	notifyLoggingOut() Notify the listeners that this session is about to be closed.
boolean	propertyExists(java.lang.String absPath) Returns true if a property exists at absPath and this Session has read access to it; otherwise returns false.
void	refresh(boolean keepChanges)
void	removeListener(SessionListener listener) Remove a SessionListener
void	removeLockToken(java.lang.String lt)
void	removeLockToken(java.lang.String lt, boolean notify) Internal implementation of removeLockToken(String).
protected java.lang.String	retrieveUserId(javax.security.auth.Subject subject) Retrieve the userID from the specified subject.
protected void	sanityCheck() Performs a sanity check on this session.
void	save()
void	setNamespacePrefix(java.lang.String prefix, java.lang.String uri) Modifies the session local namespace mappings to contain the given prefix to URI mapping.

Methods inherited from class org.apache.jackrabbit.commons.AbstractSession

exportDocumentView, exportDocumentView, exportSystemView, exportSystemView, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, importXML

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.jcr.Session

exportDocumentView, exportDocumentView, exportSystemView, exportSystemView, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, importXML

Field Detail

READ_ACTION

public static final java.lang.String READ_ACTION

TODO deprecate as soon as present with Session interface (JSR 283)

See Also:

Constant Field Values

REMOVE_ACTION

public static final java.lang.String REMOVE_ACTION

TODO deprecate as soon as present with Session interface (JSR 283)

See Also:

Constant Field Values

ADD_NODE_ACTION

public static final java.lang.String ADD_NODE_ACTION

TODO deprecate as soon as present with Session interface (JSR 283)

See Also:

Constant Field Values

SET_PROPERTY_ACTION

public static final java.lang.String SET_PROPERTY_ACTION

TODO deprecate as soon as present with Session interface (JSR 283)

See Also:

Constant Field Values

alive

protected boolean alive

flag indicating whether this session is alive

rep

protected final RepositoryImpl rep

the repository that issued this session

loginContext

protected AuthContext loginContext

the AuthContext of this session (can be null if this session was not instantiated through a login process)

subject

protected final javax.security.auth.Subject subject

the Subject of this session

userId

protected final java.lang.String userId

the user ID that was used to acquire this session

attributes

protected final java.util.HashMap attributes

the attributes of this session

ntMgr

protected final NodeTypeManagerImpl ntMgr

the node type manager

accessMgr

protected AccessManager accessMgr

the AccessManager associated with this session

itemStateMgr

protected final SessionItemStateManager itemStateMgr

the item state mgr associated with this session

hierMgr

protected final HierarchyManager hierMgr

the HierarchyManager associated with this session

itemMgr

protected final ItemManager itemMgr

the item mgr associated with this session

wsp

protected final WorkspaceImpl wsp

the Workspace associated with this session

namePathResolver

protected NamePathResolver namePathResolver

Name and Path resolver

versionMgr

protected final VersionManager versionMgr

The version manager for this session

listeners

protected final java.util.Map listeners

Listeners (weak references)

lockTokens

protected final java.util.Set lockTokens

Lock tokens

valueFactory

protected javax.jcr.ValueFactory valueFactory

value factory

Constructor Detail

SessionImpl

protected SessionImpl(RepositoryImpl rep,
                      AuthContext loginContext,
                      WorkspaceConfig wspConfig)
               throws javax.jcr.AccessDeniedException,
                      javax.jcr.RepositoryException

Protected constructor.

Parameters:

rep -

loginContext -

wspConfig -

Throws:

javax.jcr.AccessDeniedException - if the subject of the given login context is not granted access to the specified workspace

javax.jcr.RepositoryException - if another error occurs

SessionImpl

protected SessionImpl(RepositoryImpl rep,
                      javax.security.auth.Subject subject,
                      WorkspaceConfig wspConfig)
               throws javax.jcr.AccessDeniedException,
                      javax.jcr.RepositoryException

Protected constructor.

Parameters:

rep -

subject -

wspConfig -

Throws:

javax.jcr.AccessDeniedException - if the given subject is not granted access to the specified workspace

javax.jcr.RepositoryException - if another error occurs

Method Detail

retrieveUserId

protected java.lang.String retrieveUserId(javax.security.auth.Subject subject)
                                   throws javax.jcr.RepositoryException

Retrieve the userID from the specified subject.

Returns:

the userID.

Throws:

javax.jcr.RepositoryException

createSessionItemStateManager

protected SessionItemStateManager createSessionItemStateManager(LocalItemStateManager manager)

Create the session item state manager.

Returns:

session item state manager

createWorkspaceInstance

protected WorkspaceImpl createWorkspaceInstance(WorkspaceConfig wspConfig,
                                                SharedItemStateManager stateMgr,
                                                RepositoryImpl rep,
                                                SessionImpl session)

Creates the workspace instance backing this session.

Parameters:

wspConfig - The workspace configuration

stateMgr - The shared item state manager

rep - The repository

session - The session

Returns:

An instance of the WorkspaceImpl class or an extension thereof.

createItemManager

protected ItemManager createItemManager(SessionItemStateManager itemStateMgr,
                                        HierarchyManager hierMgr)

Create the item manager.

Returns:

item manager

createVersionManager

protected VersionManager createVersionManager(RepositoryImpl rep)
                                       throws javax.jcr.RepositoryException

Create the version manager. If we are not using XA, we may safely use the repository version manager.

Returns:

version manager

Throws:

javax.jcr.RepositoryException

createAccessManager

protected AccessManager createAccessManager(javax.security.auth.Subject subject,
                                            HierarchyManager hierarchyManager)
                                     throws javax.jcr.AccessDeniedException,
                                            javax.jcr.RepositoryException

Create the access manager.

Parameters:

subject -

hierarchyManager -

Returns:

access manager

Throws:

javax.jcr.AccessDeniedException - if the current subject is not granted access to the current workspace

javax.jcr.RepositoryException - if the access manager cannot be instantiated

sanityCheck

protected void sanityCheck()
                    throws javax.jcr.RepositoryException

Performs a sanity check on this session.

Throws:

javax.jcr.RepositoryException - if this session has been rendered invalid for some reason (e.g. if this session has been closed explicitly or if it has expired)

getSubject

public javax.security.auth.Subject getSubject()

Returns the Subject associated with this session.

Returns:

the Subject associated with this session

createSession

public javax.jcr.Session createSession(java.lang.String workspaceName)
                                throws javax.jcr.AccessDeniedException,
                                       javax.jcr.NoSuchWorkspaceException,
                                       javax.jcr.RepositoryException

Creates a new session with the same subject as this sessions but to a different workspace. The returned session is a newly logged in session, with the same subject but a different workspace. Even if the given workspace is the same as this sessions one, the implementation must return a new session object.

Parameters:

workspaceName - name of the workspace to acquire a session for.

Returns:

A session to the requested workspace for the same authenticated subject.

Throws:

javax.jcr.AccessDeniedException - in case the current Subject is not allowed to access the requested Workspace

javax.jcr.NoSuchWorkspaceException - If the named workspace does not exist.

javax.jcr.RepositoryException - in any other exceptional state

getAccessManager

public AccessManager getAccessManager()

Returns the AccessManager associated with this session.

Returns:

the AccessManager associated with this session

getNodeTypeManager

public NodeTypeManagerImpl getNodeTypeManager()

Returns the NodeTypeManager.

Returns:

the NodeTypeManager

getItemManager

public ItemManager getItemManager()

Returns the ItemManager of this session.

Returns:

the ItemManager

getItemStateManager

protected SessionItemStateManager getItemStateManager()

Returns the SessionItemStateManager associated with this session.

Returns:

the SessionItemStateManager associated with this session

getHierarchyManager

public HierarchyManager getHierarchyManager()

Returns the HierarchyManager associated with this session.

Returns:

the HierarchyManager associated with this session

getVersionManager

public VersionManager getVersionManager()

Returns the VersionManager associated with this session.

Returns:

the VersionManager associated with this session

getNodeByUUID

public javax.jcr.Node getNodeByUUID(UUID uuid)
                             throws javax.jcr.ItemNotFoundException,
                                    javax.jcr.RepositoryException

Retrieves the referenceable node with the given UUID.

Parameters:

uuid - uuid of the node to be retrieved

Returns:

referenceable node with the given uuid

Throws:

javax.jcr.ItemNotFoundException - if no node exists with the given uuid or if the existing node is not referenceable.

javax.jcr.RepositoryException - if another error occurs.

See Also:

getNodeByUUID(String), getNodeById(NodeId)

getNodeById

public NodeImpl getNodeById(NodeId id)
                     throws javax.jcr.ItemNotFoundException,
                            javax.jcr.RepositoryException

Retrieves the Node with the given id.

Parameters:

id - id of node to be retrieved

Returns:

node with the given NodeId.

Throws:

javax.jcr.ItemNotFoundException - if no such node exists or if this Session does not have permission to access the node.

javax.jcr.RepositoryException - if another error occurs.

getWorkspaceNames

protected java.lang.String[] getWorkspaceNames()
                                        throws javax.jcr.RepositoryException

Returns the names of all workspaces of this repository with respect of the access rights of this session.

Returns:

the names of all accessible workspaces

Throws:

javax.jcr.RepositoryException - if an error occurs

createWorkspace

protected void createWorkspace(java.lang.String workspaceName)
                        throws javax.jcr.AccessDeniedException,
                               javax.jcr.RepositoryException

Creates a workspace with the given name.

Parameters:

workspaceName - name of the new workspace

Throws:

javax.jcr.AccessDeniedException - if the current session is not allowed to create the workspace

javax.jcr.RepositoryException - if a workspace with the given name already exists or if another error occurs

createWorkspace

protected void createWorkspace(java.lang.String workspaceName,
                               org.xml.sax.InputSource configTemplate)
                        throws javax.jcr.AccessDeniedException,
                               javax.jcr.RepositoryException

Creates a workspace with the given name and a workspace configuration template.

Parameters:

workspaceName - name of the new workspace

configTemplate - the configuration template of the new workspace

Throws:

javax.jcr.AccessDeniedException - if the current session is not allowed to create the workspace

javax.jcr.RepositoryException - if a workspace with the given name already exists or if another error occurs

notifyLoggingOut

protected void notifyLoggingOut()

Notify the listeners that this session is about to be closed.

notifyLoggedOut

protected void notifyLoggedOut()

Notify the listeners that this session has been closed.

addListener

public void addListener(SessionListener listener)

Add a SessionListener

Parameters:

listener - the new listener to be informed on modifications

removeListener

public void removeListener(SessionListener listener)

Remove a SessionListener

Parameters:

listener - an existing listener

createDataStoreGarbageCollector

public GarbageCollector createDataStoreGarbageCollector()
                                                 throws javax.jcr.RepositoryException,
                                                        ItemStateException

Create a data store garbage collector for this repository.

Throws:

ItemStateException

javax.jcr.RepositoryException

getPrefix

public java.lang.String getPrefix(java.lang.String uri)
                           throws javax.jcr.NamespaceException

Description copied from interface: NamespaceResolver

Returns the prefix which is mapped to the given URI.

Specified by:

getPrefix in interface NamespaceResolver

Parameters:

uri - namespace URI

Returns:

the prefix mapped to the given URI.

Throws:

javax.jcr.NamespaceException - if the URI is unknown.

getURI

public java.lang.String getURI(java.lang.String prefix)
                        throws javax.jcr.NamespaceException

Description copied from interface: NamespaceResolver

Returns the URI to which the given prefix is mapped.

Specified by:

getURI in interface NamespaceResolver

Parameters:

prefix - namespace prefix

Returns:

the namespace URI to which the given prefix is mapped.

Throws:

javax.jcr.NamespaceException - if the prefix is unknown.

getJCRName

public java.lang.String getJCRName(Name name)
                            throws javax.jcr.NamespaceException

Description copied from interface: NameResolver

Returns the prefixed JCR name for the given qualified name.

Specified by:

getJCRName in interface NameResolver

Parameters:

name - qualified name

Returns:

prefixed JCR name

Throws:

javax.jcr.NamespaceException - if the namespace URI can not be resolved

getQName

public Name getQName(java.lang.String name)
              throws IllegalNameException,
                     javax.jcr.NamespaceException

Description copied from interface: NameResolver

Returns the qualified name for the given prefixed JCR name.

Specified by:

getQName in interface NameResolver

Parameters:

name - prefixed JCR name

Returns:

qualified name

Throws:

IllegalNameException - if the JCR name format is invalid

javax.jcr.NamespaceException - if the namespace prefix can not be resolved

getJCRPath

public java.lang.String getJCRPath(Path path)
                            throws javax.jcr.NamespaceException

Description copied from interface: PathResolver

Returns the prefixed JCR path for the given qualified path.

Specified by:

getJCRPath in interface PathResolver

Parameters:

path - qualified path

Returns:

prefixed JCR path

Throws:

javax.jcr.NamespaceException - if a namespace URI can not be resolved

getQPath

public Path getQPath(java.lang.String path)
              throws MalformedPathException,
                     IllegalNameException,
                     javax.jcr.NamespaceException

Description copied from interface: PathResolver

Returns the qualified path for the given prefixed JCR path.

Specified by:

getQPath in interface PathResolver

Parameters:

path - prefixed JCR path

Returns:

qualified path

Throws:

MalformedPathException - if the JCR path format is invalid.

IllegalNameException - if any of the JCR names contained in the path are invalid.

javax.jcr.NamespaceException - if a namespace prefix can not be resolved.

getPrincipalManager

public PrincipalManager getPrincipalManager()
                                     throws javax.jcr.RepositoryException,
                                            javax.jcr.AccessDeniedException

Description copied from interface: JackrabbitSession

Returns the PrincipalManager for the current Session.

Specified by:

getPrincipalManager in interface JackrabbitSession

Returns:

this sessions principal manager.

Throws:

javax.jcr.AccessDeniedException

javax.jcr.UnsupportedRepositoryOperationException - If principal management is not supported.

javax.jcr.RepositoryException

See Also:

JackrabbitSession.getPrincipalManager()

getUserManager

public UserManager getUserManager()
                           throws javax.jcr.AccessDeniedException,
                                  javax.jcr.RepositoryException

Description copied from interface: JackrabbitSession

Returns the UserManager for the current Session.

Specified by:

getUserManager in interface JackrabbitSession

Throws:

javax.jcr.AccessDeniedException - If this session is not allowed to to access user data.

javax.jcr.UnsupportedRepositoryOperationException - If user management is not supported.

javax.jcr.RepositoryException - If another error occurs.

See Also:

JackrabbitSession.getUserManager()

checkPermission

public void checkPermission(java.lang.String absPath,
                            java.lang.String actions)
                     throws java.security.AccessControlException,
                            javax.jcr.RepositoryException

Specified by:

checkPermission in interface javax.jcr.Session

Throws:

java.security.AccessControlException

javax.jcr.RepositoryException

getWorkspace

public javax.jcr.Workspace getWorkspace()

Specified by:

getWorkspace in interface javax.jcr.Session

impersonate

public javax.jcr.Session impersonate(javax.jcr.Credentials otherCredentials)
                              throws javax.jcr.LoginException,
                                     javax.jcr.RepositoryException

Logs in the same workspace with the given credentials.

The default implementation:

• Retrieves the Repository instance using Session.getRepository()
• Retrieves the current workspace using Session.getWorkspace()
• Retrieves the name of the current workspace using Workspace.getName()
• Calls Repository.login(Credentials, String) on the retrieved repository with the given credentials and the retrieved workspace name.

Specified by:

impersonate in interface javax.jcr.Session

Overrides:

impersonate in class AbstractSession

Parameters:

otherCredentials - login credentials

Returns:

logged in session

Throws:

javax.jcr.RepositoryException - if an error occurs

javax.jcr.LoginException

getRootNode

public javax.jcr.Node getRootNode()
                           throws javax.jcr.RepositoryException

Specified by:

getRootNode in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

getNodeByUUID

public javax.jcr.Node getNodeByUUID(java.lang.String uuid)
                             throws javax.jcr.ItemNotFoundException,
                                    javax.jcr.RepositoryException

Specified by:

getNodeByUUID in interface javax.jcr.Session

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

getItem

public javax.jcr.Item getItem(java.lang.String absPath)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Returns the node or property at the given path.

The default implementation:

• Throws a PathNotFoundException if the given path does not start with a slash.
• Returns the root node if the given path is "/"
• Calls Node.getNode(String) on the root node with the part of the given path after the first slash
• Calls Node.getProperty(String) similarly in case the above call fails with a PathNotFoundException

Specified by:

getItem in interface javax.jcr.Session

Overrides:

getItem in class AbstractSession

Parameters:

absPath - absolute path

Returns:

the node or property with the given path

Throws:

javax.jcr.PathNotFoundException - if the given path is invalid or not found

javax.jcr.RepositoryException - if another error occurs

itemExists

public boolean itemExists(java.lang.String absPath)
                   throws javax.jcr.RepositoryException

Calls AbstractSession.getItem(String) with the given path and returns true if the call succeeds. Returns false if a PathNotFoundException was thrown. Other exceptions are passed through.

Specified by:

itemExists in interface javax.jcr.Session

Overrides:

itemExists in class AbstractSession

Parameters:

absPath - absolute path

Returns:

true if an item exists at the given path, false otherwise

Throws:

javax.jcr.RepositoryException - if an error occurs

save

public void save()
          throws javax.jcr.AccessDeniedException,
                 javax.jcr.ItemExistsException,
                 javax.jcr.nodetype.ConstraintViolationException,
                 javax.jcr.InvalidItemStateException,
                 javax.jcr.version.VersionException,
                 javax.jcr.lock.LockException,
                 javax.jcr.nodetype.NoSuchNodeTypeException,
                 javax.jcr.RepositoryException

Specified by:

save in interface javax.jcr.Session

Throws:

javax.jcr.AccessDeniedException

javax.jcr.ItemExistsException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.InvalidItemStateException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.NoSuchNodeTypeException

javax.jcr.RepositoryException

refresh

public void refresh(boolean keepChanges)
             throws javax.jcr.RepositoryException

Specified by:

refresh in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

hasPendingChanges

public boolean hasPendingChanges()
                          throws javax.jcr.RepositoryException

Specified by:

hasPendingChanges in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

move

public void move(java.lang.String srcAbsPath,
                 java.lang.String destAbsPath)
          throws javax.jcr.ItemExistsException,
                 javax.jcr.PathNotFoundException,
                 javax.jcr.version.VersionException,
                 javax.jcr.nodetype.ConstraintViolationException,
                 javax.jcr.lock.LockException,
                 javax.jcr.RepositoryException

Specified by:

move in interface javax.jcr.Session

Throws:

javax.jcr.ItemExistsException

javax.jcr.PathNotFoundException

javax.jcr.version.VersionException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

getImportContentHandler

public org.xml.sax.ContentHandler getImportContentHandler(java.lang.String parentAbsPath,
                                                          int uuidBehavior)
                                                   throws javax.jcr.PathNotFoundException,
                                                          javax.jcr.nodetype.ConstraintViolationException,
                                                          javax.jcr.version.VersionException,
                                                          javax.jcr.lock.LockException,
                                                          javax.jcr.RepositoryException

Specified by:

getImportContentHandler in interface javax.jcr.Session

Throws:

javax.jcr.PathNotFoundException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

isLive

public boolean isLive()

Specified by:

isLive in interface javax.jcr.Session

logout

public void logout()

Clears the local namespace mappings. Subclasses that for example want to participate in a session pools should remember to call super.logout() when overriding this method to avoid namespace mappings to be carried over to a new session.

Specified by:

logout in interface javax.jcr.Session

Overrides:

logout in class AbstractSession

getRepository

public javax.jcr.Repository getRepository()

Specified by:

getRepository in interface javax.jcr.Session

getValueFactory

public javax.jcr.ValueFactory getValueFactory()
                                       throws javax.jcr.UnsupportedRepositoryOperationException,
                                              javax.jcr.RepositoryException

Specified by:

getValueFactory in interface javax.jcr.Session

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

getUserID

public java.lang.String getUserID()

Specified by:

getUserID in interface javax.jcr.Session

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Specified by:

getAttribute in interface javax.jcr.Session

getAttributeNames

public java.lang.String[] getAttributeNames()

Specified by:

getAttributeNames in interface javax.jcr.Session

setNamespacePrefix

public void setNamespacePrefix(java.lang.String prefix,
                               java.lang.String uri)
                        throws javax.jcr.NamespaceException,
                               javax.jcr.RepositoryException

Modifies the session local namespace mappings to contain the given prefix to URI mapping.

This behaviour is based on JSR 283 (JCR 2.0), but remains backwards compatible with JCR 1.0.

Specified by:

setNamespacePrefix in interface javax.jcr.Session

Overrides:

setNamespacePrefix in class AbstractSession

Parameters:

prefix - namespace prefix

uri - namespace URI

Throws:

javax.jcr.NamespaceException - if the mapping is illegal

javax.jcr.RepositoryException - if a repository error occurs

addLockToken

public void addLockToken(java.lang.String lt)

Specified by:

addLockToken in interface javax.jcr.Session

addLockToken

public void addLockToken(java.lang.String lt,
                         boolean notify)

Internal implementation of addLockToken(String). Additionally takes a parameter indicating whether the lock manager needs to be informed.

getLockTokens

public java.lang.String[] getLockTokens()

Specified by:

getLockTokens in interface javax.jcr.Session

removeLockToken

public void removeLockToken(java.lang.String lt)

Specified by:

removeLockToken in interface javax.jcr.Session

removeLockToken

public void removeLockToken(java.lang.String lt,
                            boolean notify)

Internal implementation of removeLockToken(String). Additionally takes a parameter indicating whether the lock manager needs to be informed.

getLockManager

public LockManager getLockManager()
                           throws javax.jcr.RepositoryException

Return the lock manager for this session.

Returns:

lock manager for this session

Throws:

javax.jcr.RepositoryException

getLocks

public javax.jcr.lock.Lock[] getLocks()

Returns all locks owned by this session.

Returns:

an array of Locks

getNodeByIdentifier

public javax.jcr.Node getNodeByIdentifier(java.lang.String id)
                                   throws javax.jcr.ItemNotFoundException,
                                          javax.jcr.RepositoryException

Returns the node specified by the given identifier. Applies to both referenceable and non-referenceable nodes.

An ItemNotFoundException is thrown if no node with the specified identifier exists. This exception is also thrown if this Session does not have read access to the node with the specified identifier.

A RepositoryException is thrown if another error occurs.

Parameters:

id - An identifier.

Returns:

A Node.

Throws:

javax.jcr.ItemNotFoundException - if the specified identifier is not found.

javax.jcr.RepositoryException - if another error occurs.

Since:

JCR 2.0

getNode

public javax.jcr.Node getNode(java.lang.String absPath)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Returns the node at the specified absolute path in the workspace. If no node exists, then a PathNotFoundException is thrown.

Parameters:

absPath - An absolute path.

Returns:

the specified Node.

Throws:

javax.jcr.PathNotFoundException - If no node exists.

javax.jcr.RepositoryException - If another error occurs.

Since:

JCR 2.0

getProperty

public javax.jcr.Property getProperty(java.lang.String absPath)
                               throws javax.jcr.PathNotFoundException,
                                      javax.jcr.RepositoryException

Returns the property at the specified absolute path in the workspace. If no property exists, then a PathNotFoundException is thrown.

Parameters:

absPath - An absolute path.

Returns:

the specified Property.

Throws:

javax.jcr.PathNotFoundException - If no property exists.

javax.jcr.RepositoryException - if another error occurs.

Since:

JCR 2.0

nodeExists

public boolean nodeExists(java.lang.String absPath)
                   throws javax.jcr.RepositoryException

Returns true if a node exists at absPath and this Session has read access to it; otherwise returns false.

Throws a RepositoryException if absPath is not a well-formed absolute path.

Parameters:

absPath - An absolute path.

Returns:

a boolean

Throws:

javax.jcr.RepositoryException - if absPath is not a well-formed absolute path.

Since:

JCR 2.0

propertyExists

public boolean propertyExists(java.lang.String absPath)
                       throws javax.jcr.RepositoryException

Returns true if a property exists at absPath and this Session has read access to it; otherwise returns false.

Throws a RepositoryException if absPath is not a well-formed absolute path.

Parameters:

absPath - An absolute path.

Returns:

a boolean

Throws:

javax.jcr.RepositoryException - if absPath is not a well-formed absolute path.

Since:

JCR 2.0

hasPermission

public boolean hasPermission(java.lang.String absPath,
                             java.lang.String actions)
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

Since:

2.0

See Also:

Session#hasPermission(String, String)

getAccessControlManager

public AccessControlManager getAccessControlManager()
                                             throws javax.jcr.UnsupportedRepositoryOperationException,
                                                    javax.jcr.RepositoryException

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

Since:

JCR 2.0

See Also:

Session#getAccessControlManager()

getRetentionManager

public RetentionManager getRetentionManager()
                                     throws javax.jcr.UnsupportedRepositoryOperationException,
                                            javax.jcr.RepositoryException

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

Since:

JCR 2.0

See Also:

Session#getRetentionManager()

dump

public void dump(java.io.PrintStream ps)

Dumps the state of this instance in a human readable format for diagnostic purposes.

Specified by:

dump in interface Dumpable

Parameters:

ps - stream to dump state to

finalize

public void finalize()

Finalize the session. If the application doesn't close Session.logout(), the session is closed automatically; however a warning is written to the log file, together with the stack trace of where the session was opened.

Overrides:

finalize in class java.lang.Object