public class FilteredStaticGroupMemberList extends MemberList
MemberList
class that
may be used in conjunction when static groups when additional criteria is to
be used to select a subset of the group members.Constructor and Description |
---|
FilteredStaticGroupMemberList(ServerContext serverContext,
org.forgerock.opendj.ldap.Dn groupDN,
Set<org.opends.server.extensions.StaticGroup.CompactDn> memberDNs,
org.forgerock.opendj.ldap.Dn baseDN,
org.forgerock.opendj.ldap.SearchScope scope,
SearchFilter filter)
Creates a new filtered static group member list with the provided
information.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Indicates that this member list is no longer required and that
the server may clean up any resources that may have been used in
the course of processing.
|
boolean |
hasMoreMembers()
Indicates whether the group contains any more members.
|
org.forgerock.opendj.ldap.Dn |
nextMemberDN()
Retrieves the DN of the next group member.
|
Entry |
nextMemberEntry()
Retrieves the entry for the next group member.
|
public FilteredStaticGroupMemberList(ServerContext serverContext, org.forgerock.opendj.ldap.Dn groupDN, Set<org.opends.server.extensions.StaticGroup.CompactDn> memberDNs, org.forgerock.opendj.ldap.Dn baseDN, org.forgerock.opendj.ldap.SearchScope scope, SearchFilter filter)
serverContext
- The server context.groupDN
- The DN of the static group with which this member list
is associated.memberDNs
- The set of DNs for the users that are members of the
associated static group.baseDN
- The base DN below which all returned members should
exist. If this is null
, then all members will
be considered to match the base and scope criteria.scope
- The search scope to apply against the base DN when
selecting eligible members.filter
- The search filter which all returned members should
match. If this is null
, then all members will
be considered eligible.public boolean hasMoreMembers()
MemberList
hasMoreMembers
in class MemberList
true
if the group has at least one more member,
or false
if not.public org.forgerock.opendj.ldap.Dn nextMemberDN() throws MembershipException
MemberList
nextMemberDN
in class MemberList
null
if
there are no more members.MembershipException
- If a problem occurs while
attempting to retrieve the next
member DN.public Entry nextMemberEntry() throws MembershipException
MemberList
nextMemberEntry
in class MemberList
null
if
there are no more members.MembershipException
- If a problem occurs while
attempting to retrieve the next
entry.public void close()
MemberList
hasMoreMembers
returns false
.close
in interface Closeable
close
in interface AutoCloseable
close
in class MemberList
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.