javadoc formatting

Jean-Noël Rouvignac

28.38.2016 b5e19bd6673e03a4d754212310a20723dcbee1ae

javadoc formatting

 opendj-server-legacy/src/main/java/org/opends/server/discovery/Partition.java

@@ -15,8 +15,6 @@
 */
package org.opends.server.discovery;

import static org.forgerock.util.Utils.*;

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
@@ -27,17 +25,19 @@
import org.opends.server.types.HostPort;

/**
 * Named set of servers defining a distributed service.
 *
 * A distribution load balancer expects data to be split up into shards referred to as "partitions",
 * each partition exposing the same set of naming contexts, but only a sub-set of the data.
 * For example, a distribution might have two partitions, the first containing all users whose name begins with A-M,
 * and the second containing all users whose name begins with N-Z.
 * Both partitions have the same naming contexts, e.g:
 *              dc=example,dc=com - unsharded parent naming context replicated across all servers.
 *                                  Contains data common to all partitions, such as ACIs, groups, etc
 *    ou=people,dc=example,dc=com - sharded naming context whose content (the users) is split up according
 *                                  to some function, e.g. consistent hashing.
 * Named set of servers defining a distributed service. A distribution load balancer expects data to
 * be split up into shards referred to as "partitions", each partition exposing the same set of
 * naming contexts, but only a sub-set of the data. For example, a distribution might have two
 * partitions, the first containing all users whose name begins with A-M, and the second containing
 * all users whose name begins with N-Z. Both partitions have the same naming contexts, e.g:
 * <dl>
 * <dt>dc=example,dc=com
 * <dd>unsharded parent naming context replicated across all servers.<br>
 * Contains data common to all partitions, such as ACIs, groups, etc.
 * <dt>ou=people,dc=example,dc=com<
 * <dd>sharded naming context whose content (the users) is split up according to some function, e.g.
 * consistent hashing.
 * </dl>
 *
 * @see ServiceDiscoveryMechanism#getPartitions(Collection)
 */

 opendj-server-legacy/src/main/java/org/opends/server/discovery/ServiceDiscoveryMechanism.java

@@ -81,12 +81,15 @@
  void deregisterChangeListener(ServiceDiscoveryChangeListener listener);

  /**
   * Returns the list of partitions.
   * Each @see Partition will only contain servers that are known to expose the provided list of base DNs.
   * An empty list of base DNs will result in all partitions and all servers being returned.
   * In other words, an empty list of base DNs implies that all servers contain exactly the same base DNs.
   * Returns the partitions.
   * <p>
   * Each {@link Partition} will only contain servers that are known to expose the provided list of
   * base DNs. An empty list of base DNs will result in all partitions and all servers being
   * returned. In other words, an empty list of base DNs implies that all servers contain exactly
   * the same base DNs.
   *
   * @param baseDNs the baseDNs for which to retrieve the partitions
   * @param baseDNs
   *          the baseDNs for which to retrieve the partitions
   * @return the partitions that can serve the provided base DNs
   */
  Set<Partition> getPartitions(Collection<DN> baseDNs);