Package lumis.portal.principal

Interface IPrincipalManagerSPI

All Superinterfaces:

IConfigKeyChecker, IPrincipalManager

All Known Implementing Classes:

PrincipalManager

public interface IPrincipalManagerSPI
extends IPrincipalManager

Internal operations over principals.

Since:

11.2.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

Method Summary

Modifier and Type	Method	Description
Principals	getCurrentUserPrincipals()	Returns the current user's principals. This method follows the same rules of getPrincipalPrincipals(SessionConfig, String, boolean, ITransaction).
Principals	getPrincipalPrincipals(SessionConfig sessionConfig, String principalId, boolean useSessionCache, ITransaction transaction)	Returns the principals of the given principal. The return value will be: If the given principal is a user: a set with an entry that is the given user itself and the result of the recursion in this method for each group and segmentation the user is member of.

Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker

keyExists

Methods inherited from interface lumis.portal.principal.IPrincipalManager

add, delete, get, getByShortId, getPortalUserMembers, getPrincipals, isMember, update

Method Detail

getPrincipalPrincipals

Principals getPrincipalPrincipals(SessionConfig sessionConfig,
                                  String principalId,
                                  boolean useSessionCache,
                                  ITransaction transaction)
                           throws PortalException

Returns the principals of the given principal.
The return value will be:

• If the given principal is a user: a set with an entry that is the given user itself and the result of the recursion in this method for each group and segmentation the user is member of. The segmentations will not be calculated if the given principal is the guest user and there is no current monitor user in current thread.
• If the given principal is a user segmentation: a set with the given segmentation and the result of the recursion in this method with each group the given segmentation is member of.
• If the given principal is a group: a set containing the given group and the result of a recursion in this method with each group the given group is member of.

Parameters:

sessionConfig - the user's session.

principalId - the principal identifier.

useSessionCache - indicates whether the session cache should be used.

transaction - the transaction.

Returns:

the principals of the given principal.

Throws:

PortalException

Since:

11.2.0

getCurrentUserPrincipals

Principals getCurrentUserPrincipals()
                             throws PortalException

Returns the current user's principals.
This method follows the same rules of getPrincipalPrincipals(SessionConfig, String, boolean, ITransaction).

Returns:

the current user's principals.

Throws:

PortalException

NullPointerException - if there's no current session config.

TransactionRequiredException - if there's no current transaction.

Since:

14.0.0