org.apache.jackrabbit.oak.jcr.session

Class SessionContext

java.lang.Object

org.apache.jackrabbit.oak.jcr.session.SessionContext

All Implemented Interfaces:

NameMapper, NamePathMapper, PathMapper

public class SessionContext
extends Object
implements NamePathMapper

Instances of this class are passed to all JCR implementation classes (e.g. SessionImpl, NodeImpl, etc.) and provide access to the session scoped instances generally needed (e.g. NamePathMapper, ValueFactory, etc.).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.namepath.NamePathMapper

NamePathMapper.Default

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.namepath.NamePathMapper

DEFAULT

Constructor Summary

Constructors

Constructor and Description
SessionContext(Repository repository, StatisticManager statisticManager, SecurityProvider securityProvider, Whiteboard whiteboard, Map<String,Object> attributes, SessionDelegate delegate, int observationQueueLength, CommitRateLimiter commitRateLimiter)
SessionContext(Repository repository, StatisticManager statisticManager, SecurityProvider securityProvider, Whiteboard whiteboard, Map<String,Object> attributes, SessionDelegate delegate, int observationQueueLength, CommitRateLimiter commitRateLimiter, MountInfoProvider mountInfoProvider, boolean fastQueryResultSize)

Method Summary

Modifier and Type	Method and Description
protected SessionImpl	createSession() Factory method for creating the Session instance for this context.
protected WorkspaceImpl	createWorkspace() Factory method for creating the Workspace instance for this context.
AccessControlManager	getAccessControlManager()
AccessManager	getAccessManager()
Map<String,Object>	getAttributes()
CounterStats	getCount(RepositoryStatistics.Type type)
boolean	getFastQueryResultSize()
String	getJcrName(String oakName) Returns the JCR name for the given Oak name.
String	getJcrPath(String oakPath) Returns the JCR path for the given Oak path.
MeterStats	getMeter(RepositoryStatistics.Type type)
MountInfoProvider	getMountInfoProvider()
String	getOakName(String jcrName) Returns the Oak name for the specified JCR name.
String	getOakNameOrNull(String jcrName) Returns the Oak name for the given JCR name, or null if no such mapping exists because the given JCR name contains an unknown namespace URI or prefix, or is otherwise invalid.
String	getOakPath(String jcrPath) Returns the Oak path for the given JCR path, or null if no such mapping exists because the given JCR path contains a name element with an unknown namespace URI or prefix, or is otherwise invalid.
String	getOakPathOrThrow(String jcrPath) Returns the Oak path for the given JCR path, or throws a RepositoryException if the path can not be mapped.
String	getOakPathOrThrowNotFound(String jcrPath) Returns the Oak path for the given JCR path, or throws a PathNotFoundException if the path can not be mapped.
ObservationManager	getObservationManager()
Set<String>	getOpenScopedLocks()
PrincipalManager	getPrincipalManager()
PrivilegeManager	getPrivilegeManager()
List<ProtectedItemImporter>	getProtectedItemImporters()
Repository	getRepository()
SecurityProvider	getSecurityProvider()
SessionImpl	getSession()
SessionDelegate	getSessionDelegate()
Map<String,String>	getSessionLocalMappings() Returns the local namespace prefix mappings, or an empty map if there aren't any local mappings.
Set<String>	getSessionScopedLocks()
StatisticManager	getStatisticManager()
TimerStats	getTimer(RepositoryStatistics.Type type)
UserManager	getUserManager()
ValueFactory	getValueFactory()
WorkspaceImpl	getWorkspace()
boolean	hasEventListeners()

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionContext

public SessionContext(@Nonnull
                      Repository repository,
                      @Nonnull
                      StatisticManager statisticManager,
                      @Nonnull
                      SecurityProvider securityProvider,
                      @Nonnull
                      Whiteboard whiteboard,
                      @Nonnull
                      Map<String,Object> attributes,
                      @Nonnull
                      SessionDelegate delegate,
                      int observationQueueLength,
                      CommitRateLimiter commitRateLimiter)

SessionContext

public SessionContext(@Nonnull
                      Repository repository,
                      @Nonnull
                      StatisticManager statisticManager,
                      @Nonnull
                      SecurityProvider securityProvider,
                      @Nonnull
                      Whiteboard whiteboard,
                      @Nonnull
                      Map<String,Object> attributes,
                      @Nonnull
                      SessionDelegate delegate,
                      int observationQueueLength,
                      CommitRateLimiter commitRateLimiter,
                      MountInfoProvider mountInfoProvider,
                      boolean fastQueryResultSize)

Method Detail

getAttributes

public final Map<String,Object> getAttributes()

getSession

public final SessionImpl getSession()

getWorkspace

public final WorkspaceImpl getWorkspace()

createSession

protected SessionImpl createSession()

Factory method for creating the Session instance for this context. Called by getSession() when first accessed. Can be overridden by subclasses to customize the session implementation.

Returns:

session instance

createWorkspace

protected WorkspaceImpl createWorkspace()

Factory method for creating the Workspace instance for this context. Called by getWorkspace() when first accessed. Can be overridden by subclasses to customize the workspace implementation.

Returns:

session instance

