com.adobe.acs.commons.wrap.jcr

Interface BaseSessionIWrap<S extends javax.jcr.Session>

Type Parameters:

S - the type of session that is being wrapped.

All Superinterfaces:

javax.jcr.Session

All Known Subinterfaces:

JackrabbitSessionIWrap, SessionIWrap

@ProviderType
public interface BaseSessionIWrap<S extends javax.jcr.Session>
extends javax.jcr.Session

This is the base interface for SessionIWrap and JackrabbitSessionIWrap. Default methods are not only defined for all Session methods, but also for a few methods to wrap other JCR types that retain references to the wrapped session, and which therefore might need to be overridden to keep the integrity of the wrapper API in more complex use cases.

Field Summary

Fields inherited from interface javax.jcr.Session

ACTION_ADD_NODE, ACTION_READ, ACTION_REMOVE, ACTION_SET_PROPERTY

Method Summary

Modifier and Type	Method and Description
default void	addLockToken(String lt)
default void	checkPermission(String absPath, String actions)
default void	exportDocumentView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse)
default void	exportDocumentView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse)
default void	exportSystemView(String absPath, ContentHandler contentHandler, boolean skipBinary, boolean noRecurse)
default void	exportSystemView(String absPath, OutputStream out, boolean skipBinary, boolean noRecurse)
default javax.jcr.security.AccessControlManager	getAccessControlManager()
default Object	getAttribute(String name)
default String[]	getAttributeNames()
default ContentHandler	getImportContentHandler(String parentAbsPath, int uuidBehavior)
default javax.jcr.Item	getItem(String absPath)
default String[]	getLockTokens()
default String	getNamespacePrefix(String uri)
default String[]	getNamespacePrefixes()
default String	getNamespaceURI(String prefix)
default javax.jcr.Node	getNode(String absPath)
default javax.jcr.Node	getNodeByIdentifier(String id)
default javax.jcr.Node	getNodeByUUID(String uuid)
default javax.jcr.Property	getProperty(String absPath)
default javax.jcr.Repository	getRepository()
default javax.jcr.retention.RetentionManager	getRetentionManager()
default javax.jcr.Node	getRootNode()
default String	getUserID()
default javax.jcr.ValueFactory	getValueFactory()
default javax.jcr.Workspace	getWorkspace()
default boolean	hasCapability(String methodName, Object target, Object[] arguments)
default boolean	hasPendingChanges()
default boolean	hasPermission(String absPath, String actions)
default javax.jcr.Session	impersonate(javax.jcr.Credentials credentials)
default void	importXML(String parentAbsPath, InputStream in, int uuidBehavior)
default boolean	isLive()
default boolean	itemExists(String absPath)
default void	logout()
default void	move(String srcAbsPath, String destAbsPath)
default boolean	nodeExists(String absPath)
default boolean	propertyExists(String absPath)
default void	refresh(boolean keepChanges)
default void	removeItem(String absPath)
default void	removeLockToken(String lt)
default void	save()
default void	setNamespacePrefix(String prefix, String uri)
S	unwrapSession() Return the underlying session.
default <T extends javax.jcr.Item> T	wrapItem(T item)
default javax.jcr.Session	wrapSession(javax.jcr.Session session)
default javax.jcr.Workspace	wrapWorkspace(javax.jcr.Workspace workspace)

Method Detail

unwrapSession

S unwrapSession()

Return the underlying session.

Returns:

the underlying session

wrapItem

@Nonnull
default <T extends javax.jcr.Item> T wrapItem(@Nonnull
                                                       T item)

wrapSession

@Nonnull
default javax.jcr.Session wrapSession(@Nonnull
                                               javax.jcr.Session session)

wrapWorkspace

@Nonnull
default javax.jcr.Workspace wrapWorkspace(@Nonnull
                                                   javax.jcr.Workspace workspace)

getRepository

default javax.jcr.Repository getRepository()

Specified by:

getRepository in interface javax.jcr.Session

getUserID

default String getUserID()

Specified by:

getUserID in interface javax.jcr.Session

getAttributeNames

default String[] getAttributeNames()

Specified by:

