Package org.apache.jackrabbit.oak.jcr.session

Class SessionImpl

java.lang.Object

org.apache.jackrabbit.oak.jcr.session.SessionImpl

All Implemented Interfaces:

Session, JackrabbitSession

public class SessionImpl
extends Object
implements JackrabbitSession

TODO document

Field Summary

Fields inherited from interface org.apache.jackrabbit.api.JackrabbitSession

ACTION_ADD_PROPERTY, ACTION_LOCKING, ACTION_MODIFY_ACCESS_CONTROL, ACTION_MODIFY_PROPERTY, ACTION_NODE_TYPE_MANAGEMENT, ACTION_READ_ACCESS_CONTROL, ACTION_REMOVE_NODE, ACTION_REMOVE_PROPERTY, ACTION_USER_MANAGEMENT, ACTION_VERSIONING

Fields inherited from interface javax.jcr.Session

ACTION_ADD_NODE, ACTION_READ, ACTION_REMOVE, ACTION_SET_PROPERTY

Constructor Summary

Constructors

Constructor	Description
SessionImpl(SessionContext sessionContext)

Method Summary

Modifier and Type	Method	Description
void	addLockToken(String lt)
void	checkPermission(String absPath, String actions)
void	exportDocumentView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse)
void	exportDocumentView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse)
void	exportSystemView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse)
void	exportSystemView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse)
@NotNull AccessControlManager	getAccessControlManager()
Object	getAttribute(String name)
String[]	getAttributeNames()
@NotNull Set<Principal>	getBoundPrincipals()	Returns the set of principals associated with this session.
@NotNull String	getExpandedName(@NotNull Item item)	Returns the expanded name of the given Item.
@NotNull String	getExpandedPath(@NotNull Item item)	Returns the expanded path of the given Item.
@NotNull ContentHandler	getImportContentHandler(String parentAbsPath, int uuidBehavior)
Item	getItem(String absPath)
@Nullable Item	getItemOrNull(String absPath)	Returns the node at the specified absolute path in the workspace.
@NotNull String[]	getLockTokens()
String	getNamespacePrefix(String uri)
String[]	getNamespacePrefixes()
String	getNamespaceURI(String prefix)
Node	getNode(String absPath)
@NotNull Node	getNodeByIdentifier(String id)
@NotNull Node	getNodeByUUID(String uuid)
@Nullable Node	getNodeOrNull(String absPath)	Returns the node at the specified absolute path in the workspace or null if no such node exists.
@Nullable Node	getParentOrNull(@NotNull Item item)	Returns the parent of the given Item or null if no parent exists (either because the given Item represents the root node or the current session does not have sufficient access to retrieve the parent).
@NotNull PrincipalManager	getPrincipalManager()	Returns the PrincipalManager for the current Session.
Property	getProperty(String absPath)
@Nullable Property	getPropertyOrNull(String absPath)	Returns the property at the specified absolute path in the workspace or null if no such node exists.
@NotNull Repository	getRepository()
@NotNull RetentionManager	getRetentionManager()
@NotNull Node	getRootNode()
String	getUserID()
@NotNull UserManager	getUserManager()	Returns the UserManager for the current Session.
@NotNull ValueFactory	getValueFactory()
@NotNull Workspace	getWorkspace()
boolean	hasCapability(String methodName, Object target, Object[] arguments)
boolean	hasPendingChanges()
boolean	hasPermission(@NotNull String absPath, @NotNull String... actions)	Returns true if this Session has permission to perform the specified actions at the specified absPath and false otherwise.
boolean	hasPermission(String absPath, String actions)
@NotNull Session	impersonate(Credentials credentials)
void	importXML(String parentAbsPath, InputStream in, int uuidBehavior)
boolean	isLive()
boolean	itemExists(String absPath)
void	logout()
void	move(String srcAbsPath, String destAbsPath)
boolean	nodeExists(String absPath)
boolean	propertyExists(String absPath)
void	refresh(boolean keepChanges)
void	removeItem(String absPath)
void	removeLockToken(String lt)
void	save()
void	setNamespacePrefix(String prefix, String uri)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SessionImpl

public SessionImpl(SessionContext sessionContext)

Method Details

getNodeOrNull

@Nullable
public @Nullable Node getNodeOrNull(String absPath)
                             throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the node at the specified absolute path in the workspace or null if no such node exists.

