From 2b2f7f2b9095d45f4197d5e3ba0c65a6995ec1fd Mon Sep 17 00:00:00 2001 From: Tsuyoshi Ozawa Date: Mon, 16 Mar 2015 23:19:05 +0900 Subject: [PATCH] YARN-1453. [JDK8] Fix Javadoc errors caused by incorrect or illegal tags in doc comments. Contributed by Akira AJISAKA, Andrew Purtell, and Allen Wittenauer. (cherry picked from commit 3da9a97cfbcc3a1c50aaf85b1a129d4d269cd5fd) --- hadoop-yarn-project/CHANGES.txt | 3 + .../yarn/api/ApplicationBaseProtocol.java | 44 ++++-------- .../yarn/api/ApplicationClientProtocol.java | 3 - .../api/protocolrecords/AllocateRequest.java | 25 ++++--- .../api/protocolrecords/AllocateResponse.java | 68 ++++++++++--------- .../FinishApplicationMasterRequest.java | 25 ++++--- .../FinishApplicationMasterResponse.java | 7 +- .../GetApplicationsRequest.java | 1 - .../GetClusterMetricsResponse.java | 4 +- .../GetContainerStatusesRequest.java | 2 - .../GetContainerStatusesResponse.java | 2 - .../protocolrecords/GetQueueInfoRequest.java | 2 +- .../protocolrecords/GetQueueInfoResponse.java | 11 ++- .../KillApplicationResponse.java | 9 ++- .../RegisterApplicationMasterRequest.java | 33 +++++---- .../RegisterApplicationMasterResponse.java | 11 ++- .../StartContainerRequest.java | 9 +-- .../api/records/ApplicationAttemptReport.java | 23 +++---- .../yarn/api/records/ApplicationReport.java | 47 +++++++------ .../records/ApplicationSubmissionContext.java | 50 +++++++------- .../hadoop/yarn/api/records/Container.java | 49 +++++++------ .../api/records/ContainerLaunchContext.java | 35 +++++----- .../yarn/api/records/ContainerReport.java | 29 ++++---- .../yarn/api/records/ContainerStatus.java | 21 +++--- .../yarn/api/records/LocalResourceType.java | 32 ++++----- .../api/records/LocalResourceVisibility.java | 31 ++++----- .../api/records/LogAggregationContext.java | 39 ++++++----- .../hadoop/yarn/api/records/NodeReport.java | 25 ++++--- .../yarn/api/records/PreemptionMessage.java | 32 ++++----- .../hadoop/yarn/api/records/QueueACL.java | 13 ++-- .../hadoop/yarn/api/records/QueueInfo.java | 25 ++++--- .../hadoop/yarn/api/records/QueueState.java | 15 ++-- .../yarn/api/records/ReservationRequest.java | 17 ++--- .../ReservationRequestInterpreter.java | 38 +++++------ .../yarn/api/records/ResourceRequest.java | 51 +++++++------- .../hadoop/yarn/conf/YarnConfiguration.java | 5 +- .../UpdateNodeResourceRequest.java | 4 +- .../hadoop/yarn/client/api/AHSClient.java | 24 +++---- .../hadoop/yarn/client/api/AMRMClient.java | 4 +- .../hadoop/yarn/client/api/NMClient.java | 4 +- .../hadoop/yarn/client/api/NMTokenCache.java | 58 ++++++++-------- .../hadoop/yarn/client/api/YarnClient.java | 23 +++---- .../nodelabels/CommonNodeLabelsManager.java | 6 +- .../yarn/nodelabels/NodeLabelsStore.java | 3 +- .../security/ApplicationACLsManager.java | 1 - .../apache/hadoop/yarn/util/StringHelper.java | 6 +- .../apache/hadoop/yarn/webapp/WebApps.java | 4 +- .../client/binding/RegistryUtils.java | 8 +-- .../client/impl/RegistryOperationsClient.java | 2 +- .../impl/zk/ZookeeperConfigOptions.java | 3 +- .../services/MicroZookeeperService.java | 10 +-- .../server/services/package-info.java | 9 ++- ...melineAuthenticationFilterInitializer.java | 13 ++-- .../org/apache/hadoop/yarn/lib/ZKClient.java | 2 +- .../RegisterNodeManagerRequest.java | 3 +- .../server/api/records/NodeHealthStatus.java | 24 +++---- .../server/nodemanager/ContainerExecutor.java | 8 ++- .../util/NodeManagerHardwareUtils.java | 8 +-- .../rmapp/attempt/RMAppAttempt.java | 11 +-- .../scheduler/SchedulerNode.java | 2 +- .../scheduler/SchedulerUtils.java | 3 +- .../fair/policies/ComputeFairShares.java | 19 +++--- .../security/DelegationTokenRenewer.java | 2 - .../yarn/server/webproxy/ProxyUriUtils.java | 2 +- 64 files changed, 517 insertions(+), 585 deletions(-) diff --git a/hadoop-yarn-project/CHANGES.txt b/hadoop-yarn-project/CHANGES.txt index bd065042371..0d08ec67ec0 100644 --- a/hadoop-yarn-project/CHANGES.txt +++ b/hadoop-yarn-project/CHANGES.txt @@ -709,6 +709,9 @@ Release 2.7.0 - UNRELEASED YARN-3171. Sort by Application id, AppAttempt and ContainerID doesn't work in ATS / RM web ui. (Naganarasimha G R via xgong) + YARN-1453. [JDK8] Fix Javadoc errors caused by incorrect or illegal tags in + doc comments. (Akira AJISAKA, Andrew Purtell, and Allen Wittenauer via ozawa) + Release 2.6.0 - 2014-11-18 INCOMPATIBLE CHANGES diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java index 2a8a2833826..8234c2fb80a 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationBaseProtocol.java @@ -65,41 +65,31 @@ import org.apache.hadoop.yarn.exceptions.YarnException; public interface ApplicationBaseProtocol { /** - *

* The interface used by clients to get a report of an Application from the * ResourceManager or ApplicationHistoryServer. - *

- * *

* The client, via {@link GetApplicationReportRequest} provides the * {@link ApplicationId} of the application. - *

- * *

* In secure mode,the ResourceManager or * ApplicationHistoryServer verifies access to the application, * queue etc. before accepting the request. - *

- * *

* The ResourceManager or ApplicationHistoryServer * responds with a {@link GetApplicationReportResponse} which includes the * {@link ApplicationReport} for the application. - *

- * *

* If the user does not have VIEW_APP access then the following * fields in the report will be set to stubbed values: *

- *