getStatisticManager

@Nonnull
public StatisticManager getStatisticManager()

getMeter

@Nonnull
public MeterStats getMeter(RepositoryStatistics.Type type)

getTimer

@Nonnull
public TimerStats getTimer(RepositoryStatistics.Type type)

getCount

@Nonnull
public CounterStats getCount(RepositoryStatistics.Type type)

getRepository

@Nonnull
public Repository getRepository()

getSessionDelegate

@Nonnull
public SessionDelegate getSessionDelegate()

getSessionLocalMappings

@Nonnull
public Map<String,String> getSessionLocalMappings()

Description copied from interface: NameMapper

Returns the local namespace prefix mappings, or an empty map if there aren't any local mappings.

Specified by:

getSessionLocalMappings in interface NameMapper

Returns:

local namespace prefix to URI mappings

getValueFactory

public ValueFactory getValueFactory()

getAccessControlManager

@Nonnull
public AccessControlManager getAccessControlManager()
                                                       throws RepositoryException

Throws:

RepositoryException

getPrincipalManager

@Nonnull
public PrincipalManager getPrincipalManager()

getUserManager

@Nonnull
public UserManager getUserManager()

getPrivilegeManager

@Nonnull
public PrivilegeManager getPrivilegeManager()

getProtectedItemImporters

@Nonnull
public List<ProtectedItemImporter> getProtectedItemImporters()

getObservationManager

@Nonnull
public ObservationManager getObservationManager()
                                                   throws UnsupportedRepositoryOperationException

Throws:

UnsupportedRepositoryOperationException

hasEventListeners

public boolean hasEventListeners()

getOpenScopedLocks

public Set<String> getOpenScopedLocks()

getSessionScopedLocks

public Set<String> getSessionScopedLocks()

getFastQueryResultSize

public boolean getFastQueryResultSize()

getMountInfoProvider

@Nullable
public MountInfoProvider getMountInfoProvider()

getOakName

@Nonnull
public String getOakName(@Nonnull
                                   String jcrName)
                            throws RepositoryException

Description copied from interface: NameMapper

Returns the Oak name for the specified JCR name. In contrast to NameMapper.getOakNameOrNull(String) this method will throw a RepositoryException if the JCR name is invalid and cannot be resolved.

Specified by:

getOakName in interface NameMapper

Parameters:

jcrName - The JCR name to be converted.

Returns:

A valid Oak name.

Throws:

RepositoryException - If the JCR name cannot be resolved.

getOakNameOrNull

@CheckForNull
public String getOakNameOrNull(@Nonnull
                                              String jcrName)

Description copied from interface: NameMapper

Returns the Oak name for the given JCR name, or null if no such mapping exists because the given JCR name contains an unknown namespace URI or prefix, or is otherwise invalid.

Specified by:

getOakNameOrNull in interface NameMapper

Parameters:

jcrName - JCR name

Returns:

Oak name, or null

getJcrName

@Nonnull
public String getJcrName(@Nonnull
                                   String oakName)

Description copied from interface: NameMapper

Returns the JCR name for the given Oak name. The given name is expected to have come from a valid Oak repository that contains only valid names with proper namespace mappings. If that's not the case, either a programming error or a repository corruption has occurred and an appropriate unchecked exception gets thrown.

Specified by:

getJcrName in interface NameMapper

Parameters:

oakName - Oak name

Returns:

JCR name

getOakPath

@CheckForNull
public String getOakPath(String jcrPath)

Description copied from interface: PathMapper

Returns the Oak path for the given JCR path, or null if no such mapping exists because the given JCR path contains a name element with an unknown namespace URI or prefix, or is otherwise invalid.

Specified by:

getOakPath in interface PathMapper

Parameters:

jcrPath - JCR path

Returns:

Oak path, or null

getJcrPath

@Nonnull
public String getJcrPath(String oakPath)

Description copied from interface: PathMapper

Returns the JCR path for the given Oak path. The given path is expected to have come from a valid Oak repository that contains only valid paths whose name elements only use proper namespace mappings. If that's not the case, either a programming error or a repository corruption has occurred and an appropriate unchecked exception gets thrown.

Specified by:

getJcrPath in interface PathMapper

Parameters:

oakPath - Oak path

Returns:

JCR path

getOakPathOrThrow

@Nonnull
public String getOakPathOrThrow(String jcrPath)
                                   throws RepositoryException

Returns the Oak path for the given JCR path, or throws a RepositoryException if the path can not be mapped.

Parameters:

jcrPath - JCR path

Returns:

Oak path

Throws:

RepositoryException - if the path can not be mapped

getOakPathOrThrowNotFound

@Nonnull
public String getOakPathOrThrowNotFound(String jcrPath)
                                           throws PathNotFoundException

Returns the Oak path for the given JCR path, or throws a PathNotFoundException if the path can not be mapped.

Parameters:

jcrPath - JCR path

Returns:

Oak path

Throws:

PathNotFoundException - if the path can not be mapped

getAccessManager

@Nonnull
public AccessManager getAccessManager()
                                         throws RepositoryException

Throws:

RepositoryException

getSecurityProvider

@Nonnull
public SecurityProvider getSecurityProvider()