Specified by:

getNodeOrNull in interface JackrabbitSession

Parameters:

absPath - An absolute path.

Returns:

the specified Node or null.

Throws:

RepositoryException - If another error occurs.

getPropertyOrNull

@Nullable
public @Nullable Property getPropertyOrNull(String absPath)
                                     throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the property at the specified absolute path in the workspace or null if no such node exists.

Specified by:

getPropertyOrNull in interface JackrabbitSession

Parameters:

absPath - An absolute path.

Returns:

the specified Property or null.

Throws:

RepositoryException - if another error occurs.

getItemOrNull

@Nullable
public @Nullable Item getItemOrNull(String absPath)
                             throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the node at the specified absolute path in the workspace. If no such node exists, then it returns the property at the specified path. If no such property exists, then it return null.

Specified by:

getItemOrNull in interface JackrabbitSession

Parameters:

absPath - An absolute path.

Returns:

the specified Item or null.

Throws:

RepositoryException - if another error occurs.

getParentOrNull

@Nullable
public @Nullable Node getParentOrNull(@NotNull
 @NotNull Item item)
                               throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the parent of the given Item or null if no parent exists (either because the given Item represents the root node or the current session does not have sufficient access to retrieve the parent).

Specified by:

getParentOrNull in interface JackrabbitSession

Parameters:

item - An Item that has been obtained by the current session.

Returns:

The parent node of the given Item or null.

Throws:

RepositoryException - If another error occurs.

See Also:

• Item.getParent()

getRepository

@NotNull
public @NotNull Repository getRepository()

Specified by:

getRepository in interface Session

getUserID

public String getUserID()

Specified by:

getUserID in interface Session

getAttributeNames

public String[] getAttributeNames()

Specified by:

getAttributeNames in interface Session

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface Session

getWorkspace

@NotNull
public @NotNull Workspace getWorkspace()

Specified by:

getWorkspace in interface Session

impersonate

@NotNull
public @NotNull Session impersonate(Credentials credentials)
                             throws RepositoryException

Specified by:

impersonate in interface Session

Throws:

RepositoryException

getValueFactory

@NotNull
public @NotNull ValueFactory getValueFactory()
                                      throws RepositoryException

Specified by:

getValueFactory in interface Session

Throws:

RepositoryException

getRootNode

@NotNull
public @NotNull Node getRootNode()
                          throws RepositoryException

Specified by:

getRootNode in interface Session

Throws:

RepositoryException

getNode

public Node getNode(String absPath)
             throws RepositoryException

Specified by:

getNode in interface Session

Throws:

RepositoryException

nodeExists

public boolean nodeExists(String absPath)
                   throws RepositoryException

Specified by:

nodeExists in interface Session

Throws:

RepositoryException

getNodeByUUID

@NotNull
public @NotNull Node getNodeByUUID(String uuid)
                            throws RepositoryException

Specified by:

getNodeByUUID in interface Session

Throws:

RepositoryException

getNodeByIdentifier

@NotNull
public @NotNull Node getNodeByIdentifier(String id)
                                  throws RepositoryException

Specified by:

getNodeByIdentifier in interface Session

Throws:

RepositoryException

getProperty

public Property getProperty(String absPath)
                     throws RepositoryException

Specified by:

getProperty in interface Session

Throws:

RepositoryException

propertyExists

public boolean propertyExists(String absPath)
                       throws RepositoryException

Specified by:

propertyExists in interface Session

Throws:

RepositoryException

getItem

public Item getItem(String absPath)
             throws RepositoryException

Specified by:

getItem in interface Session

Throws:

RepositoryException

itemExists

public boolean itemExists(String absPath)
                   throws RepositoryException

Specified by:

itemExists in interface Session

Throws:

RepositoryException

move

public void move(String srcAbsPath,
 String destAbsPath)
          throws RepositoryException

Specified by:

move in interface Session

Throws:

RepositoryException

removeItem

public void removeItem(String absPath)
                throws RepositoryException

Specified by:

removeItem in interface Session

Throws:

RepositoryException

save

public void save()
          throws RepositoryException

Specified by:

save in interface Session

Throws:

RepositoryException

refresh

public void refresh(boolean keepChanges)
             throws RepositoryException

