public class PrincipalManagerImpl extends Object implements PrincipalManager
DefaultPrincipalProvider
in order to dispatch the respective requests and assemble the required
data. It is bound to a session and therefore obliges the access restrictions
of the respective subject.SEARCH_TYPE_ALL, SEARCH_TYPE_GROUP, SEARCH_TYPE_NOT_GROUP
Constructor and Description |
---|
PrincipalManagerImpl(Session session,
PrincipalProvider[] providers)
Creates a new default principal manager implementation.
|
Modifier and Type | Method and Description |
---|---|
PrincipalIterator |
findPrincipals(String simpleFilter)
Gets the principals matching a simple filter expression applied against
the
principal name . |
PrincipalIterator |
findPrincipals(String simpleFilter,
int searchType)
Gets the principals matching a simple filter expression applied against
the
principal name AND the specified search
type. |
Principal |
getEveryone()
Returns the
Principal which is implicitly applied to
every subject. |
PrincipalIterator |
getGroupMembership(Principal principal)
Returns an iterator over all group principals for which the given
principal is either direct or indirect member of.
|
Principal |
getPrincipal(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
Principal s matching the specified search type. |
boolean |
hasPrincipal(String principalName)
Checks if the principal with the given name is known to this manager
(in respect to the sessions access rights).
|
public PrincipalManagerImpl(Session session, PrincipalProvider[] providers)
session
- the underlying sessionproviders
- the providerspublic boolean hasPrincipal(String principalName)
true
then the following expression evaluates to true
as well: PrincipalManager.getPrincipal(name).getName().equals(name)
hasPrincipal
in interface PrincipalManager
principalName
- the name of the principal to checktrue
if the principal with this name is known
to this manager; false
otherwise.public Principal getPrincipal(String principalName)
PrincipalManager
has been built for.getPrincipal
in interface PrincipalManager
principalName
- the name of the principal to retrievenull
if a
principal with the given name does not exist or is not accessible
for the editing session.public PrincipalIterator findPrincipals(String simpleFilter)
principal name
.
TODO: define the filter expression.findPrincipals
in interface PrincipalManager
PrincipalIterator
over the Principal
s
matching the given filter.public PrincipalIterator findPrincipals(String simpleFilter, int searchType)
principal name
AND the specified search
type.
TODO: define the filter expression.findPrincipals
in interface PrincipalManager
searchType
- Any of the following constants:
PrincipalIterator
over the Principal
s
matching the given filter and search type.public PrincipalIterator getPrincipals(int searchType)
Principal
s matching the specified search type.getPrincipals
in interface PrincipalManager
searchType
- PrincipalIterator
over all the Principal
s
matching the given search type.public PrincipalIterator getGroupMembership(Principal principal)
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.
getGroupMembership
in interface PrincipalManager
principal
- the principal to return it's membership from.public Principal getEveryone()
Principal
which is implicitly applied to
every subject.getEveryone
in interface PrincipalManager
Copyright © 2004–2022 The Apache Software Foundation. All rights reserved.