From 78902f0250e2c6d3dea7f2b5b1fcf086a80aa727 Mon Sep 17 00:00:00 2001
From: Shane Kumpf <skumpf@apache.org>
Date: Fri, 14 Sep 2018 10:28:36 -0600
Subject: [PATCH] YARN-8748. Javadoc warnings within the nodemanager package.
 Contributed by Craig Condit

---
 .../server/nodemanager/ContainerExecutor.java |  3 +-
 .../TrafficControlBandwidthHandlerImpl.java   |  2 +-
 .../JavaSandboxLinuxContainerRuntime.java     | 28 +++++++++++++------
 3 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.java
index ba272e24971..98cc2a48d20 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/ContainerExecutor.java
@@ -53,6 +53,7 @@ import org.apache.hadoop.yarn.exceptions.ConfigurationException;
 import org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container;
 import org.apache.hadoop.yarn.server.nodemanager.containermanager.container.ContainerDiagnosticsUpdateEvent;
 import org.apache.hadoop.yarn.server.nodemanager.containermanager.launcher.ContainerLaunch;
+import org.apache.hadoop.yarn.server.nodemanager.containermanager.launcher.ContainerLaunch.ShellScriptBuilder;
 import org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerExecutionException;
 import org.apache.hadoop.yarn.server.nodemanager.executor.ContainerPrepareContext;
 import org.apache.hadoop.yarn.server.nodemanager.util.NodeManagerHardwareUtils;
@@ -88,7 +89,7 @@ public abstract class ContainerExecutor implements Configurable {
   /**
    * The relative path to which debug information will be written.
    *
-   * @see ContainerLaunch.ShellScriptBuilder#listDebugInformation
+   * @see ShellScriptBuilder#listDebugInformation
    */
   public static final String DIRECTORY_CONTENTS = "directory.info";
 
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/TrafficControlBandwidthHandlerImpl.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/TrafficControlBandwidthHandlerImpl.java
index c04e935c78b..a65de02a671 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/TrafficControlBandwidthHandlerImpl.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/TrafficControlBandwidthHandlerImpl.java
@@ -241,7 +241,7 @@ public class TrafficControlBandwidthHandlerImpl
    * Cleanup operations once container is completed - deletes cgroup and
    * removes traffic shaping rule(s).
    * @param containerId of the container that was completed.
-   * @return
+   * @return null
    * @throws ResourceHandlerException
    */
   @Override
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/JavaSandboxLinuxContainerRuntime.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/JavaSandboxLinuxContainerRuntime.java
index dcc86b43bcc..b4ea66dde2c 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/JavaSandboxLinuxContainerRuntime.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/JavaSandboxLinuxContainerRuntime.java
@@ -73,7 +73,8 @@ import static org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.r
  *
  * <ul>
  *   <li>
- *     {@value YarnConfiguration#YARN_CONTAINER_SANDBOX} :
+ *     {@value
+ *     org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX} :
  *     This yarn-site.xml setting has three options:
  *     <ul>
  *     <li>disabled - Default behavior. {@link LinuxContainerRuntime}
@@ -86,26 +87,33 @@ import static org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.r
  *     </ul>
  *   </li>
  *   <li>
- *     {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS} :
+ *     {@value
+ *     org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS}
+ *     :
  *     Determines the file permissions for the application directories.  The
  *     permissions come in the form of comma separated values
  *     (e.g. read,write,execute,delete). Defaults to {@code read} for read-only.
  *   </li>
  *   <li>
- *     {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY} :
+ *     {@value
+ *     org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY}
+ *     :
  *     Accepts canonical path to a java policy file on the local filesystem.
  *     This file will be loaded as the base policy, any additional container
  *     grants will be appended to this base file.  If not specified, the default
  *     java.policy file provided with hadoop resources will be used.
  *   </li>
  *   <li>
- *     {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP} :
+ *     {@value
+ *     org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP}
+ *     :
  *     Optional setting to specify a YARN queue which will be exempt from the
  *     sand-boxing process.
  *   </li>
  *   <li>
  *     {@value
- *     YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY_GROUP_PREFIX}$groupName :
+ *     org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY_GROUP_PREFIX}$groupName
+ *     :
  *     Optional setting to map groups to java policy files.  The value is a path
  *     to the java policy file for $groupName.  A user which is a member of
  *     multiple groups with different policies will receive the superset of all
@@ -197,9 +205,10 @@ public class JavaSandboxLinuxContainerRuntime
    *  <br>
    *  The Java Sandbox will be circumvented if the user is a member of the
    *  group specified in:
-   *  {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP} and if
-   *  they do not include the JVM flag:
-   *  {@value NMContainerPolicyUtils#SECURITY_FLAG}
+   *  {@value
+   *  org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP}
+   *  and if they do not include the JVM flag
+   *  <code>-Djava.security.manager</code>.
    *
    * @param ctx The {@link ContainerRuntimeContext} containing container
    *            setup properties.
@@ -281,7 +290,8 @@ public class JavaSandboxLinuxContainerRuntime
   /**
    * Determine if JVMSandboxLinuxContainerRuntime should be used.  This is
    * decided based on the value of
-   * {@value YarnConfiguration#YARN_CONTAINER_SANDBOX}
+   * {@value
+   * org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX}
    * @param env the environment variable settings for the operation
    * @return true if Sandbox is requested, false otherwise
    */