Specified by:

refresh in interface Session

Throws:

RepositoryException

hasPendingChanges

public boolean hasPendingChanges()
                          throws RepositoryException

Specified by:

hasPendingChanges in interface Session

Throws:

RepositoryException

isLive

public boolean isLive()

Specified by:

isLive in interface Session

logout

public void logout()

Specified by:

logout in interface Session

getImportContentHandler

@NotNull
public @NotNull ContentHandler getImportContentHandler(String parentAbsPath,
 int uuidBehavior)
                                                throws RepositoryException

Specified by:

getImportContentHandler in interface Session

Throws:

RepositoryException

importXML

public void importXML(String parentAbsPath,
 InputStream in,
 int uuidBehavior)
               throws IOException,
RepositoryException

Specified by:

importXML in interface Session

Throws:

IOException

RepositoryException

exportSystemView

public void exportSystemView(String absPath,
 ContentHandler contentHandler,
 boolean skipBinary,
 boolean noRecurse)
                      throws SAXException,
RepositoryException

Specified by:

exportSystemView in interface Session

Throws:

SAXException

RepositoryException

exportSystemView

public void exportSystemView(String absPath,
 OutputStream out,
 boolean skipBinary,
 boolean noRecurse)
                      throws IOException,
RepositoryException

Specified by:

exportSystemView in interface Session

Throws:

IOException

RepositoryException

exportDocumentView

public void exportDocumentView(String absPath,
 ContentHandler contentHandler,
 boolean skipBinary,
 boolean noRecurse)
                        throws SAXException,
RepositoryException

Specified by:

exportDocumentView in interface Session

Throws:

SAXException

RepositoryException

exportDocumentView

public void exportDocumentView(String absPath,
 OutputStream out,
 boolean skipBinary,
 boolean noRecurse)
                        throws IOException,
RepositoryException

Specified by:

exportDocumentView in interface Session

Throws:

IOException

RepositoryException

addLockToken

public void addLockToken(String lt)

Specified by:

addLockToken in interface Session

getLockTokens

@NotNull
public @NotNull String[] getLockTokens()

Specified by:

getLockTokens in interface Session

removeLockToken

public void removeLockToken(String lt)

Specified by:

removeLockToken in interface Session

hasPermission

public boolean hasPermission(String absPath,
 String actions)
                      throws RepositoryException

Specified by:

hasPermission in interface Session

Throws:

RepositoryException

checkPermission

public void checkPermission(String absPath,
 String actions)
                     throws RepositoryException

Specified by:

checkPermission in interface Session

Throws:

RepositoryException

hasCapability

public boolean hasCapability(String methodName,
 Object target,
 Object[] arguments)
                      throws RepositoryException

Specified by:

hasCapability in interface Session

Throws:

RepositoryException

getAccessControlManager

@NotNull
public @NotNull AccessControlManager getAccessControlManager()
                                                      throws RepositoryException

Specified by:

getAccessControlManager in interface Session

Throws:

RepositoryException

getRetentionManager

@NotNull
public @NotNull RetentionManager getRetentionManager()
                                              throws RepositoryException

Specified by:

getRetentionManager in interface Session

Throws:

RepositoryException

See Also:

• Session.getRetentionManager()

setNamespacePrefix

public void setNamespacePrefix(String prefix,
 String uri)
                        throws RepositoryException

Specified by:

setNamespacePrefix in interface Session

Throws:

RepositoryException

getNamespacePrefixes

public String[] getNamespacePrefixes()
                              throws RepositoryException

Specified by:

getNamespacePrefixes in interface Session

Throws:

RepositoryException

getNamespaceURI

public String getNamespaceURI(String prefix)
                       throws RepositoryException

Specified by:

getNamespaceURI in interface Session

Throws:

RepositoryException

getNamespacePrefix

public String getNamespacePrefix(String uri)
                          throws RepositoryException

Specified by:

getNamespacePrefix in interface Session

Throws:

RepositoryException

hasPermission

public boolean hasPermission(@NotNull
 @NotNull String absPath,
 @NotNull
 @NotNull String... actions)
                      throws RepositoryException

Description copied from interface: JackrabbitSession

Returns true if this Session has permission to perform the specified actions at the specified absPath and false otherwise.

