senselogic.sitevision.api.security

Interface PrincipalUtil

@Requireable(value="PrincipalUtil")
public interface PrincipalUtil

Principal utility interface.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getPrincipalUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6.1_06

Author:

Mikael Wikblom

Method Summary

Modifier and Type	Method and Description
void	doAsDuringLogin(Node aUser, PrivilegedExceptionAction aAction) Perform work during the login phase as a specified user.
Node	getVirtualGroupByName(String aName) Provides access to a virtual group wrapped as a JCR node given the group name.
List<Node>	getVirtualGroupsByName(List<String> aNames) Provides access to virtual groups wrapped as a JCR node given the group name.

Method Detail

doAsDuringLogin

void doAsDuringLogin(Node aUser,
                     PrivilegedExceptionAction aAction)
              throws IllegalStateException

Perform work during the login phase as a specified user.

Note! This method should only be used during the login phase (i.e. in a JAAS login module). Other usages will throw an IllegalStateException.

Parameters:

aUser - the user

aAction - a runnable containing the operations that is to be performed

Throws:

IllegalStateException - if this method is not called during the login phase

getVirtualGroupByName

Node getVirtualGroupByName(String aName)

Provides access to a virtual group wrapped as a JCR node given the group name.

Parameters:

aName - the name of the virtual group, may not be null

Returns:

the virtual group wrapped in a JCR node, or null if none exists

Since:

Sitevision 3.0

getVirtualGroupsByName

List<Node> getVirtualGroupsByName(List<String> aNames)

Provides access to virtual groups wrapped as a JCR node given the group name.

Parameters:

aNames - a list of names, may not be null

Returns:

a list of virtual groups wrapped in JCR nodes, or an empty list of none exists

Since:

Sitevision 3.0