public interface PrincipalManager
A Principal
is an object used to connect
to any kind of security mechanism. Example for this are the
login modules
that use principals
to process the login procedure.
A principal can be a member of a Group
. A
group is a principal itself and can therefore be a member of a group again.
Please note the following security considerations that need to be respected
when implementing the PrincipalManager: All principals returned by this
manager as well as Group.members()
must respect access restrictions
that may be present for the Session
this manager has been built
for. The same applies for getGroupMembership(Principal)
.
Modifier and Type | Field and Description |
---|---|
static int |
SEARCH_TYPE_ALL
Filter flag indicating that all
Principal s should be search
irrespective whether they represent a group of Principals or not. |
static int |
SEARCH_TYPE_GROUP
Filter flag indicating that only
Principal s that represent
a group of Principals should be searched
and returned. |
static int |
SEARCH_TYPE_NOT_GROUP
Filter flag indicating that only
Principal s that do NOT
represent a group should be searched
and returned. |
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
Principal s 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).
|
static final int SEARCH_TYPE_NOT_GROUP
Principal
s that do NOT
represent a group
should be searched
and returned.static final int SEARCH_TYPE_GROUP
Principal
s that represent
a group
of Principals should be searched
and returned.static final int SEARCH_TYPE_ALL
Principal
s should be search
irrespective whether they represent a group of Principals or not.boolean hasPrincipal(java.lang.String principalName)
true
then the following expression evaluates to true
as well: PrincipalManager.getPrincipal(name).getName().equals(name)
principalName
- the name of the principal to checktrue
if the principal with this name is known
to this manager; false
otherwise.java.security.Principal getPrincipal(java.lang.String principalName)
PrincipalManager
has been built for.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.PrincipalIterator findPrincipals(java.lang.String simpleFilter)
principal name
.
TODO: define the filter expression.simpleFilter
- PrincipalIterator
over the Principal
s
matching the given filter.PrincipalIterator findPrincipals(java.lang.String simpleFilter, int searchType)
principal name
AND the specified search
type.
TODO: define the filter expression.simpleFilter
- searchType
- Any of the following constants:
PrincipalIterator
over the Principal
s
matching the given filter and search type.PrincipalIterator getPrincipals(int searchType)
Principal
s matching the specified search type.searchType
- Any of the following constants:
PrincipalIterator
over all the Principal
s
matching the given search type.PrincipalIterator getGroupMembership(java.security.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.
principal
- the principal to return it's membership from.java.security.Principal getEveryone()
Principal
which is implicitly applied to
every subject."Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"