The actions parameter is a list of action strings. Apart from the actions defined on Session, this variant also allows to specify the following additional actions to provide better permission discovery:

• add_property: If hasPermission(path, "add_property") returns true, then this Session has permission to add a new property at path.
• modify_property: If hasPermission(path, "modify_property") returns true, then this Session has permission to change a property at path.
• remove_property: If hasPermission(path, "remove_property") returns true, then this Session has permission to remove a property at path.
• remove_node: If hasPermission(path, "remove_node") returns true, then this Session has permission to remove a node at path.
• node_type_management: If hasPermission(path, "node_type_management") returns true, then this Session has permission to explicitly set or change the node type information associated with a node at path.
• versioning: If hasPermission(path, "versioning") returns true, then this Session has permission to perform version related operations on a node at path.
• locking: If hasPermission(path, "locking") returns true, then this Session has permission to lock and unlock a node at path.
• read_access_control: If hasPermission(path, "read_access_control") returns true, then this Session has permission to read access control content stored at an item at path.
• modify_access_control: If hasPermission(path, "modify_access_control") returns true, then this Session has permission to modify access control content at an item at path.
• user_management: If hasPermission(path, "user_management") returns true, then this Session has permission to perform user management operations at an item at path.

When more than one action is specified, this method will only return true if this Session has permission to perform all of the listed actions at the specified path.

The information returned through this method will only reflect the permission status (both JCR defined and implementation-specific) and not other restrictions that may exist, such as node type or other implementation enforced constraints. For example, even though hasPermission may indicate that a particular Session may add a property at /A/B/C, the node type of the node at /A/B may prevent the addition of a property called C.

Specified by:

hasPermission in interface JackrabbitSession

Parameters:

absPath - an absolute path.

actions - one or several actions.

Returns:

true if this Session has permission to perform the specified actions at the specified absPath.

Throws:

RepositoryException - if an error occurs.

See Also:

• Session.hasPermission(String, String)

getPrincipalManager

@NotNull
public @NotNull PrincipalManager getPrincipalManager()
                                              throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the PrincipalManager for the current Session.

Specified by:

getPrincipalManager in interface JackrabbitSession

Returns:

the PrincipalManager associated with this Session.

Throws:

AccessDeniedException - If the session lacks privileges to access the principal manager or principals in general.

UnsupportedRepositoryOperationException - If principal management is not supported.

RepositoryException - If another error occurs.

See Also:

• PrincipalManager

getUserManager

@NotNull
public @NotNull UserManager getUserManager()
                                    throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the UserManager for the current Session.

Specified by:

getUserManager in interface JackrabbitSession

Returns:

the UserManager associated with this Session.

Throws:

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

UnsupportedRepositoryOperationException - If user management is not supported.

RepositoryException - If another error occurs.

See Also:

• UserManager

getBoundPrincipals

@NotNull
public @NotNull Set<Principal> getBoundPrincipals()
                                           throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the set of principals associated with this session.

Specified by:

getBoundPrincipals in interface JackrabbitSession

Returns:

the set of principals associated with this session. Usually this set is unmodifiable.

Throws:

RepositoryException - in case principal information cannot be retrieved.

toString

public String toString()

Overrides:

toString in class Object

getExpandedName

@NotNull
public @NotNull String getExpandedName(@NotNull
 @NotNull Item item)
                                throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the expanded name of the given Item.

Specified by:

getExpandedName in interface JackrabbitSession

Parameters:

item - the item for which to retrieve the name

Returns:

the name of the item in expanded form.

Throws:

NamespaceException - when no expanded name can be determined (for instance, if the registered namespace (name) is invalid)

RepositoryException - if another error occurs

See Also:

• JCR 2.0, 3.2.5.1 Expanded Form

getExpandedPath

@NotNull
public @NotNull String getExpandedPath(@NotNull
 @NotNull Item item)
                                throws RepositoryException

Description copied from interface: JackrabbitSession

Returns the expanded path of the given Item.

Specified by:

getExpandedPath in interface JackrabbitSession

Parameters:

item - the item for which to retrieve the name

Returns:

the path of the item in expanded form.

Throws:

NamespaceException - when no expanded name can be determined (for instance, if the registered namespace (name) is invalid)

RepositoryException - if another error occurs.

See Also:

• JCR 2.0, 3.2.5.1 Expanded Form