Package org.opends.server.extensions

Class SimpleStaticGroupMemberList

java.lang.Object

org.opends.server.types.MemberList

org.opends.server.extensions.SimpleStaticGroupMemberList

All Implemented Interfaces:

Closeable, AutoCloseable

public class SimpleStaticGroupMemberList
extends MemberList

This class provides an implementation of the MemberList class that may be used in conjunction when static groups when no additional criteria is to be used to select a subset of the group members.

Constructor Summary

Constructors

Constructor	Description
SimpleStaticGroupMemberList(ServerContext serverContext, DN groupDN, Set<org.opends.server.extensions.StaticGroup.CompactDn> memberDNs)	Creates a new simple static group member list with the provided set of member DNs.

Method Summary

Modifier and Type	Method	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.
DN	nextMemberDN()	Retrieves the DN of the next group member.
Entry	nextMemberEntry()	Retrieves the entry for the next group member.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleStaticGroupMemberList

public SimpleStaticGroupMemberList(ServerContext serverContext,
                                   DN groupDN,
                                   Set<org.opends.server.extensions.StaticGroup.CompactDn> memberDNs)

Creates a new simple static group member list with the provided set of member DNs.

Parameters:

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.

Method Detail

hasMoreMembers

public boolean hasMoreMembers()

Description copied from class: MemberList

Indicates whether the group contains any more members.

Specified by:

hasMoreMembers in class MemberList

Returns:

true if the group has at least one more member, or false if not.

nextMemberDN

public DN nextMemberDN()
                throws MembershipException

Description copied from class: MemberList

Retrieves the DN of the next group member.

Overrides:

nextMemberDN in class MemberList

Returns:

The DN of the next group member, or null if there are no more members.

Throws:

MembershipException - If a problem occurs while attempting to retrieve the next member DN.

nextMemberEntry

public Entry nextMemberEntry()
                      throws MembershipException

Description copied from class: MemberList

Retrieves the entry for the next group member.

Specified by:

nextMemberEntry in class MemberList

Returns:

The entry for the next group member, or null if there are no more members.

Throws:

MembershipException - If a problem occurs while attempting to retrieve the next entry.

close

public void close()

Description copied from class: MemberList

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. This method must be called if the caller wishes to stop iterating across the member list before the end has been reached, although it will not be necessary if the call to hasMoreMembers returns false.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class MemberList