@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface Group
Modifier and Type | Method and Description |
---|---|
boolean |
canRetrieveMemberListEfficiently()
Indicates whether the
getMemberIterator(String,SearchScope,Filter,boolean) method can be
used to efficiently obtain information about all members of this group. |
DN |
getDN()
Retrieves the DN of the entry that defines this group.
|
GroupMemberIterator |
getMemberIterator(java.lang.String baseDN,
SearchScope scope,
Filter filter,
boolean includeNestedMembers)
Retrieves an object that may be used to iterate through the members of this
group.
|
boolean |
isMember(Entry userEntry,
boolean directMembershipOnly)
Indicates whether the specified user is a member of this group.
|
boolean |
isMember(java.lang.String userDN,
boolean directMembershipOnly)
Indicates whether the specified user is a member of this group.
|
DN getDN()
boolean isMember(java.lang.String userDN, boolean directMembershipOnly) throws LDAPException
userDN
- The DN for the user for whom to make the
determination. It must not be null
.directMembershipOnly
- Indicates whether to only consider the user a
member of the group if that user is directly
named as a member of the group. If this
parameter is true
, then the method
will return true
only if the user is
directly listed as a member of the group, and
will not included dynamic or nested
membership. If this parameter is
false
, then the method will return
true
if the user is a direct member
of the group, is a member of a dynamic group
in which the user matches the membership
criteria, or if the user is a member of a
nested group.true
if the specified user is a member of this group, or
false
if not.LDAPException
- If a problem is encountered while attempting to
make the determination.boolean isMember(Entry userEntry, boolean directMembershipOnly) throws LDAPException
userEntry
- The entry for the user for whom to make the
determination. It must not be null
.directMembershipOnly
- Indicates whether to only consider the user a
member of the group if that user is directly
named as a member of the group. If this
parameter is true
, then the method
will return true
only if the user is
directly listed as a member of the group, and
will not included dynamic or nested
membership. If this parameter is
false
, then the method will return
true
if the user is a direct member
of the group, is a member of a dynamic group
in which the user matches the membership
criteria, or if the user is a member of a
nested group.true
if the specified user is a member of this group, or
false
if not.LDAPException
- If a problem is encountered while attempting to
make the determination.boolean canRetrieveMemberListEfficiently()
getMemberIterator(String,SearchScope,Filter,boolean)
method can be
used to efficiently obtain information about all members of this group.true
if the getMembers
method should be able to
efficiently retrieve a list of all members of this group, or
false
if the call to getMembers
may be
inefficient.GroupMemberIterator getMemberIterator(java.lang.String baseDN, SearchScope scope, Filter filter, boolean includeNestedMembers) throws LDAPException
baseDN
- A base DN that may be used to restrict the
set of members that are made available
through the iterator. If this is
non-null
, then the iterator will only
iterate across entries at or below this base
DN that are also within the specified scope.scope
- A search scope that may be used to restrict
the set of members that are made available
through the iterator. If the base DN is
non-null
, then the scope must also be
non-null
, and the iterator will only
iterate across entries at or below the base
DN and within this scope.filter
- A filter that may be used to restrict the
set of members that are made available
through the iterator. If this is
non-null
, then the iterator will only
iterate across members that match this
filter.includeNestedMembers
- Indicates whether to include members that are
not direct members of this group, but that
are nested members because they are members
of a group that is directly or indirectly a
member of this group.GroupMemberIterator
object that may be used to iterate
across the members of this group.LDAPException
- If a problem is encountered while creating the
requested group member iterator.