|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.MemberList
org.opends.server.extensions.DynamicGroupMemberList
public class DynamicGroupMemberList
This class defines a mechanism that may be used to iterate over the members of a dynamic group, optionally using an additional set of criteria to further filter the results.
Constructor Summary | |
---|---|
DynamicGroupMemberList(DN groupDN,
java.util.Set<LDAPURL> memberURLs)
Creates a new dynamic group member list with the provided information. |
|
DynamicGroupMemberList(DN groupDN,
java.util.Set<LDAPURL> memberURLs,
DN baseDN,
SearchScope scope,
SearchFilter filter)
Creates a new dynamic group member list with the provided information. |
Method Summary | |
---|---|
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. |
DN |
getDynamicGroupDN()
Retrieves the DN of the dynamic group with which this dynamic group member list is associated. |
boolean |
hasMoreMembers()
Indicates whether the group contains any more members. |
Entry |
nextMemberEntry()
Retrieves the entry for the next group member. |
Methods inherited from class org.opends.server.types.MemberList |
---|
nextMemberDN |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DynamicGroupMemberList(DN groupDN, java.util.Set<LDAPURL> memberURLs) throws DirectoryException
groupDN
- The DN of the entry containing the group definition.memberURLs
- The set of LDAP URLs that define the membership
criteria for the associated group.
DirectoryException
- If a problem occurs while creating the member
list.public DynamicGroupMemberList(DN groupDN, java.util.Set<LDAPURL> memberURLs, DN baseDN, SearchScope scope, SearchFilter filter) throws DirectoryException
groupDN
- The DN of the entry containing the group definition.memberURLs
- The set of LDAP URLs that define the membership
criteria for the associated group.baseDN
- The base DN that should be enforced for all entries to
return.scope
- The scope that should be enforced for all entries to
return.filter
- The filter that should be enforced for all entries to
return.
DirectoryException
- If a problem occurs while creating the member
list.Method Detail |
---|
public final DN getDynamicGroupDN()
public boolean hasMoreMembers()
hasMoreMembers
in class MemberList
true
if the group has at least one more member,
or false
if not.public Entry nextMemberEntry() throws MembershipException
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()
hasMoreMembers
returns false
.
close
in class MemberList
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |