Package org.apache.jackrabbit.spi.commons.logging

Class SessionInfoLogger

java.lang.Object

org.apache.jackrabbit.spi.commons.logging.AbstractLogger

org.apache.jackrabbit.spi.commons.logging.SessionInfoLogger

All Implemented Interfaces:

SessionInfo

public class SessionInfoLogger
extends AbstractLogger
implements SessionInfo

Log wrapper for a SessionInfo.

Constructor Summary

Constructors

Constructor	Description
SessionInfoLogger(SessionInfo sessionInfo, LogWriter writer)	Create a new instance for the given sessionInfo which uses writer for persisting log messages.

Method Summary

Modifier and Type	Method	Description
void	addLockToken(java.lang.String lockToken)	Add the given lock token to this SessionInfo.
java.lang.String[]	getLockTokens()	Returns the lock tokens present on this SessionInfo.
SessionInfo	getSessionInfo()
java.lang.String	getUserID()	Returns the user id.
java.lang.String	getWorkspaceName()	Returns the workspace name.
void	removeLockToken(java.lang.String lockToken)	Removes the given lock token from this SessionInfo.
void	setUserData(java.lang.String userData)	Sets the user data used for Event.getUserData().

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionInfoLogger

public SessionInfoLogger(SessionInfo sessionInfo,
                         LogWriter writer)

Create a new instance for the given sessionInfo which uses writer for persisting log messages.

Parameters:

sessionInfo -

writer -

Method Detail

getSessionInfo

public SessionInfo getSessionInfo()

Returns:

the wrapped SessionInfo

getUserID

public java.lang.String getUserID()

Description copied from interface: SessionInfo

Returns the user id.

Specified by:

getUserID in interface SessionInfo

Returns:

The user identification.

See Also:

RepositoryService.obtain(javax.jcr.Credentials, String)

getWorkspaceName

public java.lang.String getWorkspaceName()

Description copied from interface: SessionInfo

Returns the workspace name.

Specified by:

getWorkspaceName in interface SessionInfo

Returns:

The name of the workspace this SessionInfo has been built for.

See Also:

RepositoryService.obtain(javax.jcr.Credentials, String), Workspace.getName()

getLockTokens

public java.lang.String[] getLockTokens()
                                 throws javax.jcr.RepositoryException

Description copied from interface: SessionInfo

Returns the lock tokens present on this SessionInfo.

Specified by:

getLockTokens in interface SessionInfo

Returns:

lock tokens present on this SessionInfo.

Throws:

javax.jcr.UnsupportedRepositoryOperationException - If locking is not supported.

javax.jcr.RepositoryException - If another error occurs.

addLockToken

public void addLockToken(java.lang.String lockToken)
                  throws javax.jcr.RepositoryException

Description copied from interface: SessionInfo

Add the given lock token to this SessionInfo. The token will enable the SessionInfo to operate on Items that are affected by the lock identified by the given token.

Specified by:

addLockToken in interface SessionInfo

Parameters:

lockToken - to be added.

Throws:

javax.jcr.UnsupportedRepositoryOperationException - If locking is not supported.

javax.jcr.lock.LockException - If the token cannot be added.

javax.jcr.RepositoryException - If another error occurs.

removeLockToken

public void removeLockToken(java.lang.String lockToken)
                     throws javax.jcr.RepositoryException

Description copied from interface: SessionInfo

Removes the given lock token from this SessionInfo. This must happen if the associated Session successfully removes the Lock from a Node or if the token is removed from the Session itself by calling Session.removeLockToken(String). Consequently all RepositoryService operations affected by a lock will fail with LockException provided the lock hasn't been released.

Specified by:

removeLockToken in interface SessionInfo

Parameters:

lockToken - to be removed.

Throws:

javax.jcr.UnsupportedRepositoryOperationException - If locking is not supported.

javax.jcr.lock.LockException - If the token cannot be removed.

javax.jcr.RepositoryException - If another error occurs.

setUserData

public void setUserData(java.lang.String userData)
                 throws javax.jcr.RepositoryException

Description copied from interface: SessionInfo

Sets the user data used for Event.getUserData().

Specified by:

setUserData in interface SessionInfo

Throws:

javax.jcr.RepositoryException

See Also:

ObservationManager.setUserData(String)