org.nuxeo.ecm.core.api

Class CoreInstance

java.lang.Object

org.nuxeo.ecm.core.api.CoreInstance

public class CoreInstance
extends Object

The CoreInstance is the main access point to a CoreSession.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoreInstance.RegistrationInfo

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanupThisThread()
void	close(CoreSession session) Deprecated. since 5.9.3, use CoreSession.close() instead.
static void	closeCoreSession(CoreSession session) Use CoreSession.close() instead.
static CoreInstance	getInstance() Gets the CoreInstance singleton.
int	getNumberOfSessions() Gets the number of open sessions.
Collection<CoreInstance.RegistrationInfo>	getRegistrationInfos()
Collection<CoreInstance.RegistrationInfo>	getRegistrationInfosLive(boolean onThread)
CoreSession	getSession(String sessionId) Gets an existing open session for the given session id.
CoreSession	open(String repositoryName, Map<String,Serializable> context) Deprecated. since 5.9.3, use openCoreSession(java.lang.String) instead.
static CoreSession	openCoreSession(String repositoryName) Opens a CoreSession for the currently logged-in user.
static CoreSession	openCoreSession(String repositoryName, Map<String,Serializable> context) NOT PUBLIC, DO NOT CALL.
static CoreSession	openCoreSession(String repositoryName, NuxeoPrincipal principal) Opens a CoreSession for the given principal.
static CoreSession	openCoreSession(String repositoryName, Principal principal) Opens a CoreSession for the given principal.
static CoreSession	openCoreSession(String repositoryName, String username) Opens a CoreSession for the given user.
static CoreSession	openCoreSessionSystem(String repositoryName) Opens a CoreSession for a system user.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CoreInstance getInstance()

Gets the CoreInstance singleton.

openCoreSession

public static CoreSession openCoreSession(String repositoryName)
                                   throws ClientException

Opens a CoreSession for the currently logged-in user.

The session must be closed using CoreSession.close().

Parameters:

repositoryName - the repository name, or null for the default repository

Returns:

the session

Throws:

ClientException

Since:

5.9.3

openCoreSession

public static CoreSession openCoreSession(String repositoryName,
                          String username)
                                   throws ClientException

Opens a CoreSession for the given user.

The session must be closed using CoreSession.close().

Parameters:

repositoryName - the repository name, or null for the default repository

username - the user name

Returns:

the session

Throws:

ClientException

Since:

5.9.3

openCoreSessionSystem

public static CoreSession openCoreSessionSystem(String repositoryName)
                                         throws ClientException

Opens a CoreSession for a system user.

The session must be closed using CoreSession.close().

Parameters:

repositoryName - the repository name, or null for the default repository

Returns:

the session

Throws:

ClientException

Since:

5.9.3

open

@Deprecated
public CoreSession open(String repositoryName,
                          Map<String,Serializable> context)
                 throws ClientException

Deprecated. since 5.9.3, use openCoreSession(java.lang.String) instead.

Throws:

ClientException

openCoreSession

public static CoreSession openCoreSession(String repositoryName,
                          Map<String,Serializable> context)
                                   throws ClientException

NOT PUBLIC, DO NOT CALL. Kept public for compatibility with old code.

Opens a CoreSession for the given context.

Parameters:

repositoryName - the repository name, or null for the default repository

context - the session open context

Returns:

the session

Throws:

ClientException

openCoreSession

public static CoreSession openCoreSession(String repositoryName,
                          Principal principal)
                                   throws ClientException

Opens a CoreSession for the given principal.

The session must be closed using CoreSession.close().

Parameters:

repositoryName - the repository name, or null for the default repository

principal - the principal

Returns:

the session

Throws:

ClientException

Since:

5.9.3

openCoreSession

public static CoreSession openCoreSession(String repositoryName,
                          NuxeoPrincipal principal)
                                   throws ClientException

Opens a CoreSession for the given principal.

The session must be closed using CoreSession.close().

Parameters:

repositoryName - the repository name, or null for the default repository

principal - the principal

Returns:

the session

Throws:

ClientException

Since:

5.9.3

getSession

public CoreSession getSession(String sessionId)

Gets an existing open session for the given session id.

The returned CoreSession must not be closed, as it is owned by someone else.

Parameters:

sessionId - the session id

Returns:

the session, which must not be closed

closeCoreSession

public static void closeCoreSession(CoreSession session)

Use CoreSession.close() instead.

Since:

5.9.3

close

@Deprecated
public void close(CoreSession session)

Deprecated. since 5.9.3, use CoreSession.close() instead.

getNumberOfSessions

public int getNumberOfSessions()

Gets the number of open sessions.

Since:

5.4.2

getRegistrationInfos

public Collection<CoreInstance.RegistrationInfo> getRegistrationInfos()

getRegistrationInfosLive

public Collection<CoreInstance.RegistrationInfo> getRegistrationInfosLive(boolean onThread)

cleanupThisThread

public void cleanupThisThread()
                       throws ClientException

Throws:

ClientException