YARN-2571 patch 014, more javadoc cleanup

Author: steveloughran

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/api/BindFlags.java

@@ -29,7 +29,7 @@
 public interface BindFlags {
 
   /**
-   * Create the entry.. This is just "0" and can be "or"ed with anything
+   * Create the entry.. This is just "0" and can be "or"ed with anything.
    */
   int CREATE = 0;
 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/api/RegistryConstants.java

@@ -32,25 +32,25 @@ public interface RegistryConstants {
   /**
    * prefix for registry configuration options: {@value}.
    * Why <code>hadoop.</code> and not YARN? It can
-   * live outside YARN
+   * live outside YARN.
    */
   String REGISTRY_PREFIX = "hadoop.registry.";
 
   /**
-   * Prefix for zookeeper-specific options: {@value}
+   * Prefix for zookeeper-specific options: {@value}.
    *  <p>
    * For clients using other protocols, these options are not supported.
    */
   String ZK_PREFIX = REGISTRY_PREFIX + "zk.";
 
   /**
    * flag to indicate whether or not the registry should
-   * be enabled in the RM: {@value}
+   * be enabled in the RM: {@value}.
    */
   String KEY_REGISTRY_ENABLED = REGISTRY_PREFIX + "rm.enabled";
 
   /**
-   * Defaut value for enabling the registry in the RM: {@value}
+   * Default value for enabling the registry in the RM: {@value}.
    */
   boolean DEFAULT_REGISTRY_ENABLED = false;
 
@@ -69,12 +69,12 @@ public interface RegistryConstants {
   boolean DEFAULT_REGISTRY_SECURE = false;
 
   /**
-   * Root path in the ZK tree for the registry: {@value}
+   * Root path in the ZK tree for the registry: {@value}.
    */
   String KEY_REGISTRY_ZK_ROOT = ZK_PREFIX + "root";
 
   /**
-   * Default root of the yarn registry: {@value}
+   * Default root of the yarn registry: {@value}.
    */
   String DEFAULT_ZK_REGISTRY_ROOT = "/registry";
 
@@ -92,7 +92,7 @@ public interface RegistryConstants {
 
   /**
    * Registry client uses Kerberos: authentication is automatic from
-   * logged in user
+   * logged in user.
    */
   String REGISTRY_CLIENT_AUTH_KERBEROS = "kerberos";
 
@@ -104,12 +104,12 @@ public interface RegistryConstants {
   String REGISTRY_CLIENT_AUTH_DIGEST = "digest";
 
   /**
-   * No authentication; client is anonymous
+   * No authentication; client is anonymous.
    */
   String REGISTRY_CLIENT_AUTH_ANONYMOUS = "";
 
   /**
-   * Registry client authentication ID
+   * Registry client authentication ID.
    * <p>
    * This is only used in secure clusters with
    * {@link #KEY_REGISTRY_CLIENT_AUTH} set to
@@ -134,24 +134,24 @@ public interface RegistryConstants {
 
   /**
    * List of hostname:port pairs defining the
-   * zookeeper quorum binding for the registry {@value}
+   * zookeeper quorum binding for the registry {@value}.
    */
   String KEY_REGISTRY_ZK_QUORUM = ZK_PREFIX + "quorum";
 
   /**
-   * The default zookeeper quorum binding for the registry: {@value}
+   * The default zookeeper quorum binding for the registry: {@value}.
    */
   String DEFAULT_REGISTRY_ZK_QUORUM = "localhost:2181";
 
   /**
-   * Zookeeper session timeout in milliseconds: {@value}
+   * Zookeeper session timeout in milliseconds: {@value}.
    */
   String KEY_REGISTRY_ZK_SESSION_TIMEOUT =
       ZK_PREFIX + "session.timeout.ms";
 
   /**
-  * The default ZK session timeout: {@value}.
-  */
+   * The default ZK session timeout: {@value}.
+   */
   int DEFAULT_ZK_SESSION_TIMEOUT = 60000;
 
   /**
@@ -224,9 +224,9 @@ public interface RegistryConstants {
 
   /**
    * A comma separated list of Zookeeper ACL identifiers with
-   * system access to the registry in a secure cluster: {@value}.
+   * user access to the registry in a secure cluster: {@value}.
    *
-   * These are given full access to all entries.
+   * These are given full access to entries under the user account.
    *
    * If there is an "@" at the end of an entry it
    * instructs the registry client to append the default kerberos domain.
@@ -259,7 +259,7 @@ public interface RegistryConstants {
   String KEY_REGISTRY_CLIENT_JAAS_CONTEXT = REGISTRY_PREFIX + "jaas.context";
 
   /**
-   * default client-side registry JAAS context: {@value}
+   * default client-side registry JAAS context: {@value}.
    */
   String DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT = "Client";
 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/BindingInformation.java

@@ -23,19 +23,19 @@
 import org.apache.hadoop.classification.InterfaceStability;
 
 /**
- * Binding information provided by a {@link RegistryBindingSource}
+ * Binding information provided by a {@link RegistryBindingSource}.
  */
 @InterfaceAudience.Public
 @InterfaceStability.Evolving
 public class BindingInformation {
 
   /**
-   * The Curator Ensemble Provider
+   * The Curator Ensemble Provider.
    */
   public EnsembleProvider ensembleProvider;
 
   /**
-   * Any information that may be useful for diagnostics
+   * Any information that may be useful for diagnostics.
    */
   public String description;
 }

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/RegistryInternalConstants.java

@@ -46,7 +46,7 @@ public interface RegistryInternalConstants {
   int PERMISSIONS_REGISTRY_READERS = ZooDefs.Perms.READ;
 
   /**
-   * Permissions for system services: {@value}
+   * Permissions for system services: {@value}.
    */
   int PERMISSIONS_REGISTRY_SYSTEM_SERVICES = ZooDefs.Perms.ALL;
 
@@ -75,7 +75,7 @@ public interface RegistryInternalConstants {
 
   /**
    * This the Hadoop environment variable which propagates the identity
-   * of a user in an insecure cluster
+   * of a user in an insecure cluster.
    */
   String HADOOP_USER_NAME = "HADOOP_USER_NAME";
 }

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/ZKPathDumper.java

@@ -43,7 +43,7 @@ public class ZKPathDumper {
   private final boolean verbose;
 
   /**
-   * Create a path dumper -but do not dump the path until asked
+   * Create a path dumper -but do not dump the path until asked.
    * @param curator curator instance
    * @param root root
    * @param verbose verbose flag - includes more details (such as ACLs)
@@ -73,7 +73,7 @@ public String toString() {
   /**
    * Recursively expand the path into the supplied string builder, increasing
    * the indentation by {@link #INDENT} as it proceeds (depth first) down
-   * the tree
+   * the tree.
    * @param builder string build to append to
    * @param path path to examine
    * @param indent current indentation
@@ -120,7 +120,7 @@ private void expand(StringBuilder builder,
   }
 
   /**
-   * Append the specified indentation to a builder
+   * Append the specified indentation to a builder.
    * @param builder string build to append to
    * @param indent current indentation
    * @param c charactor to use for indentation

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/ZookeeperConfigOptions.java

@@ -23,7 +23,7 @@
 
 /**
  * Configuration options which are internal to Zookeeper,
- * as well as some other ZK constants
+ * as well as some other ZK constants.
  * <p>
  * Zookeeper options are passed via system properties prior to the ZK
  * Methods/classes being invoked. This implies that:
@@ -77,7 +77,7 @@ public interface ZookeeperConfigOptions {
 
   /**
    * The SASL Server context, referring to a context in the JVM's
-   * JAAS context file: {@value}
+   * JAAS context file: {@value}.
    */
   String PROP_ZK_SERVER_SASL_CONTEXT =
       ZooKeeperSaslServer.LOGIN_CONTEXT_NAME_KEY;

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/types/yarn/PersistencePolicies.java

@@ -21,7 +21,7 @@
 import org.apache.hadoop.registry.client.types.ServiceRecord;
 
 /**
- * Persistence policies for {@link ServiceRecord}
+ * Persistence policies for {@link ServiceRecord}.
  */
 
 public interface PersistencePolicies {
@@ -43,7 +43,7 @@ public interface PersistencePolicies {
   String APPLICATION_ATTEMPT = "application-attempt";
 
   /**
-   * Remove when the YARN container in the ID field finishes: {@value}
+   * Remove when the YARN container in the ID field finishes: {@value}.
    */
   String CONTAINER = "container";
 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/types/yarn/YarnRegistryAttributes.java

@@ -19,7 +19,7 @@
 package org.apache.hadoop.registry.client.types.yarn;
 
 /**
- * YARN specific attributes in the registry
+ * YARN specific attributes in the registry.
  */
 public class YarnRegistryAttributes {
 

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/test/java/org/apache/hadoop/registry/AbstractRegistryTest.java

@@ -68,7 +68,7 @@ public void setupRegistry() throws
 
   /**
    * Create a service entry with the sample endpoints, and put it
-   * at the destination
+   * at the destination.
    * @param path path
    * @param createFlags flags
    * @return the record
@@ -82,7 +82,7 @@ protected ServiceRecord putExampleServiceEntry(String path, int createFlags) thr
 
   /**
    * Create a service entry with the sample endpoints, and put it
-   * at the destination
+   * at the destination.
    * @param path path
    * @param createFlags flags
    * @return the record
@@ -100,7 +100,7 @@ protected ServiceRecord putExampleServiceEntry(String path,
   }
 
   /**
-   * Assert a path exists
+   * Assert a path exists.
    * @param path path in the registry
    * @throws IOException
    */
@@ -109,7 +109,7 @@ public void assertPathExists(String path) throws IOException {
   }
 
   /**
-   * assert that a path does not exist
+   * assert that a path does not exist.
    * @param path path in the registry
    * @throws IOException
    */
@@ -123,7 +123,7 @@ public void assertPathNotFound(String path) throws IOException {
   }
 
   /**
-   * Assert that a path resolves to a service record
+   * Assert that a path resolves to a service record.
    * @param path path in the registry
    * @throws IOException
    */

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/test/java/org/apache/hadoop/registry/AbstractZKRegistryTest.java

@@ -84,15 +84,15 @@ public static void createZKServer() throws Exception {
   }
 
   /**
-   * give our thread a name
+   * give our thread a name.
    */
   @Before
   public void nameThread() {
     Thread.currentThread().setName("JUnit");
   }
 
   /**
-   * Returns the connection string to use
+   * Returns the connection string to use.
    *
    * @return connection string
    */