This is an automated email from the ASF dual-hosted git repository.
inigoiri pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/hadoop.git
The following commit(s) were added to refs/heads/trunk by this push:
new a71aaef9a9a YARN-11385. Fix hadoop-yarn-server-common module Java Doc
Errors. (#5182)
a71aaef9a9a is described below
commit a71aaef9a9a1564113331054903e4d7b6e182f17
Author: slfan1989 <55643692+slfan1...@users.noreply.github.com>
AuthorDate: Sun Dec 11 07:03:49 2022 +0800
YARN-11385. Fix hadoop-yarn-server-common module Java Doc Errors. (#5182)
---
.../java/org/apache/hadoop/yarn/lib/ZKClient.java | 36 ++++++++++++----------
.../org/apache/hadoop/yarn/lib/package-info.java | 8 +++--
.../yarn/server/AMHeartbeatRequestHandler.java | 1 +
.../yarn/server/api/SCMUploaderProtocol.java | 8 ++---
.../hadoop/yarn/server/api/ServerRMProxy.java | 2 +-
.../api/protocolrecords/NMContainerStatus.java | 9 ++++--
.../server/api/protocolrecords/RemoteNode.java | 2 +-
.../LocalityMulticastAMRMProxyPolicy.java | 4 +++
.../federation/utils/FederationRegistryClient.java | 1 +
.../yarn/server/scheduler/ResourceRequestSet.java | 6 ++--
.../server/security/BaseNMTokenSecretManager.java | 5 +++
.../hadoop/yarn/server/service/package-info.java | 9 +++---
.../server/timeline/security/package-info.java | 4 +--
.../yarn/server/util/timeline/package-info.java | 4 +--
.../hadoop/yarn/server/utils/LeveldbIterator.java | 22 +++++++++++--
.../yarn/server/utils/YarnServerSecurityUtils.java | 6 ++--
.../yarn/server/volume/csi/package-info.java | 9 +++---
.../hadoop/yarn/server/webapp/LogServlet.java | 3 ++
.../hadoop/yarn/server/webapp/LogWebService.java | 6 ++++
.../yarn/server/webapp/WrappedLogMetaRequest.java | 1 +
20 files changed, 97 insertions(+), 49 deletions(-)
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 ba130c61ba0..21cbe20ab48 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,18 +40,19 @@ public class ZKClient {
* the zookeeper client library to
* talk to zookeeper
* @param string the host
- * @throws IOException
+ * @throws IOException if there are I/O errors.
*/
public ZKClient(String string) throws IOException {
zkClient = new ZooKeeper(string, 30000, new ZKWatcher());
}
/**
- * register the service to a specific path
+ * register the service to a specific path.
+ *
* @param path the path in zookeeper namespace to register to
* @param data the data that is part of this registration
- * @throws IOException
- * @throws InterruptedException
+ * @throws IOException if there are I/O errors.
+ * @throws InterruptedException if any thread has interrupted.
*/
public void registerService(String path, String data) throws
IOException, InterruptedException {
@@ -64,13 +65,14 @@ public class ZKClient {
}
/**
- * unregister the service.
+ * unregister the service.
+ *
* @param path the path at which the service was registered
- * @throws IOException
- * @throws InterruptedException
+ * @throws IOException if there are I/O errors.
+ * @throws InterruptedException if any thread has interrupted.
*/
public void unregisterService(String path) throws IOException,
- InterruptedException {
+ InterruptedException {
try {
zkClient.delete(path, -1);
} catch(KeeperException ke) {
@@ -79,15 +81,16 @@ public class ZKClient {
}
/**
- * list the services registered under a path
+ * list the services registered under a path.
+ *
* @param path the path under which services are
* registered
* @return the list of names of services registered
- * @throws IOException
- * @throws InterruptedException
+ * @throws IOException if there are I/O errors.
+ * @throws InterruptedException if any thread has interrupted.
*/
public List<String> listServices(String path) throws IOException,
- InterruptedException {
+ InterruptedException {
List<String> children = null;
try {
children = zkClient.getChildren(path, false);
@@ -98,14 +101,15 @@ public class ZKClient {
}
/**
- * get data published by the service at the registration address
+ * get data published by the service at the registration address.
+ *
* @param path the path where the service is registered
* @return the data of the registered service
- * @throws IOException
- * @throws InterruptedException
+ * @throws IOException if there are I/O errors.
+ * @throws InterruptedException if any thread has interrupted.
*/
public String getServiceData(String path) throws IOException,
- InterruptedException {
+ InterruptedException {
String data;
try {
Stat stat = new Stat();
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/package-info.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/package-info.java
index d4fa452c3ae..ba287fdfe43 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/package-info.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/lib/package-info.java
@@ -15,7 +15,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-@InterfaceAudience.Private
+
+/**
+ * This package contains zkClient related classes.
+ */
+@Private
package org.apache.hadoop.yarn.lib;
-import org.apache.hadoop.classification.InterfaceAudience;
+import org.apache.hadoop.classification.InterfaceAudience.Private;
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/AMHeartbeatRequestHandler.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/AMHeartbeatRequestHandler.java
index 9a73fb308ce..cb59d41505d 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/AMHeartbeatRequestHandler.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/AMHeartbeatRequestHandler.java
@@ -153,6 +153,7 @@ public class AMHeartbeatRequestHandler extends Thread {
/**
* Set the UGI for RM connection.
+ * @param ugi UserGroupInformation.
*/
public void setUGI(UserGroupInformation ugi) {
this.userUgi = ugi;
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/SCMUploaderProtocol.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/SCMUploaderProtocol.java
index 937f648510c..b73a02af6c5 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/SCMUploaderProtocol.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/SCMUploaderProtocol.java
@@ -53,8 +53,8 @@ public interface SCMUploaderProtocol {
* to the shared cache
* @return response indicating if the newly uploaded resource should be
* deleted
- * @throws YarnException
- * @throws IOException
+ * @throws YarnException exceptions from yarn servers.
+ * @throws IOException if there are I/O errors.
*/
public SCMUploaderNotifyResponse
notify(SCMUploaderNotifyRequest request)
@@ -73,8 +73,8 @@ public interface SCMUploaderProtocol {
*
* @param request whether the resource can be uploaded to the shared cache
* @return response indicating if resource can be uploaded to the shared
cache
- * @throws YarnException
- * @throws IOException
+ * @throws YarnException exceptions from yarn servers.
+ * @throws IOException if there are I/O errors.
*/
public SCMUploaderCanUploadResponse
canUpload(SCMUploaderCanUploadRequest request)
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ServerRMProxy.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ServerRMProxy.java
index 50eed3a75d5..fa7e390a947 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ServerRMProxy.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ServerRMProxy.java
@@ -49,7 +49,7 @@ public class ServerRMProxy<T> extends RMProxy<T> {
* @param protocol Server protocol for which proxy is being requested.
* @param <T> Type of proxy.
* @return Proxy to the ResourceManager for the specified server protocol.
- * @throws IOException
+ * @throws IOException if there are I/O errors.
*/
public static <T> T createRMProxy(final Configuration configuration,
final Class<T> protocol) throws IOException {
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/NMContainerStatus.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/NMContainerStatus.java
index 065918d5eb9..6027ce7452e 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/NMContainerStatus.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/NMContainerStatus.java
@@ -120,14 +120,18 @@ public abstract class NMContainerStatus {
public abstract void setPriority(Priority priority);
/**
- * Get the time when the container is created
+ * Get the time when the container is created.
+ *
+ * @return CreationTime.
*/
public abstract long getCreationTime();
public abstract void setCreationTime(long creationTime);
/**
- * Get the node-label-expression in the original ResourceRequest
+ * Get the node-label-expression in the original ResourceRequest.
+ *
+ * @return NodeLabelExpression.
*/
public abstract String getNodeLabelExpression();
@@ -167,6 +171,7 @@ public abstract class NMContainerStatus {
/**
* Get and set the Allocation tags associated with the container.
+ * @return Allocation tags.
*/
public Set<String> getAllocationTags() {
return Collections.emptySet();
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/RemoteNode.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RemoteNode.java
index 67ad5bac294..72dcb6e9914 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RemoteNode.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/RemoteNode.java
@@ -148,7 +148,7 @@ public abstract class RemoteNode implements
Comparable<RemoteNode> {
/**
* Set Node Partition.
- * @param nodePartition
+ * @param nodePartition node Partition.
*/
@Private
@Unstable
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/policies/amrmproxy/LocalityMulticastAMRMProxyPolicy.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/policies/amrmproxy/LocalityMulticastAMRMProxyPolicy.java
index c8f945896e4..17cc8390a11 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/policies/amrmproxy/LocalityMulticastAMRMProxyPolicy.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/policies/amrmproxy/LocalityMulticastAMRMProxyPolicy.java
@@ -290,6 +290,10 @@ public class LocalityMulticastAMRMProxyPolicy extends
AbstractAMRMProxyPolicy {
/**
* For unit test to override.
+ *
+ * @param bookKeeper bookKeeper
+ * @param allocationId allocationId.
+ * @return SubClusterId.
*/
protected SubClusterId getSubClusterForUnResolvedRequest(
AllocationBookkeeper bookKeeper, long allocationId) {
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/utils/FederationRegistryClient.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/utils/FederationRegistryClient.java
index 1eb120c4554..fa64188a608 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/utils/FederationRegistryClient.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/utils/FederationRegistryClient.java
@@ -111,6 +111,7 @@ public class FederationRegistryClient {
/**
* Write/update the UAM token for an application and a sub-cluster.
*
+ * @param appId ApplicationId.
* @param subClusterId sub-cluster id of the token
* @param token the UAM of the application
* @return whether the amrmToken is added or updated to a new value
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/scheduler/ResourceRequestSet.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/scheduler/ResourceRequestSet.java
index cf24bbf361f..ed615e85c9c 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/scheduler/ResourceRequestSet.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/scheduler/ResourceRequestSet.java
@@ -71,7 +71,7 @@ public class ResourceRequestSet {
* with the same resource name, override it and update accordingly.
*
* @param ask the new {@link ResourceRequest}
- * @throws YarnException
+ * @throws YarnException indicates exceptions from yarn servers.
*/
public void addAndOverrideRR(ResourceRequest ask) throws YarnException {
if (!this.key.equals(new ResourceRequestSetKey(ask))) {
@@ -102,7 +102,7 @@ public class ResourceRequestSet {
* Merge a requestSet into this one.
*
* @param requestSet the requestSet to merge
- * @throws YarnException
+ * @throws YarnException indicates exceptions from yarn servers.
*/
public void addAndOverrideRRSet(ResourceRequestSet requestSet)
throws YarnException {
@@ -149,7 +149,7 @@ public class ResourceRequestSet {
* Force set the # of containers to ask for this requestSet to a given value.
*
* @param newValue the new # of containers value
- * @throws YarnException
+ * @throws YarnException indicates exceptions from yarn servers.
*/
public void setNumContainers(int newValue) throws YarnException {
if (this.numContainers == 0) {
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/security/BaseNMTokenSecretManager.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/security/BaseNMTokenSecretManager.java
index 3cbd1dc36dc..b8b5073119c 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/security/BaseNMTokenSecretManager.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/security/BaseNMTokenSecretManager.java
@@ -111,6 +111,11 @@ public class BaseNMTokenSecretManager extends
/**
* Helper function for creating NMTokens.
+ *
+ * @param applicationAttemptId application AttemptId.
+ * @param nodeId node Id.
+ * @param applicationSubmitter application Submitter.
+ * @return NMToken.
*/
public Token createNMToken(ApplicationAttemptId applicationAttemptId,
NodeId nodeId, String applicationSubmitter) {
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/service/package-info.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/service/package-info.java
index c448bab134d..c27269820ed 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/service/package-info.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/service/package-info.java
@@ -19,9 +19,8 @@
* Package org.apache.hadoop.yarn.server.service contains service related
* classes.
*/
-@InterfaceAudience.Private @InterfaceStability.Unstable
-
+@Private
+@Unstable
package org.apache.hadoop.yarn.server.service;
-
-import org.apache.hadoop.classification.InterfaceAudience;
-import org.apache.hadoop.classification.InterfaceStability;
\ No newline at end of file
+import org.apache.hadoop.classification.InterfaceAudience.Private;
+import org.apache.hadoop.classification.InterfaceStability.Unstable;
\ No newline at end of file
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/timeline/security/package-info.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/timeline/security/package-info.java
index 14a52e342b3..76ea2064b2b 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/timeline/security/package-info.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/timeline/security/package-info.java
@@ -21,6 +21,6 @@
* to timeline authentication filters and abstract delegation token service for
* ATSv1 and ATSv2.
*/
-@InterfaceAudience.Private
+@Private
package org.apache.hadoop.yarn.server.timeline.security;
-import org.apache.hadoop.classification.InterfaceAudience;
+import org.apache.hadoop.classification.InterfaceAudience.Private;
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/util/timeline/package-info.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/util/timeline/package-info.java
index 75c69738c50..0c61b6246cc 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/util/timeline/package-info.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/util/timeline/package-info.java
@@ -20,6 +20,6 @@
* Package org.apache.hadoop.server.util.timeline contains utility classes used
* by ATSv1 and ATSv2 on the server side.
*/
-@InterfaceAudience.Private
+@Private
package org.apache.hadoop.yarn.server.util.timeline;
-import org.apache.hadoop.classification.InterfaceAudience;
\ No newline at end of file
+import org.apache.hadoop.classification.InterfaceAudience.Private;
\ No newline at end of file
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/LeveldbIterator.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/LeveldbIterator.java
index f33cb5f1d89..463bee7ebab 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/LeveldbIterator.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/LeveldbIterator.java
@@ -41,21 +41,28 @@ public class LeveldbIterator implements
Iterator<Map.Entry<byte[], byte[]>>,
private DBIterator iter;
/**
- * Create an iterator for the specified database
+ * Create an iterator for the specified database.
+ *
+ * @param db database.
*/
public LeveldbIterator(DB db) {
iter = db.iterator();
}
/**
- * Create an iterator for the specified database
+ * Create an iterator for the specified database.
+ *
+ * @param db db.
+ * @param options ReadOptions.
*/
public LeveldbIterator(DB db, ReadOptions options) {
iter = db.iterator(options);
}
/**
- * Create an iterator using the specified underlying DBIterator
+ * Create an iterator using the specified underlying DBIterator.
+ *
+ * @param iter DB Iterator.
*/
public LeveldbIterator(DBIterator iter) {
this.iter = iter;
@@ -64,6 +71,9 @@ public class LeveldbIterator implements
Iterator<Map.Entry<byte[], byte[]>>,
/**
* Repositions the iterator so the key of the next BlockElement
* returned greater than or equal to the specified targetKey.
+ *
+ * @param key key of the next BlockElement.
+ * @throws DBException db Exception.
*/
public void seek(byte[] key) throws DBException {
try {
@@ -116,6 +126,9 @@ public class LeveldbIterator implements
Iterator<Map.Entry<byte[], byte[]>>,
/**
* Returns the next element in the iteration.
+ *
+ * @return the next element in the iteration.
+ * @throws DBException DB Exception.
*/
@Override
public Map.Entry<byte[], byte[]> next() throws DBException {
@@ -131,6 +144,9 @@ public class LeveldbIterator implements
Iterator<Map.Entry<byte[], byte[]>>,
/**
* Returns the next element in the iteration, without advancing the
* iteration.
+ *
+ * @return the next element in the iteration.
+ * @throws DBException db Exception.
*/
public Map.Entry<byte[], byte[]> peekNext() throws DBException {
try {
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/YarnServerSecurityUtils.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/YarnServerSecurityUtils.java
index c5ae56f3d10..4ad6a94ab11 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/YarnServerSecurityUtils.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/utils/YarnServerSecurityUtils.java
@@ -56,7 +56,7 @@ public final class YarnServerSecurityUtils {
* current application.
*
* @return the AMRMTokenIdentifier instance for the current user
- * @throws YarnException
+ * @throws YarnException exceptions from yarn servers.
*/
public static AMRMTokenIdentifier authorizeRequest() throws YarnException {
@@ -137,9 +137,9 @@ public final class YarnServerSecurityUtils {
* Parses the container launch context and returns a Credential instance that
* contains all the tokens from the launch context.
*
- * @param launchContext
+ * @param launchContext ContainerLaunchContext.
* @return the credential instance
- * @throws IOException
+ * @throws IOException if there are I/O errors.
*/
public static Credentials parseCredentials(
ContainerLaunchContext launchContext) throws IOException {
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/volume/csi/package-info.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/volume/csi/package-info.java
index ef4ffef5646..64b42c7c435 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/volume/csi/package-info.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/volume/csi/package-info.java
@@ -19,9 +19,8 @@
/**
* This package contains common volume related classes.
*/
-@InterfaceAudience.Private
-@InterfaceStability.Unstable
+@Private
+@Unstable
package org.apache.hadoop.yarn.server.volume.csi;
-
-import org.apache.hadoop.classification.InterfaceAudience;
-import org.apache.hadoop.classification.InterfaceStability;
\ No newline at end of file
+import org.apache.hadoop.classification.InterfaceAudience.Private;
+import org.apache.hadoop.classification.InterfaceStability.Unstable;
\ No newline at end of file
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogServlet.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogServlet.java
index 86b8d55adc6..16fac7ac439 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogServlet.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogServlet.java
@@ -187,7 +187,10 @@ public class LogServlet extends Configured {
* Returns the user qualified path name of the remote log directory for
* each pre-configured log aggregation file controller.
*
+ * @param user remoteUser.
+ * @param applicationId applicationId.
* @return {@link Response} object containing remote log dir path names
+ * @throws IOException if there are I/O errors.
*/
public Response getRemoteLogDirPath(String user, String applicationId)
throws IOException {
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogWebService.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogWebService.java
index 1edfd5287ac..565d4fd8c9e 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogWebService.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/LogWebService.java
@@ -138,6 +138,9 @@ public class LogWebService implements AppInfoProvider {
* @param containerIdStr The container ID
* @param nmId The Node Manager NodeId
* @param redirectedFromNode Whether this is a redirected request from NM
+ * @param clusterId clusterId the id of the cluster
+ * @param manualRedirection whether to return a response with a Location
+ * instead of an automatic redirection
* @return The log file's name and current file size
*/
@GET
@@ -242,6 +245,9 @@ public class LogWebService implements AppInfoProvider {
* @param size the size of the log file
* @param nmId The Node Manager NodeId
* @param redirectedFromNode Whether this is the redirect request from NM
+ * @param clusterId the id of the cluster
+ * @param manualRedirection whether to return a response with a Location
+ * instead of an automatic redirection
* @return The contents of the container's log file
*/
@GET
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/WrappedLogMetaRequest.java
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/WrappedLogMetaRequest.java
index d39eef8cee4..59a88c26186 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/WrappedLogMetaRequest.java
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/WrappedLogMetaRequest.java
@@ -155,6 +155,7 @@ public class WrappedLogMetaRequest {
*
* @return list of {@link ContainerLogMeta} objects that belong
* to the application, attempt or container
+ * @throws IOException if there are I/O errors.
*/
public List<ContainerLogMeta> getContainerLogMetas() throws IOException {
ApplicationId applicationId = ApplicationId.fromString(getAppId());
---------------------------------------------------------------------
To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-commits-h...@hadoop.apache.org
