|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SessionInfo
SessionInfo
is created upon
RepositoryService.obtain(javax.jcr.Credentials, String)
or
RepositoryService.obtain(SessionInfo, String)
and will be used for
any call on the RepositoryService that requires user and workspace
identification.
Method Summary | |
---|---|
void |
addLockToken(String lockToken)
Add the given lock token to this SessionInfo . |
String[] |
getLockTokens()
Returns the lock tokens present on this SessionInfo . |
String |
getUserID()
Returns the user id. |
String |
getWorkspaceName()
Returns the workspace name. |
void |
removeLockToken(String lockToken)
Removes the given lock token from this SessionInfo . |
void |
setUserData(String userData)
Sets the user data used for Event.getUserData() . |
Method Detail |
---|
String getUserID()
RepositoryService.obtain(javax.jcr.Credentials, String)
String getWorkspaceName()
workspace
this
SessionInfo has been built for.RepositoryService.obtain(javax.jcr.Credentials, String)
,
Workspace.getName()
String[] getLockTokens() throws UnsupportedRepositoryOperationException, RepositoryException
SessionInfo
.
SessionInfo
.
UnsupportedRepositoryOperationException
- If locking is not supported.
RepositoryException
- If another error occurs.void addLockToken(String lockToken) throws UnsupportedRepositoryOperationException, LockException, RepositoryException
SessionInfo
. The token will
enable the SessionInfo to operate on Items that are affected by the
lock identified by the given token.
lockToken
- to be added.lockToken
-
UnsupportedRepositoryOperationException
- If locking is not supported.
LockException
- If the token cannot be added.
RepositoryException
- If another error occurs.void removeLockToken(String lockToken) throws UnsupportedRepositoryOperationException, LockException, RepositoryException
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.
lockToken
- to be removed.
UnsupportedRepositoryOperationException
- If locking is not supported.
LockException
- If the token cannot be removed.
RepositoryException
- If another error occurs.void setUserData(String userData) throws RepositoryException
Event.getUserData()
.
userData
-
RepositoryException
ObservationManager.setUserData(String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |