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, CoreSession

public class LocalSession
extends AbstractSession
implements Synchronization

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

See Also:

Serialized Form

Field Summary

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

ANONYMOUS, BINARY_TEXT_SYS_PROP, DEFAULT_MAX_RESULTS, LIMIT_RESULTS_PROPERTY, MAX_RESULTS_PROPERTY

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

ALLOW_VERSION_WRITE, IMPORT_BASE_VERSION_ID, IMPORT_CHECKED_IN, IMPORT_IS_VERSION, IMPORT_LIFECYCLE_POLICY, IMPORT_LIFECYCLE_STATE, IMPORT_LOCK, 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

Constructor Summary

Constructors

Constructor and Description
LocalSession()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterCompletion(int status)
void	beforeCompletion()
void	close() Closes this session.
void	connect(String repositoryName, NuxeoPrincipal principal) NOT PUBLIC, DO NOT CALL.
static CoreSession	createInstance()
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.

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

adaptFirstMatchingDocumentWithFacet, applyDefaultPermissions, cancel, canRemoveDocument, checkIn, checkIn, checkOut, copy, copy, copy, copy, copyProxyAsDocument, copyProxyAsDocument, copyProxyAsDocument, copyProxyAsDocument, createDocument, createDocument, createDocumentModel, createDocumentModel, createDocumentModel, createProxy, exists, followTransition, followTransition, getACP, getAllowedStateTransitions, getAvailableSecurityPermissions, getBaseVersion, getBinaryFulltext, 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, getLastVersion, getLifeCyclePolicy, getLock, getLockInfo, getParentDocument, getParentDocumentRef, getParentDocumentRefs, getParentDocuments, getPermissionsToCheck, getProxies, getProxyVersions, getRootDocument, getSourceDocument, getSuperParentType, getSuperSpace, getVersion, getVersionLabel, getVersions, getVersionSeriesId, getVersionsForDocument, getVersionsRefs, getWorkingCopy, hasChildren, hasPermission, hasPermission, importDocuments, internalCheckOut, isCheckedOut, isDirty, isNegativeAclAllowed, move, move, newEventContext, orderBefore, publishDocument, publishDocument, query, query, query, query, query, query, query, query, queryAndFetch, refreshDocument, reinitLifeCycleState, removeChildren, removeDocument, removeDocuments, removeLock, restoreToVersion, restoreToVersion, restoreToVersion, restoreToVersion, save, saveDocument, saveDocuments, setACP, setDocumentSystemProp, setLock, setLock, unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalSession

public LocalSession()

Method Detail

createInstance

public static CoreSession createInstance()

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

connect

public void connect(String repositoryName,
           NuxeoPrincipal principal)
             throws ClientException

Description copied from interface: CoreSession

NOT PUBLIC, DO NOT CALL.

Connects the CoreSession to a low-level Session.

Specified by:

connect in interface CoreSession

Parameters:

repositoryName - the repository name

principal - the principal

Throws:

ClientException

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

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: CoreSession

Closes this session.

Specified by:

close in interface AutoCloseable

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

destroy

public void destroy()

Description copied from interface: CoreSession

Destroys any system resources held by this instance.

Called when the instance is no more needed.

Specified by:

destroy in interface CoreSession

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