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(CloseableCoreSession session) Use CloseableCoreSession.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.
protected static NuxeoPrincipal	getPrincipal(String username)
CoreSession	getSession(String sessionId) Gets an existing open session for the given session id.
static CloseableCoreSession	openCoreSession(String repositoryName) Opens a CoreSession for the currently logged-in user.
static CloseableCoreSession	openCoreSession(String repositoryName, NuxeoPrincipal principal) Opens a CoreSession for the given principal.
static CloseableCoreSession	openCoreSession(String repositoryName, String username) MUST ONLY BE USED IN UNIT TESTS to open a CoreSession for the given user.
static CloseableCoreSession	openCoreSessionSystem(String repositoryName) Opens a CoreSession for a system user.
static CloseableCoreSession	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

openCoreSession

public static CloseableCoreSession openCoreSession(String repositoryName)

Opens a CoreSession for the currently logged-in user.

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

Parameters:

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

Returns:

the session

Since:

5.9.3

openCoreSession

public static CloseableCoreSession 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 CloseableCoreSession.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 CloseableCoreSession openCoreSessionSystem(String repositoryName)

Opens a CoreSession for a system user.

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

Parameters:

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

Returns:

the session

Since:

5.9.3

openCoreSessionSystem

public static CloseableCoreSession openCoreSessionSystem(String repositoryName,
                                                         String originatingUsername)

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

The session must be closed using CloseableCoreSession.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 CloseableCoreSession openCoreSession(String repositoryName,
                                                   NuxeoPrincipal principal)

Opens a CoreSession for the given principal.

The session must be closed using CloseableCoreSession.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(CloseableCoreSession session)

Use CloseableCoreSession.close() instead.

Since:

5.9.3

getPrincipal

protected static NuxeoPrincipal getPrincipal(String username)

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