org.apache.jackrabbit.oak.spi.security.principal

Class PrincipalManagerImpl

java.lang.Object

org.apache.jackrabbit.oak.spi.security.principal.PrincipalManagerImpl

All Implemented Interfaces:

PrincipalManager

public class PrincipalManagerImpl
extends java.lang.Object
implements PrincipalManager

Default implementation of the PrincipalManager interface.

Field Summary

Fields inherited from interface org.apache.jackrabbit.api.security.principal.PrincipalManager

SEARCH_TYPE_ALL, SEARCH_TYPE_GROUP, SEARCH_TYPE_NOT_GROUP

Constructor Summary

Constructors

Constructor and Description
PrincipalManagerImpl(PrincipalProvider principalProvider)

Method Summary

Modifier and Type	Method and Description
PrincipalIterator	findPrincipals(java.lang.String simpleFilter) Gets the principals matching a simple filter expression applied against the principal name.
PrincipalIterator	findPrincipals(java.lang.String simpleFilter, int searchType) Gets the principals matching a simple filter expression applied against the principal name AND the specified search type.
java.security.Principal	getEveryone() Returns the Principal which is implicitly applied to every subject.
PrincipalIterator	getGroupMembership(java.security.Principal principal) Returns an iterator over all group principals for which the given principal is either direct or indirect member of.
java.security.Principal	getPrincipal(java.lang.String principalName) Returns the principal with the given name if is known to this manager (with respect to the sessions access rights).
PrincipalIterator	getPrincipals(int searchType) Returns all Principals matching the specified search type.
boolean	hasPrincipal(java.lang.String principalName) Checks if the principal with the given name is known to this manager (in respect to the sessions access rights).

Methods inherited from class java.lang.Object

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

Constructor Detail

PrincipalManagerImpl

public PrincipalManagerImpl(PrincipalProvider principalProvider)

Method Detail

hasPrincipal

public boolean hasPrincipal(java.lang.String principalName)

Description copied from interface: PrincipalManager

Checks if the principal with the given name is known to this manager (in respect to the sessions access rights). If this method returns true then the following expression evaluates to true as well: PrincipalManager.getPrincipal(name).getName().equals(name)

Specified by:

hasPrincipal in interface PrincipalManager

Parameters:

principalName - the name of the principal to check

Returns:

return true if the principal with this name is known to this manager; false otherwise.

getPrincipal

public java.security.Principal getPrincipal(java.lang.String principalName)

Description copied from interface: PrincipalManager

Returns the principal with the given name if is known to this manager (with respect to the sessions access rights). Please note that due to security reasons Group principals will only reveal those members that are visible to the Session this PrincipalManager has been built for.

Specified by:

getPrincipal in interface PrincipalManager

Parameters:

principalName - the name of the principal to retrieve

Returns:

return the requested principal or null if a principal with the given name does not exist or is not accessible for the editing session.

findPrincipals

public PrincipalIterator findPrincipals(java.lang.String simpleFilter)

Description copied from interface: PrincipalManager

Gets the principals matching a simple filter expression applied against the principal name. TODO: define the filter expression.
An implementation may limit the number of principals returned. If there are no matching principals, an empty iterator is returned.

Specified by:

findPrincipals in interface PrincipalManager

Returns:

a PrincipalIterator over the Principals matching the given filter.

findPrincipals

public PrincipalIterator findPrincipals(java.lang.String simpleFilter,
                                        int searchType)

Description copied from interface: PrincipalManager

Gets the principals matching a simple filter expression applied against the principal name AND the specified search type. TODO: define the filter expression.
An implementation may limit the number of principals returned. If there are no matching principals, an empty iterator is returned.

Specified by:

findPrincipals in interface PrincipalManager

searchType - Any of the following constants:

• PrincipalManager.SEARCH_TYPE_ALL
• PrincipalManager.SEARCH_TYPE_GROUP
• PrincipalManager.SEARCH_TYPE_NOT_GROUP

Returns:

a PrincipalIterator over the Principals matching the given filter and search type.

getPrincipals

public PrincipalIterator getPrincipals(int searchType)

Description copied from interface: PrincipalManager

Returns all Principals matching the specified search type.

Specified by:

getPrincipals in interface PrincipalManager

Parameters:

searchType - Any of the following constants:

• PrincipalManager.SEARCH_TYPE_ALL
• PrincipalManager.SEARCH_TYPE_GROUP
• PrincipalManager.SEARCH_TYPE_NOT_GROUP

Returns:

a PrincipalIterator over all the Principals matching the given search type.

getGroupMembership

public PrincipalIterator getGroupMembership(java.security.Principal principal)

Description copied from interface: PrincipalManager

Returns an iterator over all group principals for which the given principal is either direct or indirect member of.

Example:
If Principal P is member of Group A, and Group A is member of Group B, this method will return Principal A and Principal B.

Specified by:

getGroupMembership in interface PrincipalManager

Parameters:

principal - the principal to return it's membership from.

Returns:

an iterator returning all groups the given principal is member of.

getEveryone

public java.security.Principal getEveryone()

Description copied from interface: PrincipalManager

Returns the Principal which is implicitly applied to every subject.

Specified by:

getEveryone in interface PrincipalManager

Returns:

the 'everyone' principal