* * @param request * request for an application report @@ -148,40 +138,30 @@ public interface ApplicationBaseProtocol { IOException; /** - *

* The interface used by clients to get a report of an Application Attempt * from the ResourceManager or * ApplicationHistoryServer - *

- * *

* The client, via {@link GetApplicationAttemptReportRequest} provides the * {@link ApplicationAttemptId} of the application attempt. - *

- * *

* In secure mode,the ResourceManager or * ApplicationHistoryServer verifies access to the method before * accepting the request. - *

- * *

* The ResourceManager or ApplicationHistoryServer * responds with a {@link GetApplicationAttemptReportResponse} which includes * the {@link ApplicationAttemptReport} for the application attempt. - *

- * *

* If the user does not have VIEW_APP access then the following * fields in the report will be set to stubbed values: *

- *

* * @param request * request for an application attempt report diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java index 0a7d41597a2..8b9937b1ce7 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/ApplicationClientProtocol.java @@ -135,9 +135,6 @@ public interface ApplicationClientProtocol extends ApplicationBaseProtocol { * @return (empty) response on accepting the submission * @throws YarnException * @throws IOException - * @throws InvalidResourceRequestException - * The exception is thrown when a {@link ResourceRequest} is out of - * the range of the configured lower and upper resource boundaries. * @see #getNewApplication(GetNewApplicationRequest) */ @Public diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java index 62316a64b69..2458d9ba431 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateRequest.java @@ -35,19 +35,18 @@ import org.apache.hadoop.yarn.util.Records; * ResourceManager to obtain resources in the cluster.

* *

The request includes: - *

- *

+ * * * @see ApplicationMasterProtocol#allocate(AllocateRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java index 46ac6428a04..c4fdb79f4e1 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.java @@ -39,27 +39,27 @@ import org.apache.hadoop.yarn.api.records.Token; import org.apache.hadoop.yarn.util.Records; /** - *

The response sent by the ResourceManager the - * ApplicationMaster during resource negotiation.

- * - *

The response, includes: - *

- *

+ * The response sent by the ResourceManager the + * ApplicationMaster during resource negotiation. + *

+ * The response, includes: + *

* * @see ApplicationMasterProtocol#allocate(AllocateRequest) */ @@ -220,16 +220,16 @@ public abstract class AllocateResponse { public abstract void setNumClusterNodes(int numNodes); /** - *

Get the description of containers owned by the AM, but requested back by + * Get the description of containers owned by the AM, but requested back by * the cluster. Note that the RM may have an inconsistent view of the * resources owned by the AM. These messages are advisory, and the AM may - * elect to ignore them.

- * - *

The message is a snapshot of the resources the RM wants back from the AM. + * elect to ignore them. + *

+ * The message is a snapshot of the resources the RM wants back from the AM. * While demand persists, the RM will repeat its request; applications should - * not interpret each message as a request for additional + * not interpret each message as a request for additional * resources on top of previous messages. Resources requested consistently - * over some duration may be forcibly killed by the RM.

+ * over some duration may be forcibly killed by the RM. * * @return A specification of the resources to reclaim from this AM. */ @@ -242,15 +242,17 @@ public abstract class AllocateResponse { public abstract void setPreemptionMessage(PreemptionMessage request); /** - *

Get the list of NMTokens required for communicating with NM. New NMTokens - * issued only if

- *

1) AM is receiving first container on underlying NodeManager.
+ * Get the list of NMTokens required for communicating with NM. New NMTokens + * issued only if + *

+ * 1) AM is receiving first container on underlying NodeManager.
* OR
* 2) NMToken master key rolled over in ResourceManager and AM is getting new - * container on the same underlying NodeManager.

- *

AM will receive one NMToken per NM irrespective of the number of containers + * container on the same underlying NodeManager. + *

+ * AM will receive one NMToken per NM irrespective of the number of containers * issued on same NM. AM is expected to store these tokens until issued a - * new token for the same NM.

+ * new token for the same NM. */ @Public @Stable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java index 15c36802bbe..cbbe9c5ccec 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterRequest.java @@ -25,19 +25,18 @@ import org.apache.hadoop.yarn.api.records.FinalApplicationStatus; import org.apache.hadoop.yarn.util.Records; /** - *

The finalization request sent by the ApplicationMaster to - * inform the ResourceManager about its completion.

- * - *

The final request includes details such: - *

    - *
  • Final state of the ApplicationMaster
    • - *
  • - * Diagnostic information in case of failure of the - * ApplicationMaster - *
    • - *
  • Tracking URL
    • - *
- *

+ * The finalization request sent by the {@code ApplicationMaster} to + * inform the {@code ResourceManager} about its completion. + *

+ * The final request includes details such: + *

    + *
  • Final state of the {@code ApplicationMaster}
    • + *
  • + * Diagnostic information in case of failure of the + * {@code ApplicationMaster} + *
    • + *
  • Tracking URL
    • + *
* * @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java index 8de2c73d88a..6647a10bb04 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/FinishApplicationMasterResponse.java @@ -26,22 +26,19 @@ import org.apache.hadoop.yarn.api.ApplicationMasterProtocol; import org.apache.hadoop.yarn.util.Records; /** - *

* The response sent by the ResourceManager to a * ApplicationMaster on it's completion. - *

- * *

* The response, includes: *

    *
  • A flag which indicates that the application has successfully unregistered * with the RM and the application can safely stop.
    • *
- *

+ *

* Note: The flag indicates whether the application has successfully * unregistered and is safe to stop. The application may stop after the flag is * true. If the application stops before the flag is true then the RM may retry - * the application . + * the application. * * @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java index 7fc58d67aef..35392e44d52 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationsRequest.java @@ -34,7 +34,6 @@ import org.apache.hadoop.yarn.util.Records; *

The request from clients to get a report of Applications * in the cluster from the ResourceManager.

* - * * @see ApplicationClientProtocol#getApplications(GetApplicationsRequest) */ @Public diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java index 6329aac21b4..18a08077de3 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.java @@ -27,8 +27,8 @@ import org.apache.hadoop.yarn.api.records.YarnClusterMetrics; import org.apache.hadoop.yarn.util.Records; /** - *

The response sent by the ResourceManager to a client - * requesting cluster metrics.

+ * The response sent by the ResourceManager to a client + * requesting cluster metrics. * * @see YarnClusterMetrics * @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java index f9f77a3af2f..60c63ca0332 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesRequest.java @@ -28,11 +28,9 @@ import org.apache.hadoop.yarn.api.records.ContainerStatus; import org.apache.hadoop.yarn.util.Records; /** - *

* The request sent by the ApplicationMaster to the * NodeManager to get {@link ContainerStatus} of requested * containers. - *

* * @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java index b0a0f0e4882..68e6a8c2e3d 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusesResponse.java @@ -32,11 +32,9 @@ import org.apache.hadoop.yarn.api.records.SerializedException; import org.apache.hadoop.yarn.util.Records; /** - *

* The response sent by the NodeManager to the * ApplicationMaster when asked to obtain the * ContainerStatus of requested containers. - *

* * @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java index df3342fedcb..0e33e21d211 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.java @@ -63,7 +63,7 @@ public abstract class GetQueueInfoRequest { public abstract void setQueueName(String queueName); /** - * Is information about active applications required? + * Is information about active applications required? * @return true if applications' information is to be included, * else false */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java index ea6cb7b6c47..b97a5a3ecc1 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.java @@ -27,12 +27,11 @@ import org.apache.hadoop.yarn.api.records.QueueInfo; import org.apache.hadoop.yarn.util.Records; /** - *

The response sent by the ResourceManager to a client - * requesting information about queues in the system.

- * - *

The response includes a {@link QueueInfo} which has details such as - * queue name, used/total capacities, running applications, child queues etc - * .

+ * The response sent by the {@code ResourceManager} to a client + * requesting information about queues in the system. + *

+ * The response includes a {@link QueueInfo} which has details such as + * queue name, used/total capacities, running applications, child queues etc. * * @see QueueInfo * @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java index 77bb71d6796..7225bf59fbe 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.java @@ -26,21 +26,20 @@ import org.apache.hadoop.yarn.api.ApplicationClientProtocol; import org.apache.hadoop.yarn.util.Records; /** - *

* The response sent by the ResourceManager to the client aborting * a submitted application. - *

*

* The response, includes: *

    - *
  • A flag which indicates that the process of killing the application is - * completed or not.
    • + *
  • + * A flag which indicates that the process of killing the application is + * completed or not. + *
    • *
* Note: user is recommended to wait until this flag becomes true, otherwise if * the ResourceManager crashes before the process of killing the * application is completed, the ResourceManager may retry this * application on recovery. - *

* * @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java index 6b0185461fd..395e190ff59 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterRequest.java @@ -24,16 +24,15 @@ import org.apache.hadoop.yarn.api.ApplicationMasterProtocol; import org.apache.hadoop.yarn.util.Records; /** - *

The request sent by the ApplicationMaster to - * ResourceManager on registration.

- * - *

The registration includes details such as: - *

    - *
  • Hostname on which the AM is running.
    • - *
  • RPC Port
    • - *
  • Tracking URL
    • - *
- *

+ * The request sent by the {@code ApplicationMaster} to {@code ResourceManager} + * on registration. + *

+ * The registration includes details such as: + *

    + *
  • Hostname on which the AM is running.
    • + *
  • RPC Port
    • + *
  • Tracking URL
    • + *
* * @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest) */ @@ -83,20 +82,20 @@ public abstract class RegisterApplicationMasterRequest { public abstract void setHost(String host); /** - * Get the RPC port on which the ApplicationMaster - * is responding. - * @return the RPC port on which the ApplicationMaster is - * responding + * Get the RPC port on which the {@code ApplicationMaster} is + * responding. + * @return the RPC port on which the {@code ApplicationMaster} + * is responding */ @Public @Stable public abstract int getRpcPort(); /** - * Set the RPC port on which the ApplicationMaster is + * Set the RPC port on which the {@code ApplicationMaster} is * responding. - * @param port RPC port on which the ApplicationMaster is - * responding + * @param port RPC port on which the {@code ApplicationMaster} + * is responding */ @Public @Stable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java index 33daf281230..1a51ba6c008 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.java @@ -36,16 +36,15 @@ import org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes; import org.apache.hadoop.yarn.util.Records; /** - *

The response sent by the ResourceManager to a new - * ApplicationMaster on registration.

- * - *

The response contains critical details such as: + * The response sent by the {@code ResourceManager} to a new + * {@code ApplicationMaster} on registration. + *

+ * The response contains critical details such as: *

    *
  • Maximum capability for allocated resources in the cluster.
    • - *
  • ApplicationACLs for the application.
    • + *
  • {@code ApplicationACL}s for the application.
    • *
  • ClientToAMToken master key.
    • *
- *

* * @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java index 1dcefb2e3ea..50179a962ba 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/StartContainerRequest.java @@ -74,10 +74,11 @@ public abstract class StartContainerRequest { public abstract void setContainerLaunchContext(ContainerLaunchContext context); /** - *

Get the container token to be used for authorization during starting - * container.

- *

Note: {@link NMToken} will be used for authenticating communication with - * NodeManager.

+ * Get the container token to be used for authorization during starting + * container. + *

+ * Note: {@link NMToken} will be used for authenticating communication with + * {@code NodeManager}. * @return the container token to be used for authorization during starting * container. * @see NMToken diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java index 53c18ae3cef..b7f9c1b3a04 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationAttemptReport.java @@ -24,24 +24,19 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - *

- * ApplicationAttemptReport is a report of an application attempt. - *

- * + * {@code ApplicationAttemptReport} is a report of an application attempt. *

* It includes details such as: *

    - *
  • {@link ApplicationAttemptId} of the application.
    • - *
  • Host on which the ApplicationMaster of this attempt is - * running.
    • - *
  • RPC port of the ApplicationMaster of this attempt.
    • - *
  • Tracking URL.
    • - *
  • Diagnostic information in case of errors.
    • - *
  • {@link YarnApplicationAttemptState} of the application attempt.
    • - *
  • {@link ContainerId} of the master Container.
    • + *
  • {@link ApplicationAttemptId} of the application.
    • + *
  • Host on which the ApplicationMaster of this attempt is + * running.
    • + *
  • RPC port of the ApplicationMaster of this attempt.
    • + *
  • Tracking URL.
    • + *
  • Diagnostic information in case of errors.
    • + *
  • {@link YarnApplicationAttemptState} of the application attempt.
    • + *
  • {@link ContainerId} of the master Container.
    • *
- *

- * */ @Public @Unstable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java index 412c22b13db..ff4fb52a555 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationReport.java @@ -28,23 +28,22 @@ import org.apache.hadoop.yarn.util.Records; import java.util.Set; /** - *

ApplicationReport is a report of an application.

- * - *

It includes details such as: - *

    - *
  • {@link ApplicationId} of the application.
    • - *
  • Applications user.
    • - *
  • Application queue.
    • - *
  • Application name.
    • - *
  • Host on which the ApplicationMaster is running.
    • - *
  • RPC port of the ApplicationMaster.
    • - *
  • Tracking URL.
    • - *
  • {@link YarnApplicationState} of the application.
    • - *
  • Diagnostic information in case of errors.
    • - *
  • Start time of the application.
    • - *
  • Client {@link Token} of the application (if security is enabled).
    • - *
- *

+ * {@code ApplicationReport} is a report of an application. + *

+ * It includes details such as: + *

    + *
  • {@link ApplicationId} of the application.
    • + *
  • Applications user.
    • + *
  • Application queue.
    • + *
  • Application name.
    • + *
  • Host on which the ApplicationMaster is running.
    • + *
  • RPC port of the ApplicationMaster.
    • + *
  • Tracking URL.
    • + *
  • {@link YarnApplicationState} of the application.
    • + *
  • Diagnostic information in case of errors.
    • + *
  • Start time of the application.
    • + *
  • Client {@link Token} of the application (if security is enabled).
    • + *
* * @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest) */ @@ -341,20 +340,20 @@ public abstract class ApplicationReport { /** * Get the AMRM token of the application. - *

+ *

* The AMRM token is required for AM to RM scheduling operations. For * managed Application Masters Yarn takes care of injecting it. For unmanaged * Applications Masters, the token must be obtained via this method and set * in the {@link org.apache.hadoop.security.UserGroupInformation} of the * current user. - *

+ *

* The AMRM token will be returned only if all the following conditions are * met: - *

  • - *
      the requester is the owner of the ApplicationMaster
    - *
      the application master is an unmanaged ApplicationMaster
    - *
      the application master is in ACCEPTED state
    - *
    • + *
      + *
    • the requester is the owner of the ApplicationMaster
      • + *
    • the application master is an unmanaged ApplicationMaster
      • + *
    • the application master is in ACCEPTED state
      • + *
    * Else this method returns NULL. * * @return the AM to RM token if available. diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java index c4014fc6eec..21cd1bbe885 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.java @@ -33,32 +33,34 @@ import org.apache.hadoop.yarn.conf.YarnConfiguration; import org.apache.hadoop.yarn.util.Records; /** - *

    ApplicationSubmissionContext represents all of the - * information needed by the ResourceManager to launch - * the ApplicationMaster for an application.

    - * - *

    It includes details such as: - *

      - *
    • {@link ApplicationId} of the application.
      • - *
    • Application user.
      • - *
    • Application name.
      • - *
    • {@link Priority} of the application.
      • - *
    • - * {@link ContainerLaunchContext} of the container in which the - * ApplicationMaster is executed. - *
      • - *
    • maxAppAttempts. The maximum number of application attempts. + * {@code ApplicationSubmissionContext} represents all of the + * information needed by the {@code ResourceManager} to launch + * the {@code ApplicationMaster} for an application. + *

      + * It includes details such as: + *

        + *
      • {@link ApplicationId} of the application.
        • + *
      • Application user.
        • + *
      • Application name.
        • + *
      • {@link Priority} of the application.
        • + *
      • + * {@link ContainerLaunchContext} of the container in which the + * ApplicationMaster is executed. + *
        • + *
      • + * maxAppAttempts. The maximum number of application attempts. * It should be no larger than the global number of max attempts in the - * Yarn configuration.
        • - *
      • attemptFailuresValidityInterval. The default value is -1. - * when attemptFailuresValidityInterval in milliseconds is set to > 0, - * the failure number will no take failures which happen out of the - * validityInterval into failure count. If failure count reaches to - * maxAppAttempts, the application will be failed. - *
        • + * Yarn configuration. + * + *
      • + * attemptFailuresValidityInterval. The default value is -1. + * when attemptFailuresValidityInterval in milliseconds is set to + * {@literal >} 0, the failure number will no take failures which happen + * out of the validityInterval into failure count. If failure count + * reaches to maxAppAttempts, the application will be failed. + *
        • *
      • Optional, application-specific {@link LogAggregationContext}
        • - *
      - *

      + *
    * * @see ContainerLaunchContext * @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java index 279f12759a1..38fa8b90e78 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/Container.java @@ -27,34 +27,31 @@ import org.apache.hadoop.yarn.api.ContainerManagementProtocol; import org.apache.hadoop.yarn.util.Records; /** - *

    Container represents an allocated resource in the cluster. - *

    - * - *

    The ResourceManager is the sole authority to allocate any - * Container to applications. The allocated Container + * {@code Container} represents an allocated resource in the cluster. + *

    + * The {@code ResourceManager} is the sole authority to allocate any + * {@code Container} to applications. The allocated {@code Container} * is always on a single node and has a unique {@link ContainerId}. It has - * a specific amount of {@link Resource} allocated.

    + * a specific amount of {@link Resource} allocated. + *

    + * It includes details such as: + *

      + *
    • {@link ContainerId} for the container, which is globally unique.
      • + *
    • + * {@link NodeId} of the node on which it is allocated. + *
      • + *
    • HTTP uri of the node.
      • + *
    • {@link Resource} allocated to the container.
      • + *
    • {@link Priority} at which the container was allocated.
      • + *
    • + * Container {@link Token} of the container, used to securely verify + * authenticity of the allocation. + *
      • + *
    * - *

    It includes details such as: - *

      - *
    • {@link ContainerId} for the container, which is globally unique.
      • - *
    • - * {@link NodeId} of the node on which it is allocated. - *
      • - *
    • HTTP uri of the node.
      • - *
    • {@link Resource} allocated to the container.
      • - *
    • {@link Priority} at which the container was allocated.
      • - *
    • - * Container {@link Token} of the container, used to securely verify - * authenticity of the allocation. - *
      • - *
    - *

    - * - *

    Typically, an ApplicationMaster receives the - * Container from the ResourceManager during - * resource-negotiation and then talks to the NodeManager to - * start/stop containers.

    + * Typically, an {@code ApplicationMaster} receives the {@code Container} + * from the {@code ResourceManager} during resource-negotiation and then + * talks to the {@code NodeManager} to start/stop containers. * * @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest) * @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java index a648fef0fc5..932945bdd10 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerLaunchContext.java @@ -30,24 +30,23 @@ import org.apache.hadoop.yarn.server.api.AuxiliaryService; import org.apache.hadoop.yarn.util.Records; /** - *

    ContainerLaunchContext represents all of the information - * needed by the NodeManager to launch a container.

    - * - *

    It includes details such as: - *

      - *
    • {@link ContainerId} of the container.
      • - *
    • {@link Resource} allocated to the container.
      • - *
    • User to whom the container is allocated.
      • - *
    • Security tokens (if security is enabled).
      • - *
    • - * {@link LocalResource} necessary for running the container such - * as binaries, jar, shared-objects, side-files etc. - *
      • - *
    • Optional, application-specific binary service data.
      • - *
    • Environment variables for the launched process.
      • - *
    • Command to launch the container.
      • - *
    - *

    + * {@code ContainerLaunchContext} represents all of the information + * needed by the {@code NodeManager} to launch a container. + *

    + * It includes details such as: + *

      + *
    • {@link ContainerId} of the container.
      • + *
    • {@link Resource} allocated to the container.
      • + *
    • User to whom the container is allocated.
      • + *
    • Security tokens (if security is enabled).
      • + *
    • + * {@link LocalResource} necessary for running the container such + * as binaries, jar, shared-objects, side-files etc. + *
      • + *
    • Optional, application-specific binary service data.
      • + *
    • Environment variables for the launched process.
      • + *
    • Command to launch the container.
      • + *
    * * @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java index 72b8edfe6f0..11d7bca6803 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerReport.java @@ -24,27 +24,22 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - *

    - * ContainerReport is a report of an container. - *

    - * + * {@code ContainerReport} is a report of an container. *

    * It includes details such as: *

      - *
    • {@link ContainerId} of the container.
      • - *
    • Allocated Resources to the container.
      • - *
    • Assigned Node id.
      • - *
    • Assigned Priority.
      • - *
    • Creation Time.
      • - *
    • Finish Time.
      • - *
    • Container Exit Status.
      • - *
    • {@link ContainerState} of the container.
      • - *
    • Diagnostic information in case of errors.
      • - *
    • Log URL.
      • - *
    • nodeHttpAddress
      • + *
    • {@link ContainerId} of the container.
      • + *
    • Allocated Resources to the container.
      • + *
    • Assigned Node id.
      • + *
    • Assigned Priority.
      • + *
    • Creation Time.
      • + *
    • Finish Time.
      • + *
    • Container Exit Status.
      • + *
    • {@link ContainerState} of the container.
      • + *
    • Diagnostic information in case of errors.
      • + *
    • Log URL.
      • + *
    • nodeHttpAddress
      • *
    - *

    - * */ @Public diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java index 574373c2e78..5ccf6dceb6b 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ContainerStatus.java @@ -25,17 +25,16 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - *

    ContainerStatus represents the current status of a - * Container.

    - * - *

    It provides details such as: - *

      - *
    • ContainerId of the container.
      • - *
    • ContainerState of the container.
      • - *
    • Exit status of a completed container.
      • - *
    • Diagnostic message for a failed container.
      • - *
    - *

    + * {@code ContainerStatus} represents the current status of a + * {@code Container}. + *

    + * It provides details such as: + *

      + *
    • {@code ContainerId} of the container.
      • + *
    • {@code ContainerState} of the container.
      • + *
    • Exit status of a completed container.
      • + *
    • Diagnostic message for a failed container.
      • + *
    */ @Public @Stable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java index d1aa45b23a3..1552cdf8cc3 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceType.java @@ -23,22 +23,22 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ContainerManagementProtocol; /** - *

    LocalResourceType specifies the type - * of a resource localized by the NodeManager.

    - * - *

    The type can be one of: - *

      - *
    • - * {@link #FILE} - Regular file i.e. uninterpreted bytes. - *
      • - *
    • - * {@link #ARCHIVE} - Archive, which is automatically unarchived by the - * NodeManager. - *
      • - *
    • - * {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}. - *
    - *

    + * {@code LocalResourceType} specifies the type + * of a resource localized by the {@code NodeManager}. + *

    + * The type can be one of: + *

      + *
    • + * {@link #FILE} - Regular file i.e. uninterpreted bytes. + *
      • + *
    • + * {@link #ARCHIVE} - Archive, which is automatically unarchived by the + * NodeManager. + *
      • + *
    • + * {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}. + *
      • + *
    * * @see LocalResource * @see ContainerLaunchContext diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java index d368bfb8139..2b71991c526 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LocalResourceVisibility.java @@ -23,22 +23,21 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ContainerManagementProtocol; /** - *

    LocalResourceVisibility specifies the visibility - * of a resource localized by the NodeManager.

    - * - *

    The visibility can be one of: - *

      - *
    • {@link #PUBLIC} - Shared by all users on the node.
      • - *
    • - * {@link #PRIVATE} - Shared among all applications of the - * same user on the node. - *
      • - *
    • - * {@link #APPLICATION} - Shared only among containers of the - * same application on the node. - *
      • - *
    - *

    + * {@code LocalResourceVisibility} specifies the visibility + * of a resource localized by the {@code NodeManager}. + *

    + * The visibility can be one of: + *

      + *
    • {@link #PUBLIC} - Shared by all users on the node.
      • + *
    • + * {@link #PRIVATE} - Shared among all applications of the + * same user on the node. + *
      • + *
    • + * {@link #APPLICATION} - Shared only among containers of the + * same application on the node. + *
      • + *
    * * @see LocalResource * @see ContainerLaunchContext diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java index e582d2c6e8c..938300474f3 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/LogAggregationContext.java @@ -24,30 +24,37 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - *

    LogAggregationContext represents all of the - * information needed by the NodeManager to handle - * the logs for an application.

    - * - *

    It includes details such as: - *

      - *
    • includePattern. It uses Java Regex to filter the log files + * {@code LogAggregationContext} represents all of the + * information needed by the {@code NodeManager} to handle + * the logs for an application. + *

      + * It includes details such as: + *

        + *
      • + * includePattern. It uses Java Regex to filter the log files * which match the defined include pattern and those log files - * will be uploaded when the application finishes.
        • - *
      • excludePattern. It uses Java Regex to filter the log files + * will be uploaded when the application finishes. + *
        • + *
      • + * excludePattern. It uses Java Regex to filter the log files * which match the defined exclude pattern and those log files * will not be uploaded when application finishes. If the log file * name matches both the include and the exclude pattern, this file - * will be excluded eventually
        • - *
      • rolledLogsIncludePattern. It uses Java Regex to filter the log files + * will be excluded eventually. + *
        • + *
      • + * rolledLogsIncludePattern. It uses Java Regex to filter the log files * which match the defined include pattern and those log files - * will be aggregated in a rolling fashion.
        • - *
      • rolledLogsExcludePattern. It uses Java Regex to filter the log files + * will be aggregated in a rolling fashion. + *
        • + *
      • + * rolledLogsExcludePattern. It uses Java Regex to filter the log files * which match the defined exclude pattern and those log files * will not be aggregated in a rolling fashion. If the log file * name matches both the include and the exclude pattern, this file - * will be excluded eventually
        • - *
      - *

      + * will be excluded eventually. + *
      • + *
    * * @see ApplicationSubmissionContext */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java index 7ba866d1d1a..aac19bd7d9b 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/NodeReport.java @@ -28,19 +28,18 @@ import org.apache.hadoop.yarn.api.ApplicationClientProtocol; import org.apache.hadoop.yarn.util.Records; /** - *

    NodeReport is a summary of runtime information of a - * node in the cluster.

    - * - *

    It includes details such as: - *

      - *
    • {@link NodeId} of the node.
      • - *
    • HTTP Tracking URL of the node.
      • - *
    • Rack name for the node.
      • - *
    • Used {@link Resource} on the node.
      • - *
    • Total available {@link Resource} of the node.
      • - *
    • Number of running containers on the node.
      • - *
    - *

    + * {@code NodeReport} is a summary of runtime information of a node + * in the cluster. + *

    + * It includes details such as: + *

      + *
    • {@link NodeId} of the node.
      • + *
    • HTTP Tracking URL of the node.
      • + *
    • Rack name for the node.
      • + *
    • Used {@link Resource} on the node.
      • + *
    • Total available {@link Resource} of the node.
      • + *
    • Number of running containers on the node.
      • + *
    * * @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest) */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java index 976d18125cf..cdf34f8fc70 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionMessage.java @@ -24,36 +24,36 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - *

    A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by + * A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by * the RM to specify resources that the RM wants to reclaim from this - * ApplicationMaster (AM). The AM receives a {@link + * {@code ApplicationMaster} (AM). The AM receives a {@link * StrictPreemptionContract} message encoding which containers the platform may * forcibly kill, granting it an opportunity to checkpoint state or adjust its * execution plan. The message may also include a {@link PreemptionContract} * granting the AM more latitude in selecting which resources to return to the - * cluster.

    - * - *

    The AM should decode both parts of the message. The {@link + * cluster. + *

    + * The AM should decode both parts of the message. The {@link * StrictPreemptionContract} specifies particular allocations that the RM * requires back. The AM can checkpoint containers' state, adjust its execution * plan to move the computation, or take no action and hope that conditions that - * caused the RM to ask for the container will change.

    - * - *

    In contrast, the {@link PreemptionContract} also includes a description of + * caused the RM to ask for the container will change. + *

    + * In contrast, the {@link PreemptionContract} also includes a description of * resources with a set of containers. If the AM releases containers matching * that profile, then the containers enumerated in {@link - * PreemptionContract#getContainers()} may not be killed.

    - * - *

    Each preemption message reflects the RM's current understanding of the - * cluster state, so a request to return N containers may not + * PreemptionContract#getContainers()} may not be killed. + *

    + * Each preemption message reflects the RM's current understanding of the + * cluster state, so a request to return N containers may not * reflect containers the AM is releasing, recently exited containers the RM has * yet to learn about, or new containers allocated before the message was * generated. Conversely, an RM may request a different profile of containers in - * subsequent requests.

    - * - *

    The policy enforced by the RM is part of the scheduler. Generally, only + * subsequent requests. + *

    + * The policy enforced by the RM is part of the scheduler. Generally, only * containers that have been requested consistently should be killed, but the - * details are not specified.

    + * details are not specified. */ @Public @Evolving diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java index c6777db03ee..585faf86d5f 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueACL.java @@ -23,18 +23,15 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ApplicationClientProtocol; /** - *

    - * QueueACL enumerates the various ACLs for queues. - *

    - * + * {@code QueueACL} enumerates the various ACLs for queues. *

    * The ACL is one of: *

      - *
    • {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the - * queue.
      • - *
    • {@link #ADMINISTER_QUEUE} - ACL to administer the queue.
      • + *
    • + * {@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the queue. + *
      • + *
    • {@link #ADMINISTER_QUEUE} - ACL to administer the queue.
      • *
    - *

    * * @see QueueInfo * @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java index d762b41dfdf..bee5275a98a 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueInfo.java @@ -29,19 +29,18 @@ import org.apache.hadoop.yarn.api.ApplicationClientProtocol; import org.apache.hadoop.yarn.util.Records; /** - *

    QueueInfo is a report of the runtime information of the queue.

    - * - *

    It includes information such as: - *

      - *
    • Queue name.
      • - *
    • Capacity of the queue.
      • - *
    • Maximum capacity of the queue.
      • - *
    • Current capacity of the queue.
      • - *
    • Child queues.
      • - *
    • Running applications.
      • - *
    • {@link QueueState} of the queue.
      • - *
    - *

    + * QueueInfo is a report of the runtime information of the queue. + *

    + * It includes information such as: + *

      + *
    • Queue name.
      • + *
    • Capacity of the queue.
      • + *
    • Maximum capacity of the queue.
      • + *
    • Current capacity of the queue.
      • + *
    • Child queues.
      • + *
    • Running applications.
      • + *
    • {@link QueueState} of the queue.
      • + *
    * * @see QueueState * @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java index 01698de654f..2bc0407f440 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/QueueState.java @@ -23,14 +23,13 @@ import org.apache.hadoop.classification.InterfaceStability.Stable; import org.apache.hadoop.yarn.api.ApplicationClientProtocol; /** - *

    State of a Queue.

    - * - *

    A queue is in one of: - *

      - *
    • {@link #RUNNING} - normal state.
      • - *
    • {@link #STOPPED} - not accepting new application submissions. - *
    - *

    + * State of a Queue. + *

    + * A queue is in one of: + *

      + *
    • {@link #RUNNING} - normal state.
      • + *
    • {@link #STOPPED} - not accepting new application submissions.
      • + *
    * * @see QueueInfo * @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java index a4f05851026..4ebe1c29d76 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequest.java @@ -25,23 +25,18 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.yarn.util.Records; /** - *

    * {@link ReservationRequest} represents the request made by an application to * the {@code ResourceManager} to reserve {@link Resource}s. - *

    - * *

    * It includes: *

      - *
    • {@link Resource} required for each request.
      • - *
    • - * Number of containers, of above specifications, which are required by the - * application.
      • - *
    • - * Concurrency that indicates the gang size of the request.
      • + *
    • {@link Resource} required for each request.
      • + *
    • + * Number of containers, of above specifications, which are required by the + * application. + *
      • + *
    • Concurrency that indicates the gang size of the request.
      • *
    - *

    - * */ @Public @Unstable diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java index 1ee96c2d498..3b826263c77 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ReservationRequestInterpreter.java @@ -33,14 +33,13 @@ public enum ReservationRequestInterpreter { * Requires that exactly ONE among the {@link ReservationRequest} submitted as * of a {@link ReservationDefinition} is satisfied to satisfy the overall * {@link ReservationDefinition}. - * + *

    * WHEN TO USE THIS: This is useful when the user have multiple equivalent * ways to run an application, and wants to expose to the ReservationAgent - * such flexibility. For example an application could use one <32GB,16core> - * container for 10min, or 16 <2GB,1core> containers for 15min, the - * ReservationAgent will decide which one of the two it is best for the system - * to place. - * + * such flexibility. For example an application could use one + * {@literal <32GB,16core>} container for 10min, or 16 {@literal <2GB,1core>} + * containers for 15min, the ReservationAgent will decide which one of the + * two it is best for the system to place. */ R_ANY, @@ -49,16 +48,16 @@ public enum ReservationRequestInterpreter { * {@link ReservationDefinition} are satisfied for the overall * {@link ReservationDefinition} to be satisfied. No constraints are imposed * on the temporal ordering of the allocation used to satisfy the - * ResourceRequeusts. - * + * ResourceRequests. + *

    * WHEN TO USE THIS: This is useful to capture a scenario in which the user * cares for multiple ReservationDefinition to be all accepted, or none. For - * example, a user might want a reservation R1: with 10 x <8GB,4core> for - * 10min, and a reservation R2: with 2 <1GB,1core> for 1h, and only if both - * are satisfied the workflow run in this reservation succeeds. The key - * differentiator from ALL and ORDER, ORDER_NO_GAP, is that ALL imposes no - * restrictions on the relative allocations used to place R1 and R2 above. - * + * example, a user might want a reservation R1: with 10 x + * {@literal <8GB,4core>} for 10min, and a reservation R2: + * with 2 {@literal <1GB,1core>} for 1h, and only if both are satisfied + * the workflow run in this reservation succeeds. The key differentiator + * from ALL and ORDER, ORDER_NO_GAP, is that ALL imposes no restrictions + * on the relative allocations used to place R1 and R2 above. */ R_ALL, @@ -73,15 +72,16 @@ public enum ReservationRequestInterpreter { * constraints are imposed on temporal gaps between subsequent allocations * (the last instant of the previous allocation can be an arbitrary long * period of time before the first instant of the subsequent allocation). - * + *

    * WHEN TO USE THIS: Like ALL this requires all ReservationDefinitions to be * placed, but it also imposes a time ordering on the allocations used. This * is important if the ReservationDefinition(s) are used to describe a * workflow with inherent inter-stage dependencies. For example, a first job - * runs in a ReservaitonDefinition R1 (10 x <1GB,1core> for 20min), and its - * output is consumed by a second job described by a ReservationDefinition R2 - * (5 x <1GB,1core>) for 50min). R2 allocation cannot overlap R1, as R2 models - * a job depending on the output of the job modeled by R1. + * runs in a ReservaitonDefinition R1 (10 x {@literal <1GB,1core>} + * for 20min), and its output is consumed by a second job described by + * a ReservationDefinition R2 (5 x {@literal <1GB,1core>}) for 50min). + * R2 allocation cannot overlap R1, as R2 models a job depending on + * the output of the job modeled by R1. */ R_ORDER, diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java index 2f17ac96f5a..790120a0eb6 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/ResourceRequest.java @@ -27,31 +27,30 @@ import org.apache.hadoop.yarn.api.ApplicationMasterProtocol; import org.apache.hadoop.yarn.util.Records; /** - *

    ResourceRequest represents the request made by an - * application to the ResourceManager to obtain various - * Container allocations.

    - * - *

    It includes: - *

      - *
    • {@link Priority} of the request.
      • - *
    • - * The name of the machine or rack on which the allocation is - * desired. A special value of * signifies that - * any host/rack is acceptable to the application. - *
      • - *
    • {@link Resource} required for each request.
      • - *
    • - * Number of containers, of above specifications, which are required - * by the application. - *
      • - *
    • - * A boolean relaxLocality flag, defaulting to true, - * which tells the ResourceManager if the application wants - * locality to be loose (i.e. allows fall-through to rack or any) - * or strict (i.e. specify hard constraint on resource allocation). - *
      • - *
    - *

    + * {@code ResourceRequest} represents the request made + * by an application to the {@code ResourceManager} + * to obtain various {@code Container} allocations. + *

    + * It includes: + *

      + *
    • {@link Priority} of the request.
      • + *
    • + * The name of the machine or rack on which the allocation is + * desired. A special value of * signifies that + * any host/rack is acceptable to the application. + *
      • + *
    • {@link Resource} required for each request.
      • + *
    • + * Number of containers, of above specifications, which are required + * by the application. + *
      • + *
    • + * A boolean relaxLocality flag, defaulting to {@code true}, + * which tells the {@code ResourceManager} if the application wants + * locality to be loose (i.e. allows fall-through to rack or any) + * or strict (i.e. specify hard constraint on resource allocation). + *
      • + *
    * * @see Resource * @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest) @@ -267,7 +266,7 @@ public abstract class ResourceRequest implements Comparable { /** * Set node label expression of this resource request. Now only support * specifying a single node label. In the future we will support more complex - * node label expression specification like AND(&&), OR(||), etc. + * node label expression specification like {@code AND(&&), OR(||)}, etc. * * Any please note that node label expression now can only take effect when * the resource request has resourceName = ANY diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java index 262169e7d1f..f6ebb511e62 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/conf/YarnConfiguration.java @@ -733,8 +733,9 @@ public class YarnConfiguration extends Configuration { /** * How long to wait between aggregated log retention checks. If set to - * a value <= 0 then the value is computed as one-tenth of the log retention - * setting. Be careful set this too small and you will spam the name node. + * a value {@literal <=} 0 then the value is computed as one-tenth of the + * log retention setting. Be careful set this too small and you will spam + * the name node. */ public static final String LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS = YARN_PREFIX + "log-aggregation.retain-check-interval-seconds"; diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java index d1ab781cda8..d540ccebb46 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/UpdateNodeResourceRequest.java @@ -54,7 +54,7 @@ public abstract class UpdateNodeResourceRequest { /** * Get the map from NodeId to ResourceOption. - * @return the map of + * @return the map of {@code } */ @Public @Evolving @@ -62,7 +62,7 @@ public abstract class UpdateNodeResourceRequest { /** * Set the map from NodeId to ResourceOption. - * @param nodeResourceMap the map of + * @param nodeResourceMap the map of {@code } */ @Public @Evolving diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java index b3c5308240a..b590a51f108 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java @@ -56,28 +56,22 @@ public abstract class AHSClient extends AbstractService { } /** - *

    * Get a report of the given Application. - *

    - * *

    * In secure mode, YARN verifies access to the application, queue * etc. before accepting the request. - *

    - * *

    * If the user does not have VIEW_APP access then the following * fields in the report will be set to stubbed values: *

      - *
    • host - set to "N/A"
      • - *
    • RPC port - set to -1
      • - *
    • client token - set to "N/A"
      • - *
    • diagnostics - set to "N/A"
      • - *
    • tracking URL - set to "N/A"
      • - *
    • original tracking URL - set to "N/A"
      • - *
    • resource usage report - all values are -1
      • + *
    • host - set to "N/A"
      • + *
    • RPC port - set to -1
      • + *
    • client token - set to "N/A"
      • + *
    • diagnostics - set to "N/A"
      • + *
    • tracking URL - set to "N/A"
      • + *
    • original tracking URL - set to "N/A"
      • + *
    • resource usage report - all values are -1
      • *
    - *

    * * @param appId * {@link ApplicationId} of the application that needs a report @@ -121,7 +115,7 @@ public abstract class AHSClient extends AbstractService { * a report * @return application attempt report * @throws YarnException - * @throws {@link ApplicationAttemptNotFoundException} if application attempt + * @throws ApplicationAttemptNotFoundException if application attempt * not found * @throws IOException */ @@ -157,7 +151,7 @@ public abstract class AHSClient extends AbstractService { * {@link ContainerId} of the container that needs a report * @return container report * @throws YarnException - * @throws {@link ContainerNotFoundException} if container not found + * @throws ContainerNotFoundException if container not found * @throws IOException */ public abstract ContainerReport getContainerReport(ContainerId containerId) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AMRMClient.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AMRMClient.java index 99238063678..bfe10d60fd0 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AMRMClient.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AMRMClient.java @@ -349,7 +349,7 @@ public abstract class AMRMClient extends * Set the NM token cache for the AMRMClient. This cache must * be shared with the {@link NMClient} used to manage containers for the * AMRMClient - *

    + *

    * If a NM token cache is not set, the {@link NMTokenCache#getSingleton()} * singleton instance will be used. * @@ -363,7 +363,7 @@ public abstract class AMRMClient extends * Get the NM token cache of the AMRMClient. This cache must be * shared with the {@link NMClient} used to manage containers for the * AMRMClient. - *

    + *

    * If a NM token cache is not set, the {@link NMTokenCache#getSingleton()} * singleton instance will be used. * diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMClient.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMClient.java index 721728e06f0..08b911b1175 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMClient.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMClient.java @@ -125,7 +125,7 @@ public abstract class NMClient extends AbstractService { * Set the NM Token cache of the NMClient. This cache must be * shared with the {@link AMRMClient} that requested the containers managed * by this NMClient - *

    + *

    * If a NM token cache is not set, the {@link NMTokenCache#getSingleton()} * singleton instance will be used. * @@ -139,7 +139,7 @@ public abstract class NMClient extends AbstractService { * Get the NM token cache of the NMClient. This cache must be * shared with the {@link AMRMClient} that requested the containers managed * by this NMClient - *

    + *

    * If a NM token cache is not set, the {@link NMTokenCache#getSingleton()} * singleton instance will be used. * diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMTokenCache.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMTokenCache.java index 0e7356fe1f9..0c349cc429b 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMTokenCache.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/NMTokenCache.java @@ -34,26 +34,26 @@ import com.google.common.annotations.VisibleForTesting; /** * NMTokenCache manages NMTokens required for an Application Master * communicating with individual NodeManagers. - *

    + *

    * By default Yarn client libraries {@link AMRMClient} and {@link NMClient} use * {@link #getSingleton()} instance of the cache. *

      - *
    • Using the singleton instance of the cache is appropriate when running a - * single ApplicationMaster in the same JVM.
      • - *
    • When using the singleton, users don't need to do anything special, - * {@link AMRMClient} and {@link NMClient} are already set up to use the default - * singleton {@link NMTokenCache}
      • + *
    • + * Using the singleton instance of the cache is appropriate when running a + * single ApplicationMaster in the same JVM. + *
      • + *
    • + * When using the singleton, users don't need to do anything special, + * {@link AMRMClient} and {@link NMClient} are already set up to use the + * default singleton {@link NMTokenCache} + *
      • *
    - *

    * If running multiple Application Masters in the same JVM, a different cache * instance should be used for each Application Master. - *

    *

      - *
    • - * If using the {@link AMRMClient} and the {@link NMClient}, setting up and using - * an instance cache is as follows: - *

      - * + *

    • + * If using the {@link AMRMClient} and the {@link NMClient}, setting up + * and using an instance cache is as follows: * 
        *   NMTokenCache nmTokenCache = new NMTokenCache();
  *   AMRMClient rmClient = AMRMClient.createAMRMClient();
@@ -61,12 +61,10 @@ import com.google.common.annotations.VisibleForTesting;
  *   nmClient.setNMTokenCache(nmTokenCache);
  *   ...
  *
      - *
      • - *
    • - * If using the {@link AMRMClientAsync} and the {@link NMClientAsync}, setting up - * and using an instance cache is as follows: - *

      - * + *

      • + *
    • + * If using the {@link AMRMClientAsync} and the {@link NMClientAsync}, + * setting up and using an instance cache is as follows: * 
        *   NMTokenCache nmTokenCache = new NMTokenCache();
  *   AMRMClient rmClient = AMRMClient.createAMRMClient();
@@ -76,13 +74,11 @@ import com.google.common.annotations.VisibleForTesting;
  *   NMClientAsync nmClientAsync = new NMClientAsync("nmClient", nmClient, [NM_CALLBACK]);
  *   ...
  *
      - *
      • - *
    • - * If using {@link ApplicationMasterProtocol} and - * {@link ContainerManagementProtocol} directly, setting up and using an - * instance cache is as follows: - *

      - * + *

      • + *
    • + * If using {@link ApplicationMasterProtocol} and + * {@link ContainerManagementProtocol} directly, setting up and using an + * instance cache is as follows: * 
        *   NMTokenCache nmTokenCache = new NMTokenCache();
  *   ...
@@ -100,12 +96,12 @@ import com.google.common.annotations.VisibleForTesting;
  *   nmPro.startContainer(container, containerContext);
  *   ...
  *
      - *
      • + * *
    - * It is also possible to mix the usage of a client (AMRMClient or - * NMClient, or the async versions of them) with a protocol proxy ( - * ContainerManagementProtocolProxy or - * ApplicationMasterProtocol). + * It is also possible to mix the usage of a client ({@code AMRMClient} or + * {@code NMClient}, or the async versions of them) with a protocol proxy + * ({@code ContainerManagementProtocolProxy} or + * {@code ApplicationMasterProtocol}). */ @Public @Evolving diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java index d96761a9dd0..f61773110a3 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java @@ -32,14 +32,12 @@ import org.apache.hadoop.classification.InterfaceStability.Unstable; import org.apache.hadoop.io.Text; import org.apache.hadoop.service.AbstractService; import org.apache.hadoop.yarn.api.ApplicationClientProtocol; -import org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest; import org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest; import org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse; import org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest; import org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse; import org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest; import org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse; -import org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest; import org.apache.hadoop.yarn.api.records.ApplicationAttemptId; import org.apache.hadoop.yarn.api.records.ApplicationAttemptReport; import org.apache.hadoop.yarn.api.records.ApplicationId; @@ -58,8 +56,10 @@ import org.apache.hadoop.yarn.api.records.Token; import org.apache.hadoop.yarn.api.records.YarnApplicationState; import org.apache.hadoop.yarn.api.records.YarnClusterMetrics; import org.apache.hadoop.yarn.client.api.impl.YarnClientImpl; +import org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException; import org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException; import org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException; +import org.apache.hadoop.yarn.exceptions.ContainerNotFoundException; import org.apache.hadoop.yarn.exceptions.YarnException; import org.apache.hadoop.yarn.security.AMRMTokenIdentifier; @@ -171,7 +171,6 @@ public abstract class YarnClient extends AbstractService { *
  • original tracking URL - set to "N/A"
    • *
  • resource usage report - all values are -1
    • * - *

    * * @param appId * {@link ApplicationId} of the application that needs a report @@ -184,20 +183,20 @@ public abstract class YarnClient extends AbstractService { /** * Get the AMRM token of the application. - *

    + *

    * The AMRM token is required for AM to RM scheduling operations. For * managed Application Masters Yarn takes care of injecting it. For unmanaged * Applications Masters, the token must be obtained via this method and set * in the {@link org.apache.hadoop.security.UserGroupInformation} of the * current user. - *

    + *

    * The AMRM token will be returned only if all the following conditions are * met: - *

  • - *
      the requester is the owner of the ApplicationMaster
    - *
      the application master is an unmanaged ApplicationMaster
    - *
      the application master is in ACCEPTED state
    - *
    • + *
      + *
    • the requester is the owner of the ApplicationMaster
      • + *
    • the application master is an unmanaged ApplicationMaster
      • + *
    • the application master is in ACCEPTED state
      • + *
    * Else this method returns NULL. * * @param appId {@link ApplicationId} of the application to get the AMRM token @@ -415,7 +414,7 @@ public abstract class YarnClient extends AbstractService { * a report * @return application attempt report * @throws YarnException - * @throws {@link ApplicationAttemptNotFoundException} if application attempt + * @throws ApplicationAttemptNotFoundException if application attempt * not found * @throws IOException */ @@ -450,7 +449,7 @@ public abstract class YarnClient extends AbstractService { * {@link ContainerId} of the container that needs a report * @return container report * @throws YarnException - * @throws {@link ContainerNotFoundException} if container not found. + * @throws ContainerNotFoundException if container not found. * @throws IOException */ public abstract ContainerReport getContainerReport(ContainerId containerId) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/CommonNodeLabelsManager.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/CommonNodeLabelsManager.java index e2da664a182..67a5494c086 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/CommonNodeLabelsManager.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/CommonNodeLabelsManager.java @@ -344,7 +344,7 @@ public class CommonNodeLabelsManager extends AbstractService { /** * add more labels to nodes * - * @param addedLabelsToNode node -> labels map + * @param addedLabelsToNode node {@literal ->} labels map */ public void addLabelsToNode(Map> addedLabelsToNode) throws IOException { @@ -614,7 +614,7 @@ public class CommonNodeLabelsManager extends AbstractService { * remove labels from nodes, labels being removed most be contained by these * nodes * - * @param removeLabelsFromNode node -> labels map + * @param removeLabelsFromNode node {@literal ->} labels map */ public void removeLabelsFromNode(Map> removeLabelsFromNode) @@ -668,7 +668,7 @@ public class CommonNodeLabelsManager extends AbstractService { /** * replace labels to nodes * - * @param replaceLabelsToNode node -> labels map + * @param replaceLabelsToNode node {@literal ->} labels map */ public void replaceLabelsOnNode(Map> replaceLabelsToNode) throws IOException { diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/NodeLabelsStore.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/NodeLabelsStore.java index 857d81b115b..4a34a09e1af 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/NodeLabelsStore.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/nodelabels/NodeLabelsStore.java @@ -35,7 +35,7 @@ public abstract class NodeLabelsStore implements Closeable { } /** - * Store node -> label + * Store node {@literal ->} label */ public abstract void updateNodeToLabelsMappings( Map> nodeToLabels) throws IOException; @@ -54,7 +54,6 @@ public abstract class NodeLabelsStore implements Closeable { /** * Recover labels and node to labels mappings from store - * @param conf */ public abstract void recover() throws IOException; diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/server/security/ApplicationACLsManager.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/server/security/ApplicationACLsManager.java index 4cacfca8e2e..4daaa683122 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/server/security/ApplicationACLsManager.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/server/security/ApplicationACLsManager.java @@ -93,7 +93,6 @@ public class ApplicationACLsManager { * @param applicationAccessType * @param applicationOwner * @param applicationId - * @throws AccessControlException */ public boolean checkAccess(UserGroupInformation callerUGI, ApplicationAccessType applicationAccessType, String applicationOwner, diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/StringHelper.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/StringHelper.java index e6f23f0e523..3343a1713e6 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/StringHelper.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/util/StringHelper.java @@ -88,7 +88,7 @@ public final class StringHelper { } /** - * Join on slash & colon (e.g., path args in routing spec) + * Join on slash and colon (e.g., path args in routing spec) * @param args to join * @return args joined with /: */ @@ -116,7 +116,7 @@ public final class StringHelper { } /** - * Split on space & trim results. + * Split on space and trim results. * @param s the string to split * @return an iterable of strings */ @@ -125,7 +125,7 @@ public final class StringHelper { } /** - * Split on _ & trim results + * Split on _ and trim results * @param s the string to split * @return an iterable of strings */ diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/webapp/WebApps.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/webapp/WebApps.java index 1b5840f5db4..bda24aacbbe 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/webapp/WebApps.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-common/src/main/java/org/apache/hadoop/yarn/webapp/WebApps.java @@ -52,13 +52,13 @@ import com.google.inject.servlet.GuiceFilter; /** * Helpers to create an embedded webapp. * - *

    Quick start:

    + * Quick start: * 
      *   WebApp wa = WebApps.$for(myApp).start();
    * Starts a webapp with default routes binds to 0.0.0.0 (all network interfaces) * on an ephemeral port, which can be obtained with:
      *   int port = wa.port();
    - *

    With more options:

    + * With more options: * 
      *   WebApp wa = WebApps.$for(myApp).at(address, port).
  *                        with(configuration).
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/RegistryUtils.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/RegistryUtils.java
index 06a56d85d29..858b6b12357 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/RegistryUtils.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/binding/RegistryUtils.java
@@ -116,10 +116,10 @@ public class RegistryUtils {
   }
 
   /**
-   * Create a path to a service under a user & service class
+   * Create a path to a service under a user and service class
    * @param user username or ""
    * @param serviceClass service name
-   * @param serviceName service name unique for that user & service class
+   * @param serviceName service name unique for that user and service class
    * @return a full path
    */
   public static String servicePath(String user,
@@ -135,7 +135,7 @@ public class RegistryUtils {
    * Create a path for listing components under a service
    * @param user username or ""
    * @param serviceClass service name
-   * @param serviceName service name unique for that user & service class
+   * @param serviceName service name unique for that user and service class
    * @return a full path
    */
   public static String componentListPath(String user,
@@ -149,7 +149,7 @@ public class RegistryUtils {
    * Create the path to a service record for a component
    * @param user username or ""
    * @param serviceClass service name
-   * @param serviceName service name unique for that user & service class
+   * @param serviceName service name unique for that user and service class
    * @param componentName unique name/ID of the component
    * @return a full path
    */
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/RegistryOperationsClient.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/RegistryOperationsClient.java
index db039367867..44cefed06ac 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/RegistryOperationsClient.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/RegistryOperationsClient.java
@@ -32,7 +32,7 @@ import org.apache.hadoop.registry.client.impl.zk.RegistryOperationsService;
  *
  * For SASL, the client must be operating in the context of an authed user.
  *
- * For id:pass the client must have the relevant id & password, SASL is
+ * For id:pass the client must have the relevant id and password, SASL is
  * not used even if the client has credentials.
  *
  * For anonymous, nothing is used.
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/ZookeeperConfigOptions.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/ZookeeperConfigOptions.java
index d81f24b7d64..edcf0859fc3 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/ZookeeperConfigOptions.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/client/impl/zk/ZookeeperConfigOptions.java
@@ -71,14 +71,13 @@ public interface ZookeeperConfigOptions {
    * The SASL client username: {@value}.
    * 
    
    * Set this to the short name of the client, e.g, "user",
-   * not user/host, or user/host@REALM
+   * not {@code user/host}, or {@code user/host@REALM}
    */
   String PROP_ZK_SASL_CLIENT_USERNAME = "zookeeper.sasl.client.username";
 
   /**
    * The SASL Server context, referring to a context in the JVM's
    * JAAS context file: {@value}
-   * 
    
    */
   String PROP_ZK_SERVER_SASL_CONTEXT =
       ZooKeeperSaslServer.LOGIN_CONTEXT_NAME_KEY;
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/MicroZookeeperService.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/MicroZookeeperService.java
index 3fa0c1920dd..88e9d67b79d 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/MicroZookeeperService.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/MicroZookeeperService.java
@@ -47,16 +47,16 @@ import java.net.UnknownHostException;
 /**
  * This is a small, localhost Zookeeper service instance that is contained
  * in a YARN service...it's been derived from Apache Twill.
- *
+ * 
    
  * It implements {@link RegistryBindingSource} and provides binding information,
- * once started. Until start() is called, the hostname &
+ * once started. Until {@link #start()} is called, the hostname and
  * port may be undefined. Accordingly, the service raises an exception in this
  * condition.
- *
+ * 
    
  * If you wish to chain together a registry service with this one under
- * the same CompositeService, this service must be added
+ * the same {@code CompositeService}, this service must be added
  * as a child first.
- *
+ * 
    
  * It also sets the configuration parameter
  * {@link RegistryConstants#KEY_REGISTRY_ZK_QUORUM}
  * to its connection string. Any code with access to the service configuration
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/package-info.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/package-info.java
index 85d24b3a025..fe2a0a89f2c 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/package-info.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-registry/src/main/java/org/apache/hadoop/registry/server/services/package-info.java
@@ -19,9 +19,10 @@
 /**
  * Basic services for the YARN registry
  * 
      
- *   
    • The {@link org.apache.hadoop.registry.server.services.RegistryAdminService}
- *   extends the shared Yarn Registry client with registry setup and
- *   (potentially asynchronous) administrative actions.
+ *   
    • 
+ *     The {@link org.apache.hadoop.registry.server.services.RegistryAdminService}
+ *     extends the shared Yarn Registry client with registry setup and
+ *     (potentially asynchronous) administrative actions.
  *   
      • 
  *   
    • 
  *     The {@link org.apache.hadoop.registry.server.services.MicroZookeeperService}
@@ -33,8 +34,6 @@
  *     extends the standard YARN composite service by making its add and remove
  *     methods public. It is a utility service used in parts of the codebase
  *   
      • 
- *
  * 
    
- *
  */
 package org.apache.hadoop.registry.server.services;
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/timeline/security/TimelineAuthenticationFilterInitializer.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/timeline/security/TimelineAuthenticationFilterInitializer.java
index 39c10fb1fdf..1ee818145e6 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/timeline/security/TimelineAuthenticationFilterInitializer.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/timeline/security/TimelineAuthenticationFilterInitializer.java
@@ -45,17 +45,15 @@ import org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier;
 import com.google.common.annotations.VisibleForTesting;
 
 /**
- * 
    
  * Initializes {@link TimelineAuthenticationFilter} which provides support for
  * Kerberos HTTP SPNEGO authentication.
- * 
    
  * 
    
  * It enables Kerberos HTTP SPNEGO plus delegation token authentication for the
  * timeline server.
- * 
    
- * Refer to the core-default.xml file, after the comment 'HTTP
+ * 
    
+ * Refer to the {@code core-default.xml} file, after the comment 'HTTP
  * Authentication' for details on the configuration options. All related
- * configuration properties have 'hadoop.http.authentication.' as prefix.
+ * configuration properties have {@code hadoop.http.authentication.} as prefix.
  */
 public class TimelineAuthenticationFilterInitializer extends FilterInitializer {
 
@@ -71,14 +69,11 @@ public class TimelineAuthenticationFilterInitializer extends FilterInitializer {
   Map filterConfig;
 
   /**
-   * 
    
    * Initializes {@link TimelineAuthenticationFilter}
-   * 
    
    * 
    
    * Propagates to {@link TimelineAuthenticationFilter} configuration all YARN
    * configuration properties prefixed with
-   * "yarn.timeline-service.authentication."
-   * 
    
+   * {@code yarn.timeline-service.authentication.}
    * 
    * @param container
    *          The filter container
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/ZKClient.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/ZKClient.java
index e67530874f3..ba130c61ba0 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/ZKClient.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/ZKClient.java
@@ -40,7 +40,7 @@ public class ZKClient {
    * the zookeeper client library to 
    * talk to zookeeper 
    * @param string the host
-   * @throws throws IOException
+   * @throws IOException
    */
   public ZKClient(String string) throws IOException {
     zkClient = new ZooKeeper(string, 30000, new ZKWatcher());
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RegisterNodeManagerRequest.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RegisterNodeManagerRequest.java
index 0e3d7e4c9f3..366c32cefee 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RegisterNodeManagerRequest.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RegisterNodeManagerRequest.java
@@ -52,7 +52,8 @@ public abstract class RegisterNodeManagerRequest {
    * We introduce this here because currently YARN RM doesn't persist nodes info
    * for application running. When RM restart happened, we cannot determinate if
    * a node should do application cleanup (like log-aggregation, status update,
-   * etc.) or not. 
    
+   * etc.) or not.
+   * 
    
    * When we have this running application list in node manager register
    * request, we can recover nodes info for running applications. And then we
    * can take actions accordingly
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/records/NodeHealthStatus.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/records/NodeHealthStatus.java
index bc5825a9b95..b21b88071f5 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/records/NodeHealthStatus.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/records/NodeHealthStatus.java
@@ -26,19 +26,17 @@ import org.apache.hadoop.yarn.api.records.NodeReport;
 import org.apache.hadoop.yarn.util.Records;
 
 /**
- * 
    NodeHealthStatus is a summary of the health status of the
- * node.
    
- *
- * 
    It includes information such as:
- *   
      
- *     
    • 
- *       An indicator of whether the node is healthy, as determined by the 
- *       health-check script.
- *     
      • 
- *     
    • The previous time at which the health status was reported.
      • 
- *     
    • A diagnostic report on the health status.
      • 
- *   
    
- * 
    
+ * {@code NodeHealthStatus} is a summary of the health status of the node.
+ * 
    
+ * It includes information such as:
+ * 
      
+ *   
    • 
+ *     An indicator of whether the node is healthy, as determined by the
+ *     health-check script.
+ *   
      • 
+ *   
    • The previous time at which the health status was reported.
      • 
+ *   
    • A diagnostic report on the health status.
      • 
+ * 
    
  * 
  * @see NodeReport
  * @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)
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 248a393719c..377fd1d2d17 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
@@ -102,13 +102,15 @@ public abstract class ContainerExecutor implements Configurable {
   
   /**
    * Prepare the environment for containers in this application to execute.
+   * 
        * For $x in local.dirs
    *   create $x/$user/$appId
-   * Copy $nmLocal/appTokens -> $N/$user/$appId
+   * Copy $nmLocal/appTokens {@literal ->} $N/$user/$appId
    * For $rsrc in private resources
-   *   Copy $rsrc -> $N/$user/filecache/[idef]
+   *   Copy $rsrc {@literal ->} $N/$user/filecache/[idef]
    * For $rsrc in job resources
-   *   Copy $rsrc -> $N/$user/$appId/filecache/idef
+   *   Copy $rsrc {@literal ->} $N/$user/$appId/filecache/idef
+   * 
    
    * @param user user name of application owner
    * @param appId id of the application
    * @param nmPrivateContainerTokens path to localized credentials, rsrc by NM
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.java
index 431cf5d14cc..77db1e32621 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.java
@@ -65,11 +65,11 @@ public class NodeManagerHardwareUtils {
   }
 
   /**
-   * Gets the percentage of physical CPU that is configured for YARN containers
-   * This is percent > 0 and <= 100  based on
-   * YarnConfiguration.NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT
+   * Gets the percentage of physical CPU that is configured for YARN containers.
+   * This is percent {@literal >} 0 and {@literal <=} 100 based on
+   * {@link YarnConfiguration#NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT}
    * @param conf Configuration object
-   * @return percent > 0 and <= 100
+   * @return percent {@literal >} 0 and {@literal <=} 100
    */
   public static int getNodeCpuPercentage(Configuration conf) {
     int nodeCpuPercentage =
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.java
index cf8c2bbc865..b85174efcf6 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.java
@@ -216,11 +216,14 @@ public interface RMAppAttempt extends EventHandler {
   /**
    * Return the flag which indicates whether the attempt failure should be
    * counted to attempt retry count.
-   * 
      
+   * 
      
    * There failure types should not be counted to attempt retry count:
-   * 
    • preempted by the scheduler.
      • 
-   * 
    • hardware failures, such as NM failing, lost NM and NM disk errors.
      • 
-   * 
    • killed by RM because of RM restart or failover.
      • 
+   * 
        
+   *   
      • preempted by the scheduler.
        • 
+   *   
      • 
+   *     hardware failures, such as NM failing, lost NM and NM disk errors.
+   *   
        • 
+   *   
      • killed by RM because of RM restart or failover.
        • 
    * 
      
    */
   boolean shouldCountTowardsMaxAttemptRetry();
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.java
index 957e8f650a4..29011345dfc 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.java
@@ -114,7 +114,7 @@ public abstract class SchedulerNode {
 
   /**
    * Get the name of the node for scheduling matching decisions.
-   * 
      
+   * 
      
    * Typically this is the 'hostname' reported by the node, but it could be
    * configured to be 'hostname:port' reported by the node via the
    * {@link YarnConfiguration#RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME} constant.
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerUtils.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerUtils.java
index 65d68598aea..248cc08b748 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerUtils.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerUtils.java
@@ -194,8 +194,7 @@ public class SchedulerUtils {
    * Utility method to validate a resource request, by insuring that the
    * requested memory/vcore is non-negative and not greater than max
    * 
-   * @throws InvalidResourceRequestException when there is invalid
-   *         request
+   * @throws InvalidResourceRequestException when there is invalid request
    */
   public static void validateResourceRequest(ResourceRequest resReq,
       Resource maximumResource, String queueName, YarnScheduler scheduler)
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/policies/ComputeFairShares.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/policies/ComputeFairShares.java
index 3bea985edbe..f4fad32db5b 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/policies/ComputeFairShares.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/policies/ComputeFairShares.java
@@ -71,7 +71,7 @@ public class ComputeFairShares {
    * fair shares. The min and max shares and of the Schedulables are assumed to
    * be set beforehand. We compute the fairest possible allocation of shares to
    * the Schedulables that respects their min and max shares.
-   * 
+   * 
      
    * To understand what this method does, we must first define what weighted
    * fair sharing means in the presence of min and max shares. If there
    * were no minimum or maximum shares, then weighted fair sharing would be
@@ -79,30 +79,31 @@ public class ComputeFairShares {
    * Schedulable and all slots were assigned. Minimum and maximum shares add a
    * further twist - Some Schedulables may have a min share higher than their
    * assigned share or a max share lower than their assigned share.
-   * 
+   * 
      
    * To deal with these possibilities, we define an assignment of slots as being
    * fair if there exists a ratio R such that: Schedulables S where S.minShare
-   * > R * S.weight are given share S.minShare - Schedulables S where S.maxShare
-   * < R * S.weight are given S.maxShare - All other Schedulables S are
-   * assigned share R * S.weight - The sum of all the shares is totalSlots.
-   * 
+   * {@literal >} R * S.weight are given share S.minShare - Schedulables S
+   * where S.maxShare {@literal <} R * S.weight are given S.maxShare -
+   * All other Schedulables S are assigned share R * S.weight -
+   * The sum of all the shares is totalSlots.
+   * 
      
    * We call R the weight-to-slots ratio because it converts a Schedulable's
    * weight to the number of slots it is assigned.
-   * 
+   * 
      
    * We compute a fair allocation by finding a suitable weight-to-slot ratio R.
    * To do this, we use binary search. Given a ratio R, we compute the number of
    * slots that would be used in total with this ratio (the sum of the shares
    * computed using the conditions above). If this number of slots is less than
    * totalSlots, then R is too small and more slots could be assigned. If the
    * number of slots is more than totalSlots, then R is too large.
-   * 
+   * 
      
    * We begin the binary search with a lower bound on R of 0 (which means that
    * all Schedulables are only given their minShare) and an upper bound computed
    * to be large enough that too many slots are given (by doubling R until we
    * use more than totalResources resources). The helper method
    * resourceUsedWithWeightToResourceRatio computes the total resources used with a
    * given value of R.
-   * 
+   * 
      
    * The running time of this algorithm is linear in the number of Schedulables,
    * because resourceUsedWithWeightToResourceRatio is linear-time and the number of
    * iterations of binary search is a constant (dependent on desired precision).
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/security/DelegationTokenRenewer.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/security/DelegationTokenRenewer.java
index dfcceb86122..cb456d87940 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/security/DelegationTokenRenewer.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/security/DelegationTokenRenewer.java
@@ -364,7 +364,6 @@ public class DelegationTokenRenewer extends AbstractService {
    * @param shouldCancelAtEnd true if tokens should be canceled when the app is
    * done else false. 
    * @param user user
-   * @throws IOException
    */
   public void addApplicationAsync(ApplicationId applicationId, Credentials ts,
       boolean shouldCancelAtEnd, String user) {
@@ -634,7 +633,6 @@ public class DelegationTokenRenewer extends AbstractService {
   
   /**
    * removing failed DT
-   * @param applicationId
    */
   private void removeFailedDelegationToken(DelegationTokenToRenew t) {
     ApplicationId applicationId = t.applicationId;
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-web-proxy/src/main/java/org/apache/hadoop/yarn/server/webproxy/ProxyUriUtils.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-web-proxy/src/main/java/org/apache/hadoop/yarn/server/webproxy/ProxyUriUtils.java
index d678edf9b9d..e130225c892 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-web-proxy/src/main/java/org/apache/hadoop/yarn/server/webproxy/ProxyUriUtils.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-web-proxy/src/main/java/org/apache/hadoop/yarn/server/webproxy/ProxyUriUtils.java
@@ -181,7 +181,7 @@ public class ProxyUriUtils {
   
   /**
    * Returns the scheme if present in the url
-   * eg. "https://issues.apache.org/jira/browse/YARN" > "https"
+   * eg. "https://issues.apache.org/jira/browse/YARN" {@literal ->} "https"
    */
   public static String getSchemeFromUrl(String url) {
     int index = 0;