org.nuxeo.ecm.core.api.local

Class LocalSession

java.lang.Object

org.nuxeo.ecm.core.api.AbstractSession

org.nuxeo.ecm.core.api.local.LocalSession

All Implemented Interfaces:

Serializable, AutoCloseable, Synchronization, CloseableCoreSession, CoreSession

public class LocalSession
extends AbstractSession
implements CloseableCoreSession, Synchronization

Local Session: implementation of CoreSession beyond AbstractSession, dealing with low-level stuff.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.api.CoreSession

CoreSession.CopyOption

Field Summary

Fields

Modifier and Type	Field and Description
protected NuxeoPrincipal	principal
protected String	repositoryName

Fields inherited from class org.nuxeo.ecm.core.api.AbstractSession

BINARY_TEXT_SYS_PROP, createDocumentCount, DEFAULT_MAX_RESULTS, deleteDocumentCount, DISABLED_ISLATESTVERSION_PROPERTY, EMPTY_PATH, LIMIT_RESULTS_PROPERTY, MAX_RESULTS_PROPERTY, registry, TRASH_KEEP_CHECKED_IN_PROPERTY, updateDocumentCount

Fields inherited from interface org.nuxeo.ecm.core.api.CoreSession

ALLOW_VERSION_WRITE, CHANGE_TOKEN, IMPORT_BASE_VERSION_ID, IMPORT_CHECKED_IN, IMPORT_IS_RETENTION_ACTIVE, IMPORT_IS_VERSION, IMPORT_LIFECYCLE_POLICY, IMPORT_LIFECYCLE_STATE, IMPORT_LOCK_CREATED, IMPORT_LOCK_OWNER, IMPORT_PROXY_TARGET_ID, IMPORT_PROXY_TYPE, IMPORT_PROXY_VERSIONABLE_ID, IMPORT_VERSION_CREATED, IMPORT_VERSION_DESCRIPTION, IMPORT_VERSION_IS_LATEST, IMPORT_VERSION_IS_LATEST_MAJOR, IMPORT_VERSION_LABEL, IMPORT_VERSION_MAJOR, IMPORT_VERSION_MINOR, IMPORT_VERSION_VERSIONABLE_ID, SKIP_DESTINATION_CHECK_ON_CREATE, SOURCE, USER_CHANGE

Constructor Summary

Constructors

Constructor and Description
LocalSession(String repositoryName, NuxeoPrincipal principal)

Method Summary

Modifier and Type	Method and Description
void	afterCompletion(int status)
void	beforeCompletion()
void	close() Closes this session.
protected void	closeInThisThread()
protected SessionInfo	createSession() Creates the session.
void	destroy() Destroys any system resources held by this instance.
NuxeoPrincipal	getPrincipal() Gets the principal that created the client session.
String	getRepositoryName() Returns the repository name against which this core session is bound.
Session	getSession() Internal method: Gets the current session based on the client session id.
String	getSessionId() Gets the current session id.
boolean	isLive(boolean onThread) Returns true if the session is currently connected to the repository.
boolean	isStateSharedByAllThreadSessions() Returns true if all sessions in the current thread share the same state.
protected static String	newSessionId(String repositoryName, NuxeoPrincipal principal)

Methods inherited from class org.nuxeo.ecm.core.api.AbstractSession

adaptFirstMatchingDocumentWithFacet, applyDefaultPermissions, cancel, canRemoveDocument, canRemoveDocument, checkIn, checkOut, checkPermission, computeCountUpTo, computeKeyForAtomicCreation, copy, copy, copy, copy, copyProxyAsDocument, copyProxyAsDocument, copyProxyAsDocument, copyProxyAsDocument, createDocument, createDocument, createDocumentModel, createDocumentModel, createDocumentModel, createMetrics, createProxy, createProxyInternal, exists, fillCreateOptions, filterGrantedPermissions, followTransition, followTransition, getACP, getAllowedStateTransitions, getAvailableSecurityPermissions, getBaseVersion, getBinaryFulltext, getChangeToken, getChild, getChildren, getChildren, getChildren, getChildren, getChildren, getChildrenIterator, getChildrenIterator, getChildrenIterator, getChildrenRefs, getContextMapEventInfo, getCurrentLifeCycleState, getDataModel, getDataModelField, getDataModelsField, getDataModelsFieldUp, getDocument, getDocuments, getDocumentSystemProp, getDocumentType, getDocumentWithVersion, getFiles, getFiles, getFirstParentDocumentWithFacet, getFolders, getFolders, getLastDocumentVersion, getLastDocumentVersionRef, getLifeCyclePolicy, getLockInfo, getMaxResults, getOrCreateDocument, getOrCreateDocument, getParentDocument, getParentDocumentRef, getParentDocumentRefs, getParentDocuments, getPermissionsToCheck, getPoliciesQueryTransformers, getPrincipalsToCheck, getProxies, getRootDocument, getSecurityService, getSourceDocument, getSuperParentType, getSuperSpace, getValidationService, getVersion, getVersioningService, getVersionLabel, getVersionModel, getVersions, getVersionSeriesId, getVersionsForDocument, getVersionsRefs, getWorkingCopy, hasChild, hasChildren, hasPermission, hasPermission, hasPermission, hasPermission, importDocument, importDocuments, isAdministrator, isCheckedOut, isLimitedResults, isNegativeAclAllowed, isRetentionActive, isTrashed, loadDataModelsForFacet, move, move, newEventContext, notifyCheckedInVersion, notifyEvent, notifyVersionChange, orderBefore, publishDocument, publishDocument, query, query, query, query, query, query, query, query, queryAndFetch, queryAndFetch, queryProjection, queryProjection, queryProjection, readModel, readModel, refreshDocument, reinitLifeCycleState, removeChildren, removeDocument, removeDocument, removeDocuments, removeExistingProxies, removeLock, removeNotifyOneDoc, replaceACE, resolveReference, restoreToVersion, restoreToVersion, restoreToVersion, save, saveDocument, saveDocuments, scroll, scroll, setACP, setACP, setDocumentSystemProp, setLimitedResults, setLock, setMaxResults, setRetentionActive, updateExistingProxies, updateReadACLs, writeModel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.api.CoreSession