getAttributeNames in interface javax.jcr.Session

getAttribute

default Object getAttribute(String name)

Specified by:

getAttribute in interface javax.jcr.Session

getWorkspace

default javax.jcr.Workspace getWorkspace()

Specified by:

getWorkspace in interface javax.jcr.Session

getRootNode

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

Specified by:

getRootNode in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

impersonate

default javax.jcr.Session impersonate(javax.jcr.Credentials credentials)
                               throws javax.jcr.LoginException,
                                      javax.jcr.RepositoryException

Specified by:

impersonate in interface javax.jcr.Session

Throws:

javax.jcr.LoginException

javax.jcr.RepositoryException

getNodeByUUID

default javax.jcr.Node getNodeByUUID(String uuid)
                              throws javax.jcr.ItemNotFoundException,
                                     javax.jcr.RepositoryException

Specified by:

getNodeByUUID in interface javax.jcr.Session

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

getNodeByIdentifier

default javax.jcr.Node getNodeByIdentifier(String id)
                                    throws javax.jcr.ItemNotFoundException,
                                           javax.jcr.RepositoryException

Specified by:

getNodeByIdentifier in interface javax.jcr.Session

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

getItem

default javax.jcr.Item getItem(String absPath)
                        throws javax.jcr.PathNotFoundException,
                               javax.jcr.RepositoryException

Specified by:

getItem in interface javax.jcr.Session

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

getNode

default javax.jcr.Node getNode(String absPath)
                        throws javax.jcr.PathNotFoundException,
                               javax.jcr.RepositoryException

Specified by:

getNode in interface javax.jcr.Session

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

getProperty

default javax.jcr.Property getProperty(String absPath)
                                throws javax.jcr.PathNotFoundException,
                                       javax.jcr.RepositoryException

Specified by:

getProperty in interface javax.jcr.Session

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

itemExists

default boolean itemExists(String absPath)
                    throws javax.jcr.RepositoryException

Specified by:

itemExists in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

nodeExists

default boolean nodeExists(String absPath)
                    throws javax.jcr.RepositoryException

Specified by:

nodeExists in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

propertyExists

default boolean propertyExists(String absPath)
                        throws javax.jcr.RepositoryException

Specified by:

propertyExists in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

move

