mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Jean-Noël Rouvignac
20.42.2016 61b9eb1be03fc03a9f4bb0013a08ff44a1059503
opendj-server-legacy/src/main/java/org/opends/server/api/Group.java
@@ -16,23 +16,22 @@
 */
package org.opends.server.api;
import org.forgerock.i18n.LocalizableMessage;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.opendj.config.server.ConfigException;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.ldap.SearchScope;
import org.forgerock.opendj.server.config.server.GroupImplementationCfg;
import org.opends.server.core.ServerContext;
import org.forgerock.opendj.config.server.ConfigException;
import org.opends.server.types.DirectoryException;
import org.forgerock.opendj.ldap.DN;
import org.opends.server.types.Entry;
import org.opends.server.types.InitializationException;
import org.opends.server.types.MemberList;
import org.opends.server.types.Modification;
import org.opends.server.types.SearchFilter;
import org.forgerock.opendj.ldap.SearchScope;
/**
 * This class defines the set of methods that must be implemented by a
@@ -82,8 +81,6 @@
  public abstract void initializeGroupImplementation(T configuration)
         throws ConfigException, InitializationException;
  /**
   * Indicates whether the provided configuration is acceptable for
   * this group implementation.  It should be possible to call this
@@ -115,8 +112,6 @@
    return true;
  }
  /**
   * Performs any necessary finalization that may be needed whenever
   * this group implementation is taken out of service within the
@@ -128,8 +123,6 @@
    // No implementation is required by default.
  }
  /**
   * Creates a new group of this type based on the definition
   * contained in the provided entry.  This method must be designed so
@@ -151,8 +144,6 @@
  public abstract Group<T> newInstance(ServerContext serverContext, Entry groupEntry)
         throws DirectoryException;
  /**
   * Retrieves a search filter that may be used to identify entries
   * containing definitions for groups of this type in the Directory
@@ -172,8 +163,6 @@
  public abstract SearchFilter getGroupDefinitionFilter()
         throws DirectoryException;
  /**
   * Indicates whether the provided entry contains a valid definition
   * for this type of group.
@@ -186,8 +175,6 @@
   */
  public abstract boolean isGroupDefinition(Entry entry);
  /**
   * Retrieves the DN of the entry that contains the definition for
   * this group.
@@ -197,8 +184,6 @@
   */
  public abstract DN getGroupDN();
  /**
   * Sets the DN of the entry that contains the definition for
   * this group.
@@ -208,8 +193,6 @@
   */
  public abstract void setGroupDN(DN groupDN);
  /**
   * Indicates whether this group supports nesting other groups, such
   * that the members of the nested groups will also be considered
@@ -220,8 +203,6 @@
   */
  public abstract boolean supportsNestedGroups();
  /**
   * Retrieves a list of the DNs of any nested groups whose members
   * should be considered members of this group.
@@ -231,8 +212,6 @@
   */
  public abstract List<DN> getNestedGroupDNs();
  /**
   * Attempts to add the provided group DN as a nested group within
   * this group.  The change should be committed to persistent storage
@@ -251,8 +230,6 @@
  public abstract void addNestedGroup(DN nestedGroupDN)
         throws UnsupportedOperationException, DirectoryException;
  /**
   * Attempts to remove the provided group as a nested group within
   * this group.  The change should be committed to persistent storage
@@ -271,8 +248,6 @@
  public abstract void removeNestedGroup(DN nestedGroupDN)
         throws UnsupportedOperationException, DirectoryException;
  /**
   * Indicates whether the user with the specified DN is a member of
   * this group.  Note that this is a point-in-time determination and
@@ -292,8 +267,6 @@
    return userDN != null && isMember(userDN, new HashSet<DN>());
  }
  /**
   * Indicates whether the user with the specified DN is a member of
   * this group.  Note that this is a point-in-time determination and
@@ -325,8 +298,6 @@
  public abstract boolean isMember(DN userDN, Set<DN> examinedGroups)
         throws DirectoryException;
  /**
   * Indicates whether the user described by the provided user entry
   * is a member of this group.  Note that this is a point-in-time
@@ -347,8 +318,6 @@
    return isMember(userEntry, new HashSet<DN>());
  }
  /**
   * Indicates whether the user described by the provided user entry
   * is a member of this group.  Note that this is a point-in-time
@@ -381,8 +350,6 @@
                                   Set<DN> examinedGroups)
         throws DirectoryException;
  /**
   * Retrieves an iterator that may be used to cursor through the
   * entries of the members contained in this group.  Note that this
@@ -402,8 +369,6 @@
    return getMembers(null, null, null);
  }
  /**
   * Retrieves an iterator that may be used to cursor through the
   * entries of the members contained in this group.  It may
@@ -435,8 +400,6 @@
                                        SearchFilter filter)
         throws DirectoryException;
  /**
   * Indicates whether it is possible to alter the member list for
   * this group (e.g., in order to add members to the group or remove
@@ -447,8 +410,6 @@
   */
  public abstract boolean mayAlterMemberList();
  /**
   * Attempt to make multiple changes to the group's member list.
   *
@@ -462,8 +423,6 @@
  public abstract void updateMembers(List<Modification> modifications)
         throws UnsupportedOperationException, DirectoryException;
  /**
   * Attempts to add the provided user as a member of this group.  The
   * change should be committed to persistent storage through an
@@ -483,8 +442,6 @@
  public abstract void addMember(Entry userEntry)
         throws UnsupportedOperationException, DirectoryException;
  /**
   * Attempts to remove the specified user as a member of this group.
   * The change should be committed to persistent storage through an
@@ -504,13 +461,12 @@
  public abstract void removeMember(DN userDN)
         throws UnsupportedOperationException, DirectoryException;
  /**
   * Retrieves a string representation of this group.
   *
   * @return  A string representation of this group.
   */
  @Override
  public String toString()
  {
    StringBuilder buffer = new StringBuilder();
@@ -518,8 +474,6 @@
    return buffer.toString();
  }
  /**
   * Appends a string representation of this group to the provided
   * buffer.
@@ -529,4 +483,3 @@
   */
  public abstract void toString(StringBuilder buffer);
}