adaptFirstMatchingDocumentWithFacet, applyDefaultPermissions, cancel, canRemoveDocument, checkIn, checkOut, copy, copy, copy, copy, copyProxyAsDocument, copyProxyAsDocument, copyProxyAsDocument, copyProxyAsDocument, createDocument, createDocument, createDocumentModel, createDocumentModel, createDocumentModel, createProxy, exists, filterGrantedPermissions, followTransition, followTransition, getACP, getAllowedStateTransitions, getAvailableSecurityPermissions, getBaseVersion, getBinaryFulltext, getChangeToken, getChild, getChildren, getChildren, getChildren, getChildren, getChildren, getChildrenIterator, getChildrenIterator, getChildrenIterator, getChildrenRefs, getCurrentLifeCycleState, getDataModel, getDataModelsField, getDataModelsFieldUp, getDocument, getDocuments, getDocumentSystemProp, getDocumentType, getDocumentWithVersion, getFiles, getFiles, getFolders, getFolders, getLastDocumentVersion, getLastDocumentVersionRef, getLifeCyclePolicy, getLockInfo, getOrCreateDocument, getOrCreateDocument, getParentDocument, getParentDocumentRef, getParentDocumentRefs, getParentDocuments, getPermissionsToCheck, getProxies, getRootDocument, getSourceDocument, getSuperParentType, getSuperSpace, getVersion, getVersionLabel, getVersions, getVersionSeriesId, getVersionsForDocument, getVersionsRefs, getWorkingCopy, hasChild, hasChildren, hasPermission, hasPermission, importDocuments, isCheckedOut, isNegativeAclAllowed, isRetentionActive, isTrashed, move, move, orderBefore, publishDocument, publishDocument, query, query, query, query, query, query, query, query, queryAndFetch, queryAndFetch, queryProjection, queryProjection, queryProjection, refreshDocument, reinitLifeCycleState, removeChildren, removeDocument, removeDocuments, removeLock, replaceACE, restoreToVersion, restoreToVersion, save, saveDocument, saveDocuments, scroll, scroll, setACP, setDocumentSystemProp, setLock, setRetentionActive, updateReadACLs

Field Detail

repositoryName

protected String repositoryName

principal

protected NuxeoPrincipal principal

Constructor Detail

LocalSession

public LocalSession(String repositoryName,
                    NuxeoPrincipal principal)

Method Detail

getRepositoryName

public String getRepositoryName()

Description copied from interface: CoreSession

Returns the repository name against which this core session is bound.

Specified by:

getRepositoryName in interface CoreSession

Returns:

the repository name used currently used as an identifier

newSessionId

protected static String newSessionId(String repositoryName,
                                     NuxeoPrincipal principal)

getSessionId

public String getSessionId()

Description copied from interface: CoreSession

Gets the current session id.

If the client is not connected returns null.

Specified by:

getSessionId in interface CoreSession

Returns:

the session id or null if not connected

getSession

public Session getSession()

Description copied from class: AbstractSession

Internal method: Gets the current session based on the client session id.

Specified by:

getSession in class AbstractSession

Returns:

the repository session

createSession

protected SessionInfo createSession()

Creates the session. It will be destroyed by calling destroy().

isLive

public boolean isLive(boolean onThread)

Description copied from interface: CoreSession

Returns true if the session is currently connected to the repository.

Specified by:

isLive in interface CoreSession

close

public void close()

Description copied from interface: CloseableCoreSession

Closes this session.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableCoreSession

Specified by:

close in interface CoreSession

beforeCompletion

public void beforeCompletion()

Specified by:

beforeCompletion in interface Synchronization

afterCompletion

public void afterCompletion(int status)

Specified by:

afterCompletion in interface Synchronization

closeInThisThread

protected void closeInThisThread()

destroy

public void destroy()

Description copied from interface: CloseableCoreSession

Destroys any system resources held by this instance.

Called when the instance is no more needed.

Specified by:

destroy in interface CloseableCoreSession

getPrincipal

public NuxeoPrincipal getPrincipal()

Description copied from interface: CoreSession

Gets the principal that created the client session.

Specified by:

getPrincipal in interface CoreSession

Returns:

the principal

isStateSharedByAllThreadSessions

public boolean isStateSharedByAllThreadSessions()

Description copied from interface: CoreSession

Returns true if all sessions in the current thread share the same state.

Specified by:

isStateSharedByAllThreadSessions in interface CoreSession