default void move(String srcAbsPath,
                  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

removeItem

default void removeItem(String absPath)
                 throws javax.jcr.version.VersionException,
                        javax.jcr.lock.LockException,
                        javax.jcr.nodetype.ConstraintViolationException,
                        javax.jcr.AccessDeniedException,
                        javax.jcr.RepositoryException

Specified by:

removeItem in interface javax.jcr.Session

Throws:

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException

save

default void save()
           throws javax.jcr.AccessDeniedException,
                  javax.jcr.ItemExistsException,
                  javax.jcr.ReferentialIntegrityException,
                  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.ReferentialIntegrityException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.InvalidItemStateException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.NoSuchNodeTypeException

javax.jcr.RepositoryException

refresh

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

Specified by:

refresh in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

hasPendingChanges

default boolean hasPendingChanges()
                           throws javax.jcr.RepositoryException

Specified by:

hasPendingChanges in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

getValueFactory

default 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

hasPermission

default boolean hasPermission(String absPath,
                              String actions)
                       throws javax.jcr.RepositoryException

Specified by:

hasPermission in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

checkPermission

default void checkPermission(String absPath,
                             String actions)
                      throws AccessControlException,
                             javax.jcr.RepositoryException

Specified by:

checkPermission in interface javax.jcr.Session

Throws:

AccessControlException

javax.jcr.RepositoryException

hasCapability

default boolean hasCapability(String methodName,
                              Object target,
                              Object[] arguments)
                       throws javax.jcr.RepositoryException

Specified by:

hasCapability in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

getImportContentHandler

default ContentHandler getImportContentHandler(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

importXML

default void importXML(String parentAbsPath,
                       InputStream in,
                       int uuidBehavior)
                throws IOException,
                       javax.jcr.PathNotFoundException,
                       javax.jcr.ItemExistsException,
                       javax.jcr.nodetype.ConstraintViolationException,
                       javax.jcr.version.VersionException,
                       javax.jcr.InvalidSerializedDataException,
                       javax.jcr.lock.LockException,
                       javax.jcr.RepositoryException

Specified by:

importXML in interface javax.jcr.Session

Throws:

IOException

javax.jcr.PathNotFoundException

javax.jcr.ItemExistsException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.version.VersionException

javax.jcr.InvalidSerializedDataException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

exportSystemView

default void exportSystemView(String absPath,
                              ContentHandler contentHandler,
                              boolean skipBinary,
                              boolean noRecurse)
                       throws javax.jcr.PathNotFoundException,
                              SAXException,
                              javax.jcr.RepositoryException

Specified by:

exportSystemView in interface javax.jcr.Session

Throws:

javax.jcr.PathNotFoundException

SAXException

javax.jcr.RepositoryException

exportSystemView

default void exportSystemView(String absPath,
                              OutputStream out,
                              boolean skipBinary,
                              boolean noRecurse)
                       throws IOException,
                              javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Specified by:

exportSystemView in interface javax.jcr.Session

Throws:

IOException

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

exportDocumentView

default void exportDocumentView(String absPath,
                                ContentHandler contentHandler,
                                boolean skipBinary,
                                boolean noRecurse)
                         throws javax.jcr.PathNotFoundException,
                                SAXException,
                                javax.jcr.RepositoryException

Specified by:

exportDocumentView in interface javax.jcr.Session

Throws:

javax.jcr.PathNotFoundException

SAXException

javax.jcr.RepositoryException

exportDocumentView

default void exportDocumentView(String absPath,
                                OutputStream out,
                                boolean skipBinary,
                                boolean noRecurse)
                         throws IOException,
                                javax.jcr.PathNotFoundException,
                                javax.jcr.RepositoryException

Specified by:

exportDocumentView in interface javax.jcr.Session

Throws:

IOException

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

setNamespacePrefix

default void setNamespacePrefix(String prefix,
                                String uri)
                         throws javax.jcr.NamespaceException,
                                javax.jcr.RepositoryException

Specified by:

setNamespacePrefix in interface javax.jcr.Session

Throws:

javax.jcr.NamespaceException

javax.jcr.RepositoryException

getNamespacePrefixes

default String[] getNamespacePrefixes()
                               throws javax.jcr.RepositoryException

Specified by:

getNamespacePrefixes in interface javax.jcr.Session

Throws:

javax.jcr.RepositoryException

getNamespaceURI

default String getNamespaceURI(String prefix)
                        throws javax.jcr.NamespaceException,
                               javax.jcr.RepositoryException

Specified by:

getNamespaceURI in interface javax.jcr.Session

Throws:

javax.jcr.NamespaceException

javax.jcr.RepositoryException

getNamespacePrefix

default String getNamespacePrefix(String uri)
                           throws javax.jcr.NamespaceException,
                                  javax.jcr.RepositoryException

Specified by:

getNamespacePrefix in interface javax.jcr.Session

Throws:

javax.jcr.NamespaceException

javax.jcr.RepositoryException

logout

default void logout()

Specified by:

logout in interface javax.jcr.Session

isLive

default boolean isLive()

Specified by:

isLive in interface javax.jcr.Session

addLockToken

default void addLockToken(String lt)

Specified by:

addLockToken in interface javax.jcr.Session

getLockTokens

default String[] getLockTokens()

Specified by:

getLockTokens in interface javax.jcr.Session

removeLockToken

default void removeLockToken(String lt)

Specified by:

removeLockToken in interface javax.jcr.Session

getAccessControlManager

default javax.jcr.security.AccessControlManager getAccessControlManager()
                                                                 throws javax.jcr.UnsupportedRepositoryOperationException,
                                                                        javax.jcr.RepositoryException

Specified by:

getAccessControlManager in interface javax.jcr.Session

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

getRetentionManager

default javax.jcr.retention.RetentionManager getRetentionManager()
                                                          throws javax.jcr.UnsupportedRepositoryOperationException,
                                                                 javax.jcr.RepositoryException

Specified by:

getRetentionManager in interface javax.jcr.Session

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException