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.

Method Summary

Modifier and Type	Method and Description
static void	closeCoreSession(CoreSession session) Use CoreSession.close() instead.
static void	doPrivileged(CoreSession session, Consumer<CoreSession> consumer) Runs the given Consumer with a system CoreSession while logged in as a system user.
static <R> R	doPrivileged(CoreSession session, Function<CoreSession,R> function) Runs the given Function with a system CoreSession while logged in as a system user.
static void	doPrivileged(String repositoryName, Consumer<CoreSession> consumer) Runs the given Consumer with a system CoreSession while logged in as a system user.
static <R> R	doPrivileged(String repositoryName, Function<CoreSession,R> function) Runs the given Function with a system CoreSession while logged in as a system user.
protected static String	getCurrentPrincipalName() Gets the name of the currently logged-in principal.
static CoreInstance	getInstance() Deprecated. since 8.4, use CoreSessionService directly.
int	getNumberOfSessions() Deprecated. since 8.4, use CoreSessionService.getNumberOfOpenCoreSessions() directly
protected static NuxeoPrincipal	getPrincipal(Map<String,Serializable> map)
protected static NuxeoPrincipal	getPrincipal(String username)
Collection<CoreSessionService.CoreSessionRegistrationInfo>	getRegistrationInfos() Deprecated. since 8.4, use CoreSessionService.getCoreSessionRegistrationInfos() directly
CoreSession	getSession(String sessionId) Gets an existing open session for the given session id.
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) MUST ONLY BE USED IN UNIT TESTS to open a CoreSession for the given principal.
static CoreSession	openCoreSession(String repositoryName, Principal principal) MUST ONLY BE USED IN UNIT TESTS to open a CoreSession for the given principal.
static CoreSession	openCoreSession(String repositoryName, String username) MUST ONLY BE USED IN UNIT TESTS to open a CoreSession for the given user.
static CoreSession	openCoreSessionSystem(String repositoryName) Opens a CoreSession for a system user.
static CoreSession	openCoreSessionSystem(String repositoryName, String originatingUsername) Opens a CoreSession for a system user with an optional originating username.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CoreInstance getInstance()

Deprecated. since 8.4, use CoreSessionService directly.

Gets the CoreInstance singleton.

openCoreSession

public static CoreSession openCoreSession(String repositoryName)

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

Since:

5.9.3

openCoreSession

public static CoreSession openCoreSession(String repositoryName,
                                          String username)

MUST ONLY BE USED IN UNIT TESTS to open 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

Since:

5.9.3

openCoreSessionSystem

public static CoreSession openCoreSessionSystem(String repositoryName)

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

Since:

5.9.3

openCoreSessionSystem

public static CoreSession openCoreSessionSystem(String repositoryName,
                                                String originatingUsername)

Opens a CoreSession for a system user with an optional originating username.

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

Parameters:

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

originatingUsername - the originating username to set on the SystemPrincipal

Returns:

the session

Since:

8.1

openCoreSession

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

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

openCoreSession

public static CoreSession openCoreSession(String repositoryName,
                                          Principal principal)

MUST ONLY BE USED IN UNIT TESTS to open 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

Since:

5.9.3

openCoreSession

public static CoreSession openCoreSession(String repositoryName,
                                          NuxeoPrincipal principal)

MUST ONLY BE USED IN UNIT TESTS to open 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

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

getPrincipal

protected static NuxeoPrincipal getPrincipal(Map<String,Serializable> map)

getPrincipal

protected static NuxeoPrincipal getPrincipal(String username)

getNumberOfSessions

@Deprecated
public int getNumberOfSessions()

Deprecated. since 8.4, use CoreSessionService.getNumberOfOpenCoreSessions() directly

Gets the number of open sessions.

Since:

5.4.2

getRegistrationInfos

@Deprecated
public Collection<CoreSessionService.CoreSessionRegistrationInfo> getRegistrationInfos()

Deprecated. since 8.4, use CoreSessionService.getCoreSessionRegistrationInfos() directly

Gets the number of open sessions.

Since:

5.4.2

getCurrentPrincipalName

protected static String getCurrentPrincipalName()

Gets the name of the currently logged-in principal.

Returns:

the principal name, or null if there was no login

Since:

8.4

doPrivileged

public static <R> R doPrivileged(String repositoryName,
                                 Function<CoreSession,R> function)

Runs the given Function with a system CoreSession while logged in as a system user.

Type Parameters:

R - the function return type

Parameters:

repositoryName - the repository name for the CoreSession

function - the function taking a system CoreSession and returning a result of type <R>

Returns:

the result of the function

Since:

8.4

doPrivileged

public static <R> R doPrivileged(CoreSession session,
                                 Function<CoreSession,R> function)

Runs the given Function with a system CoreSession while logged in as a system user.

Type Parameters:

R - the function return type

Parameters:

session - an existing session

function - the function taking a system CoreSession and returning a result of type <R>

Returns:

the result of the function

Since:

8.4

doPrivileged

public static void doPrivileged(String repositoryName,
                                Consumer<CoreSession> consumer)

Runs the given Consumer with a system CoreSession while logged in as a system user.

Parameters:

repositoryName - the repository name for the CoreSession

consumer - the consumer taking a system CoreSession

Since:

8.4

doPrivileged

public static void doPrivileged(CoreSession session,
                                Consumer<CoreSession> consumer)

Runs the given Consumer with a system CoreSession while logged in as a system user.

Parameters:

session - an existing session

consumer - the consumer taking a system CoreSession

Since:

8.4