This is an automated email from the ASF dual-hosted git repository.
elek pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new 656339e HDDS-5204. Missing type-level Javadoc comments (#2262)
656339e is described below
commit 656339e6ad286fd816f330d892ce29ff26ef1b75
Author: Doroszlai, Attila <[email protected]>
AuthorDate: Wed Jun 2 15:20:01 2021 +0200
HDDS-5204. Missing type-level Javadoc comments (#2262)
---
.../hadoop/hdds/scm/ha/RetriableWithNoFailoverException.java | 4 ++++
.../org/apache/hadoop/hdds/scm/utils/ClientCommandsUtils.java | 3 +++
.../apache/hadoop/ozone/common/ChecksumByteBufferFactory.java | 3 +++
.../org/apache/hadoop/ozone/common/ChecksumByteBufferImpl.java | 5 ++++-
.../java/org/apache/hadoop/ozone/common/utils/BufferUtils.java | 3 +++
.../src/main/java/org/apache/hadoop/ozone/ha/ConfUtils.java | 3 +++
.../java/org/apache/hadoop/hdds/scm/ha/TestSCMNodeInfo.java | 3 +++
.../ozone/common/TestChecksumImplsComputeSameValues.java | 4 ++++
.../keyvalue/statemachine/background/BlockDeletingService.java | 3 +++
.../hadoop/ozone/container/replication/ReplicationServer.java | 3 +++
.../ozone/container/replication/ReplicationSupervisor.java | 3 +++
.../ozone/container/common/TestBlockDeletingService.java | 3 +++
.../container/replication/TestSimpleContainerDownloader.java | 4 ++--
hadoop-hdds/dev-support/checkstyle/checkstyle.xml | 2 ++
.../src/main/java/org/apache/hadoop/hdds/NodeDetails.java | 5 ++++-
.../java/org/apache/hadoop/hdds/utils/db/cache/TableCache.java | 3 +++
.../hadoop/hdds/scm/block/DeletedBlockLogStateManager.java | 3 +++
.../hadoop/hdds/scm/block/DeletedBlockLogStateManagerImpl.java | 3 +++
.../hadoop/hdds/scm/container/balancer/ContainerBalancer.java | 4 ++++
.../hdds/scm/container/balancer/ContainerBalancerMetrics.java | 3 +++
.../java/org/apache/hadoop/hdds/scm/ha/HASecurityUtils.java | 5 ++++-
.../hadoop/hdds/scm/ha/MockSCMHADBTransactionBuffer.java | 4 ++++
.../main/java/org/apache/hadoop/hdds/scm/ha/SCMContext.java | 3 +++
.../org/apache/hadoop/hdds/scm/ha/SCMDBCheckpointProvider.java | 4 +++-
.../java/org/apache/hadoop/hdds/scm/ha/SCMHANodeDetails.java | 3 +++
.../java/org/apache/hadoop/hdds/scm/ha/io/BooleanCodec.java | 3 +++
.../src/main/java/org/apache/hadoop/hdds/scm/ha/io/Codec.java | 3 +++
.../java/org/apache/hadoop/hdds/scm/ha/io/CodecFactory.java | 3 +++
.../main/java/org/apache/hadoop/hdds/scm/ha/io/EnumCodec.java | 3 +++
.../apache/hadoop/hdds/scm/ha/io/GeneratedMessageCodec.java | 3 +++
.../main/java/org/apache/hadoop/hdds/scm/ha/io/ListCodec.java | 3 +++
.../main/java/org/apache/hadoop/hdds/scm/ha/io/LongCodec.java | 3 +++
.../java/org/apache/hadoop/hdds/scm/ha/io/StringCodec.java | 3 +++
.../org/apache/hadoop/hdds/scm/node/DatanodeUsageInfo.java | 3 +++
.../java/org/apache/hadoop/hdds/scm/server/SCMCertStore.java | 3 +++
.../hdds/scm/container/balancer/TestContainerBalancer.java | 3 +++
.../org/apache/hadoop/hdds/scm/ha/TestSCMHAConfiguration.java | 3 +++
.../org/apache/hadoop/hdds/scm/ha/TestSCMServiceManager.java | 3 +++
.../org/apache/hadoop/hdds/scm/ha/TestSequenceIDGenerator.java | 3 +++
.../hadoop/ozone/client/io/MultipartCryptoKeyInputStream.java | 3 +++
.../hadoop/fs/ozone/TestOzoneFileSystemMissingParent.java | 4 ++++
.../test/java/org/apache/hadoop/hdds/scm/TestSCMSnapshot.java | 3 +++
.../java/org/apache/hadoop/ozone/MiniOzoneHAClusterImpl.java | 10 +++-------
.../hadoop/ozone/client/rpc/read/TestInputStreamBase.java | 5 ++++-
.../apache/hadoop/ozone/om/TestOzoneManagerHAKeyDeletion.java | 3 +++
.../hadoop/ozone/recon/persistence/ContainerHistory.java | 3 +++
.../main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java | 6 ++++++
.../java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java | 6 ++++++
.../main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java | 3 +++
.../org/apache/hadoop/ozone/s3/signature/SignatureInfo.java | 3 +++
.../org/apache/hadoop/ozone/s3/TestEmptyContentTypeFilter.java | 5 ++++-
.../ozone/s3/signature/TestAuthorizationV4QueryParser.java | 5 ++++-
.../apache/hadoop/ozone/debug/container/ExportSubcommand.java | 3 +++
.../apache/hadoop/ozone/debug/container/InfoSubcommand.java | 3 +++
.../apache/hadoop/ozone/debug/container/ListSubcommand.java | 3 +++
.../java/org/apache/hadoop/ozone/freon/StreamingGenerator.java | 3 +++
.../hadoop/ozone/freon/containergenerator/BaseGenerator.java | 3 +++
.../org/apache/hadoop/ozone/genesis/BenchMarkCRCBatch.java | 3 +++
.../org/apache/hadoop/ozone/genesis/BenchMarkCRCStreaming.java | 3 +++
59 files changed, 192 insertions(+), 16 deletions(-)
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/ha/RetriableWithNoFailoverException.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/ha/RetriableWithNoFailoverException.java
index baba8b3..f39bdfb 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/ha/RetriableWithNoFailoverException.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/ha/RetriableWithNoFailoverException.java
@@ -19,6 +19,10 @@ package org.apache.hadoop.hdds.scm.ha;
import java.io.IOException;
+/**
+ * This exception indicates that the request can be retried, but only on the
+ * same server, without failover.
+ */
public class RetriableWithNoFailoverException extends IOException {
public RetriableWithNoFailoverException(IOException exception) {
super(exception);
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/utils/ClientCommandsUtils.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/utils/ClientCommandsUtils.java
index d5d1539..c4202c9 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/utils/ClientCommandsUtils.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/utils/ClientCommandsUtils.java
@@ -20,6 +20,9 @@ package org.apache.hadoop.hdds.scm.utils;
import org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos;
+/**
+ * These methods should be merged with other similar utility classes.
+ */
public final class ClientCommandsUtils {
/** Utility classes should not be constructed. **/
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferFactory.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferFactory.java
index a41af84..dd3598e 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferFactory.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferFactory.java
@@ -39,6 +39,9 @@ public final class ChecksumByteBufferFactory {
private static volatile boolean useJava9Crc32C
= JavaUtils.isJavaVersionAtLeast(9);
+ /**
+ * Factory for CRC32C implementation introduced in Java 9.
+ */
public static class Java9Crc32CFactory {
private static final MethodHandle NEW_CRC32C_MH;
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferImpl.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferImpl.java
index db779b6..5de86b8 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferImpl.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferImpl.java
@@ -20,6 +20,9 @@ package org.apache.hadoop.ozone.common;
import java.nio.ByteBuffer;
import java.util.zip.Checksum;
+/**
+ * {@link ChecksumByteBuffer} implementation based on {@link Checksum}.
+ */
public class ChecksumByteBufferImpl implements ChecksumByteBuffer {
private Checksum checksum;
@@ -63,4 +66,4 @@ public class ChecksumByteBufferImpl implements
ChecksumByteBuffer {
checksum.reset();
}
-}
\ No newline at end of file
+}
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/utils/BufferUtils.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/utils/BufferUtils.java
index 61e96fb..383d388 100644
---
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/utils/BufferUtils.java
+++
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/utils/BufferUtils.java
@@ -24,6 +24,9 @@ import java.util.ArrayList;
import java.util.List;
import org.apache.ratis.thirdparty.com.google.protobuf.ByteString;
+/**
+ * Utilities for buffers.
+ */
public final class BufferUtils {
/** Utility classes should not be constructed. **/
diff --git
a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/ha/ConfUtils.java
b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/ha/ConfUtils.java
index 10bc9a0..799a54b 100644
--- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/ha/ConfUtils.java
+++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/ha/ConfUtils.java
@@ -25,6 +25,9 @@ import org.slf4j.Logger;
import java.net.InetSocketAddress;
+/**
+ * Utilities related to configuration.
+ */
public final class ConfUtils {
private ConfUtils() {
diff --git
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMNodeInfo.java
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMNodeInfo.java
index a88e1ca..12a0240 100644
---
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMNodeInfo.java
+++
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMNodeInfo.java
@@ -42,6 +42,9 @@ import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVIC
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVICE_PORT_DEFAULT;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVICE_PORT_KEY;
+/**
+ * Tests for {@link SCMNodeInfo}.
+ */
public class TestSCMNodeInfo {
private OzoneConfiguration conf = new OzoneConfiguration();
diff --git
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/ozone/common/TestChecksumImplsComputeSameValues.java
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/ozone/common/TestChecksumImplsComputeSameValues.java
index a098a26..b15f59f 100644
---
a/hadoop-hdds/common/src/test/java/org/apache/hadoop/ozone/common/TestChecksumImplsComputeSameValues.java
+++
b/hadoop-hdds/common/src/test/java/org/apache/hadoop/ozone/common/TestChecksumImplsComputeSameValues.java
@@ -30,6 +30,10 @@ import java.util.zip.CRC32;
import static junit.framework.TestCase.assertEquals;
+/**
+ * Tests to verify that different checksum implementations compute the same
+ * results.
+ */
public class TestChecksumImplsComputeSameValues {
private int dataSize = 1024 * 1024 * 64;
diff --git
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/statemachine/background/BlockDeletingService.java
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/statemachine/background/BlockDeletingService.java
index a89efe0..905918a 100644
---
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/statemachine/background/BlockDeletingService.java
+++
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/statemachine/background/BlockDeletingService.java
@@ -109,6 +109,9 @@ public class BlockDeletingService extends BackgroundService
{
this.blockLimitPerInterval = dnConf.getBlockDeletionLimit();
}
+ /**
+ * Pair of container data and the number of blocks to delete.
+ */
public static class ContainerBlockInfo {
private final ContainerData containerData;
private final Long numBlocksToDelete;
diff --git
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationServer.java
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationServer.java
index e8f831b..d8757a1 100644
---
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationServer.java
+++
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationServer.java
@@ -123,6 +123,9 @@ public class ReplicationServer {
return port;
}
+ /**
+ * Replication-related configuration.
+ */
@ConfigGroup(prefix = "hdds.datanode.replication")
public static final class ReplicationConfig {
diff --git
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationSupervisor.java
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationSupervisor.java
index 6becf62..b049171 100644
---
a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationSupervisor.java
+++
b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationSupervisor.java
@@ -117,6 +117,9 @@ public class ReplicationSupervisor {
return containersInFlight.size();
}
+ /**
+ * An executable form of a replication task with status handling.
+ */
public final class TaskRunner implements Runnable {
private final ReplicationTask task;
diff --git
a/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/TestBlockDeletingService.java
b/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/TestBlockDeletingService.java
index aa88f95..b8e1f9c 100644
---
a/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/TestBlockDeletingService.java
+++
b/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/TestBlockDeletingService.java
@@ -127,6 +127,9 @@ public class TestBlockDeletingService {
.collect(toList());
}
+ /**
+ * Bundles test parameters for TestBlockDeletingService.
+ */
public static class LayoutInfo {
private final String schemaVersion;
private final ChunkLayOutVersion layout;
diff --git
a/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/replication/TestSimpleContainerDownloader.java
b/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/replication/TestSimpleContainerDownloader.java
index 7070425..5f40614 100644
---
a/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/replication/TestSimpleContainerDownloader.java
+++
b/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/replication/TestSimpleContainerDownloader.java
@@ -35,7 +35,7 @@ import org.apache.hadoop.hdds.protocol.MockDatanodeDetails;
import org.junit.Assert;
import org.junit.Test;
-/*
+/**
* Test SimpleContainerDownloader.
*/
public class TestSimpleContainerDownloader {
@@ -197,4 +197,4 @@ public class TestSimpleContainerDownloader {
datanodes.add(MockDatanodeDetails.randomDatanodeDetails());
return datanodes;
}
-}
\ No newline at end of file
+}
diff --git a/hadoop-hdds/dev-support/checkstyle/checkstyle.xml
b/hadoop-hdds/dev-support/checkstyle/checkstyle.xml
index 9ff858c..2ec4fb8 100644
--- a/hadoop-hdds/dev-support/checkstyle/checkstyle.xml
+++ b/hadoop-hdds/dev-support/checkstyle/checkstyle.xml
@@ -88,6 +88,8 @@
<property name="allowMissingParamTags" value="true"/>
</module>
<module name="JavadocStyle"/>
+ <module name="MissingJavadocPackage"/>
+ <module name="MissingJavadocType"/>
<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
diff --git
a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/NodeDetails.java
b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/NodeDetails.java
index baa4b49..27839da 100644
---
a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/NodeDetails.java
+++
b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/NodeDetails.java
@@ -22,7 +22,10 @@ import org.apache.hadoop.net.NetUtils;
import java.net.InetAddress;
import java.net.InetSocketAddress;
-public class NodeDetails {
+/**
+ * Basic information about nodes in an HA setup.
+ */
+public abstract class NodeDetails {
private String serviceId;
private String nodeId;
private InetSocketAddress rpcAddress;
diff --git
a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/cache/TableCache.java
b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/cache/TableCache.java
index ab4b73d..1aa64d5 100644
---
a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/cache/TableCache.java
+++
b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/cache/TableCache.java
@@ -111,6 +111,9 @@ public interface TableCache<CACHEKEY extends CacheKey,
@VisibleForTesting
Set<EpochEntry<CACHEKEY>> getEpochEntrySet();
+ /**
+ * Cache completeness.
+ */
enum CacheType {
FULL_CACHE, // This mean's the table maintains full cache. Cache and DB
// state are same.
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManager.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManager.java
index d90e176..13e61b0 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManager.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManager.java
@@ -26,6 +26,9 @@ import org.apache.hadoop.hdds.utils.db.Table.KeyValue;
import java.io.IOException;
import java.util.ArrayList;
+/**
+ * TODO: javadoc.
+ */
public interface DeletedBlockLogStateManager {
@Replicate
void addTransactionsToDB(ArrayList<DeletedBlocksTransaction> txs)
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManagerImpl.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManagerImpl.java
index d2c55a0..63eb9b0 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManagerImpl.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManagerImpl.java
@@ -41,6 +41,9 @@ import java.util.concurrent.ConcurrentHashMap;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_BLOCK_DELETION_MAX_RETRY;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_BLOCK_DELETION_MAX_RETRY_DEFAULT;
+/**
+ * TODO: javadoc.
+ */
public class DeletedBlockLogStateManagerImpl
implements DeletedBlockLogStateManager {
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancer.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancer.java
index ec906a5..4b8501ce 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancer.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancer.java
@@ -35,6 +35,10 @@ import java.util.Comparator;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
+/**
+ * Container balancer is a service in SCM to move containers between over- and
+ * under-utilized datanodes.
+ */
public class ContainerBalancer {
private static final Logger LOG =
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancerMetrics.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancerMetrics.java
index 1d8ab41..87ba7d8 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancerMetrics.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancerMetrics.java
@@ -23,6 +23,9 @@ import
org.apache.hadoop.hdds.scm.container.placement.metrics.LongMetric;
import org.apache.hadoop.metrics2.annotation.Metric;
import org.apache.hadoop.metrics2.annotation.Metrics;
+/**
+ * Metrics related to Container Balancer running in SCM.
+ */
@Metrics(name = "ContainerBalancer Metrics", about = "Metrics related to " +
"Container Balancer running in SCM", context = "SCM")
public final class ContainerBalancerMetrics {
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/HASecurityUtils.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/HASecurityUtils.java
index 0a86ab2..1d2b36e 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/HASecurityUtils.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/HASecurityUtils.java
@@ -67,6 +67,9 @@ import static
org.apache.hadoop.ozone.OzoneConsts.SCM_ROOT_CA_COMPONENT_NAME;
import static org.apache.hadoop.ozone.OzoneConsts.SCM_ROOT_CA_PREFIX;
import static org.apache.hadoop.ozone.OzoneConsts.SCM_SUB_CA_PREFIX;
+/**
+ * Utilities for SCM HA security.
+ */
public final class HASecurityUtils {
private HASecurityUtils() {
@@ -375,4 +378,4 @@ public final class HASecurityUtils {
}
-}
\ No newline at end of file
+}
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/MockSCMHADBTransactionBuffer.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/MockSCMHADBTransactionBuffer.java
index 174a4f8..768dba7 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/MockSCMHADBTransactionBuffer.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/MockSCMHADBTransactionBuffer.java
@@ -25,6 +25,10 @@ import org.apache.ratis.statemachine.SnapshotInfo;
import java.io.IOException;
+// TODO: Move this class to test package after fixing Recon
+/**
+ * Mock SCMHADBTransactionBuffer implementation for testing.
+ */
public class MockSCMHADBTransactionBuffer implements SCMHADBTransactionBuffer {
private DBStore dbStore;
private BatchOperation currentBatchOperation;
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMContext.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMContext.java
index 1c4a223..9321e5a 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMContext.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMContext.java
@@ -177,6 +177,9 @@ public final class SCMContext {
return scm;
}
+ /**
+ * Builder for SCMContext.
+ */
public static class Builder {
/**
* The default context:
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMDBCheckpointProvider.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMDBCheckpointProvider.java
index 07e276f..ef7215f 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMDBCheckpointProvider.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMDBCheckpointProvider.java
@@ -29,8 +29,10 @@ import java.nio.file.Path;
import java.time.Duration;
import java.time.Instant;
-
// TODO: define a generic interface for this
+/**
+ * TODO: javadoc.
+ */
public class SCMDBCheckpointProvider {
private static final Logger LOG =
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMHANodeDetails.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMHANodeDetails.java
index 937a9d0..7cbcfba 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMHANodeDetails.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMHANodeDetails.java
@@ -60,6 +60,9 @@ import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVIC
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVICE_PORT_KEY;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SERVICE_IDS_KEY;
+/**
+ * TODO: javadoc.
+ */
public class SCMHANodeDetails {
public static final Logger LOG =
LoggerFactory.getLogger(SCMHANodeDetails.class);
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/BooleanCodec.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/BooleanCodec.java
index 0fb10d6..4cf0a79 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/BooleanCodec.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/BooleanCodec.java
@@ -21,6 +21,9 @@ import com.google.protobuf.ByteString;
import static java.nio.charset.StandardCharsets.UTF_8;
+/**
+ * {@link Codec} for {@code Boolean} objects.
+ */
public class BooleanCodec implements Codec {
@Override
public ByteString serialize(Object object) {
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/Codec.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/Codec.java
index 2e16376..eb062d9 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/Codec.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/Codec.java
@@ -20,6 +20,9 @@ package org.apache.hadoop.hdds.scm.ha.io;
import com.google.protobuf.ByteString;
import com.google.protobuf.InvalidProtocolBufferException;
+/**
+ * Codec interface to marshall/unmarshall data to/from {@link ByteString}.
+ */
public interface Codec {
ByteString serialize(Object object) throws InvalidProtocolBufferException;
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/CodecFactory.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/CodecFactory.java
index fefb983..95d906e 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/CodecFactory.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/CodecFactory.java
@@ -29,6 +29,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * Maps types to the corresponding {@link Codec} implementation.
+ */
public final class CodecFactory {
private static Map<Class<?>, Codec> codecs = new HashMap<>();
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/EnumCodec.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/EnumCodec.java
index bca71ed..6f1f2f1 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/EnumCodec.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/EnumCodec.java
@@ -25,6 +25,9 @@ import org.apache.hadoop.hdds.scm.ha.ReflectionUtil;
import java.lang.reflect.InvocationTargetException;
+/**
+ * {@link Codec} for {@link ProtocolMessageEnum} objects.
+ */
public class EnumCodec implements Codec {
@Override
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/GeneratedMessageCodec.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/GeneratedMessageCodec.java
index acfc719..45ab5df 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/GeneratedMessageCodec.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/GeneratedMessageCodec.java
@@ -24,6 +24,9 @@ import org.apache.hadoop.hdds.scm.ha.ReflectionUtil;
import java.lang.reflect.InvocationTargetException;
+/**
+ * {@link Codec} for {@link GeneratedMessage} objects.
+ */
public class GeneratedMessageCodec implements Codec {
@Override
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ListCodec.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ListCodec.java
index 0dbb1c0..2560733 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ListCodec.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ListCodec.java
@@ -25,6 +25,9 @@ import org.apache.hadoop.hdds.scm.ha.ReflectionUtil;
import java.lang.reflect.InvocationTargetException;
import java.util.List;
+/**
+ * {@link Codec} for {@link List} objects.
+ */
public class ListCodec implements Codec {
@Override
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/LongCodec.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/LongCodec.java
index 1a02dbd..512449a 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/LongCodec.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/LongCodec.java
@@ -21,6 +21,9 @@ import com.google.common.primitives.Longs;
import com.google.protobuf.ByteString;
import com.google.protobuf.InvalidProtocolBufferException;
+/**
+ * {@link Codec} for {@code Long} objects.
+ */
public class LongCodec implements Codec {
@Override
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/StringCodec.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/StringCodec.java
index fc66ee1..b14884c 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/StringCodec.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/StringCodec.java
@@ -21,6 +21,9 @@ import com.google.protobuf.ByteString;
import static java.nio.charset.StandardCharsets.UTF_8;
+/**
+ * {@link Codec} for {@code String} objects.
+ */
public class StringCodec implements Codec {
@Override
public ByteString serialize(Object object) {
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/node/DatanodeUsageInfo.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/node/DatanodeUsageInfo.java
index a88b2b9..2f8ee04 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/node/DatanodeUsageInfo.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/node/DatanodeUsageInfo.java
@@ -24,6 +24,9 @@ import
org.apache.hadoop.hdds.scm.container.placement.metrics.SCMNodeStat;
import java.util.Comparator;
+/**
+ * Bundles datanode details with usage statistics.
+ */
public class DatanodeUsageInfo {
private DatanodeDetails datanodeDetails;
diff --git
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMCertStore.java
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMCertStore.java
index 7a56858..bb0c1a0 100644
---
a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMCertStore.java
+++
b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMCertStore.java
@@ -301,6 +301,9 @@ public final class SCMCertStore implements CertificateStore
{
this.scmMetadataStore = metadataStore;
}
+ /**
+ * Builder for SCMCertStore.
+ */
public static class Builder {
private SCMMetadataStore metadataStore;
diff --git
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/container/balancer/TestContainerBalancer.java
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/container/balancer/TestContainerBalancer.java
index 1fad575..4c76a26 100644
---
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/container/balancer/TestContainerBalancer.java
+++
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/container/balancer/TestContainerBalancer.java
@@ -39,6 +39,9 @@ import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ThreadLocalRandom;
+/**
+ * Tests for {@link ContainerBalancer}.
+ */
public class TestContainerBalancer {
private static final Logger LOG =
diff --git
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMHAConfiguration.java
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMHAConfiguration.java
index 596fbbe..6f5eab4 100644
---
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMHAConfiguration.java
+++
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMHAConfiguration.java
@@ -47,6 +47,9 @@ import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVIC
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVICE_BIND_HOST_KEY;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SECURITY_SERVICE_PORT_KEY;
+/**
+ * Test for SCM HA-related configuration.
+ */
public class TestSCMHAConfiguration {
private OzoneConfiguration conf;
diff --git
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMServiceManager.java
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMServiceManager.java
index 601417b..793b2dd 100644
---
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMServiceManager.java
+++
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMServiceManager.java
@@ -24,6 +24,9 @@ import org.junit.Test;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
+/**
+ * Tests for {@link SCMServiceManager}.
+ */
public class TestSCMServiceManager {
@Test
public void testServiceRunWhenLeader() {
diff --git
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSequenceIDGenerator.java
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSequenceIDGenerator.java
index 17a7f91..5e9a5b8 100644
---
a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSequenceIDGenerator.java
+++
b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSequenceIDGenerator.java
@@ -26,6 +26,9 @@ import org.junit.Test;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_SEQUENCE_ID_BATCH_SIZE;
+/**
+ * Tests for {@link SequenceIdGenerator}.
+ */
public class TestSequenceIDGenerator {
@Test
public void testSequenceIDGenUponNonRatis() throws Exception {
diff --git
a/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/io/MultipartCryptoKeyInputStream.java
b/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/io/MultipartCryptoKeyInputStream.java
index 07c0464..3a88d5f 100644
---
a/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/io/MultipartCryptoKeyInputStream.java
+++
b/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/io/MultipartCryptoKeyInputStream.java
@@ -31,6 +31,9 @@ import java.io.IOException;
import java.util.Arrays;
import java.util.List;
+/**
+ * {@link OzoneInputStream} for accessing MPU keys in encrypted buckets.
+ */
public class MultipartCryptoKeyInputStream extends OzoneInputStream
implements Seekable, CanUnbuffer {
diff --git
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/fs/ozone/TestOzoneFileSystemMissingParent.java
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/fs/ozone/TestOzoneFileSystemMissingParent.java
index cb59d2e..68cc3a8 100644
---
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/fs/ozone/TestOzoneFileSystemMissingParent.java
+++
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/fs/ozone/TestOzoneFileSystemMissingParent.java
@@ -39,6 +39,10 @@ import org.junit.Test;
import static org.apache.hadoop.ozone.OzoneConsts.OZONE_URI_DELIMITER;
import static org.apache.hadoop.ozone.om.OMConfigKeys.OZONE_OM_ADDRESS_KEY;
+/**
+ * Tests OFS behavior when filesystem paths are enabled and parent directory is
+ * missing for some reason.
+ */
public class TestOzoneFileSystemMissingParent {
private static OzoneConfiguration conf;
diff --git
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMSnapshot.java
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMSnapshot.java
index d8ada51..275df6d 100644
---
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMSnapshot.java
+++
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMSnapshot.java
@@ -37,6 +37,9 @@ import java.util.UUID;
import static
org.apache.hadoop.hdds.protocol.proto.HddsProtos.ReplicationFactor.ONE;
import static
org.apache.hadoop.hdds.protocol.proto.HddsProtos.ReplicationFactor.THREE;
+/**
+ * Tests snapshots in SCM HA.
+ */
public class TestSCMSnapshot {
private static MiniOzoneCluster cluster;
private static OzoneConfiguration conf;
diff --git
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/MiniOzoneHAClusterImpl.java
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/MiniOzoneHAClusterImpl.java
index bd6e4b3..54961c3 100644
---
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/MiniOzoneHAClusterImpl.java
+++
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/MiniOzoneHAClusterImpl.java
@@ -24,6 +24,7 @@ import com.google.common.collect.Maps;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.hdds.scm.ScmConfigKeys;
import org.apache.hadoop.hdds.scm.TestUtils;
+import org.apache.hadoop.hdds.scm.ha.CheckedConsumer;
import org.apache.hadoop.hdds.scm.safemode.HealthyPipelineSafeModeRule;
import org.apache.hadoop.hdds.scm.server.StorageContainerManager;
import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem;
@@ -656,11 +657,6 @@ public class MiniOzoneHAClusterImpl extends
MiniOzoneClusterImpl {
}
}
- @FunctionalInterface
- public interface CheckedConsumer<T> {
- void apply(T t) throws IOException;
- }
-
/**
* MiniOzoneHAService is a helper class used for both SCM and OM HA.
* This class keeps track of active and inactive OM/SCM services
@@ -731,12 +727,12 @@ public class MiniOzoneHAClusterImpl extends
MiniOzoneClusterImpl {
}
public void startInactiveService(String id,
- CheckedConsumer<Type> serviceStarter) throws IOException {
+ CheckedConsumer<Type, IOException> serviceStarter) throws IOException {
Type service = serviceMap.get(id);
if (!inactiveServices.contains(service)) {
throw new IOException(serviceName + " is already active.");
} else {
- serviceStarter.apply(service);
+ serviceStarter.execute(service);
activeServices.add(service);
inactiveServices.remove(service);
}
diff --git
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/client/rpc/read/TestInputStreamBase.java
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/client/rpc/read/TestInputStreamBase.java
index 3735e8a..ccfd541 100644
---
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/client/rpc/read/TestInputStreamBase.java
+++
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/client/rpc/read/TestInputStreamBase.java
@@ -57,8 +57,11 @@ import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.HDDS_SCM_WATCHER_TIMEOUT;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_DEADNODE_INTERVAL;
import static
org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_STALENODE_INTERVAL;
+/**
+ * Common tests for Ozone's {@code InputStream} implementations.
+ */
@RunWith(Parameterized.class)
-public class TestInputStreamBase {
+public abstract class TestInputStreamBase {
private MiniOzoneCluster cluster;
private OzoneConfiguration conf = new OzoneConfiguration();
diff --git
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOzoneManagerHAKeyDeletion.java
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOzoneManagerHAKeyDeletion.java
index 52449a2..279fcdd 100644
---
a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOzoneManagerHAKeyDeletion.java
+++
b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOzoneManagerHAKeyDeletion.java
@@ -26,6 +26,9 @@ import java.util.List;
import static org.junit.Assert.fail;
+/**
+ * Tests key deletion in OM HA setup.
+ */
public class TestOzoneManagerHAKeyDeletion extends TestOzoneManagerHA {
@Test
diff --git
a/hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/persistence/ContainerHistory.java
b/hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/persistence/ContainerHistory.java
index 805f5ae..4d9543e 100644
---
a/hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/persistence/ContainerHistory.java
+++
b/hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/persistence/ContainerHistory.java
@@ -20,6 +20,9 @@ package org.apache.hadoop.ozone.recon.persistence;
import java.io.Serializable;
+/**
+ * Some historical info about a container on a datanode.
+ */
public class ContainerHistory implements Serializable {
private long containerId;
diff --git
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java
index 111f28c..c59c4d1 100644
---
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java
+++
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java
@@ -35,6 +35,9 @@ import java.util.List;
import static
org.apache.hadoop.ozone.s3.exception.S3ErrorTable.INVALID_ARGUMENT;
import static
org.apache.hadoop.ozone.s3.exception.S3ErrorTable.NOT_IMPLEMENTED;
+/**
+ * TODO: javadoc.
+ */
public final class S3Acl {
private static final Logger LOG = LoggerFactory.getLogger(S3Acl.class);
@@ -89,6 +92,9 @@ public final class S3Acl {
}
}
+ /**
+ * TODO: javadoc.
+ */
enum ACLIdentityType {
USER("CanonicalUser", true, "id"),
GROUP("Group", false, "url"),
diff --git
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java
index 7a699e4..66f931fd 100644
---
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java
+++
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java
@@ -65,6 +65,9 @@ public class S3BucketAcl {
'}';
}
+ /**
+ * TODO: javadoc.
+ */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "AccessControlList")
public static class AccessControlList {
@@ -96,6 +99,9 @@ public class S3BucketAcl {
}
}
+ /**
+ * TODO: javadoc.
+ */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "Grant")
public static class Grant {
diff --git
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java
index 48f154e..da05142 100644
---
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java
+++
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java
@@ -24,6 +24,9 @@ import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
+/**
+ * TODO: javadoc.
+ */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "Owner")
public class S3Owner {
diff --git
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/signature/SignatureInfo.java
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/signature/SignatureInfo.java
index cadbd5d..0da8895 100644
---
a/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/signature/SignatureInfo.java
+++
b/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/signature/SignatureInfo.java
@@ -107,6 +107,9 @@ public class SignatureInfo {
return dateTime;
}
+ /**
+ * Signature version.
+ */
public enum Version {
NONE, V4, V2;
}
diff --git
a/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/TestEmptyContentTypeFilter.java
b/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/TestEmptyContentTypeFilter.java
index 7bac23c..1788bd5 100644
---
a/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/TestEmptyContentTypeFilter.java
+++
b/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/TestEmptyContentTypeFilter.java
@@ -24,6 +24,9 @@ import
org.apache.hadoop.ozone.s3.EmptyContentTypeFilter.EnumerationWrapper;
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Tests for {@link EmptyContentTypeFilter}.
+ */
public class TestEmptyContentTypeFilter {
@Test
@@ -55,4 +58,4 @@ public class TestEmptyContentTypeFilter {
Assert.assertFalse(enumerationWrapper.hasMoreElements());
}
-}
\ No newline at end of file
+}
diff --git
a/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/signature/TestAuthorizationV4QueryParser.java
b/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/signature/TestAuthorizationV4QueryParser.java
index 5f66bf0..7396d68 100644
---
a/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/signature/TestAuthorizationV4QueryParser.java
+++
b/hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/signature/TestAuthorizationV4QueryParser.java
@@ -27,6 +27,9 @@ import
org.apache.hadoop.ozone.s3.signature.AWSSignatureProcessor.LowerCaseKeySt
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Tests for {@link AuthorizationV4QueryParser}.
+ */
public class TestAuthorizationV4QueryParser {
@Test(expected = IllegalArgumentException.class)
@@ -143,4 +146,4 @@ public class TestAuthorizationV4QueryParser {
stringToSign);
}
-}
\ No newline at end of file
+}
diff --git
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ExportSubcommand.java
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ExportSubcommand.java
index edeeebd..67ebb15 100644
---
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ExportSubcommand.java
+++
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ExportSubcommand.java
@@ -30,6 +30,9 @@ import java.io.File;
import java.io.FileOutputStream;
import java.util.concurrent.Callable;
+/**
+ * Handles {@code ozone debug container export} command.
+ */
@Command(
name = "export",
description = "Export one container to a tarball")
diff --git
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/InfoSubcommand.java
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/InfoSubcommand.java
index 3456aeb..0d70d90 100644
---
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/InfoSubcommand.java
+++
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/InfoSubcommand.java
@@ -26,6 +26,9 @@ import java.util.concurrent.Callable;
import static
org.apache.hadoop.ozone.debug.container.ContainerCommands.outputContainer;
+/**
+ * Handles {@code ozone debug container info} command.
+ */
@Command(
name = "info",
description = "Show container info of a container replica on datanode")
diff --git
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ListSubcommand.java
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ListSubcommand.java
index 15bdb02..94d2be6 100644
---
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ListSubcommand.java
+++
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/container/ListSubcommand.java
@@ -27,6 +27,9 @@ import java.util.concurrent.Callable;
import static
org.apache.hadoop.ozone.debug.container.ContainerCommands.outputContainer;
+/**
+ * Handles {@code ozone debug container list} command.
+ */
@Command(
name = "list",
description = "Show container info of all container replicas on datanode")
diff --git
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/StreamingGenerator.java
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/StreamingGenerator.java
index 2cf2515..8fed676 100644
---
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/StreamingGenerator.java
+++
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/StreamingGenerator.java
@@ -33,6 +33,9 @@ import java.nio.file.Files;
import java.nio.file.Path;
import java.util.concurrent.Callable;
+/**
+ * Freon test for streaming service.
+ */
@CommandLine.Command(name = "strmg",
aliases = "streaming-generator",
description =
diff --git
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/containergenerator/BaseGenerator.java
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/containergenerator/BaseGenerator.java
index ff90aa4..453db96 100644
---
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/containergenerator/BaseGenerator.java
+++
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/containergenerator/BaseGenerator.java
@@ -26,6 +26,9 @@ import org.apache.hadoop.ozone.freon.BaseFreonGenerator;
import picocli.CommandLine.Option;
+/**
+ * Common options of data generators for fast scale test.
+ */
public abstract class BaseGenerator extends BaseFreonGenerator implements
Callable<Void> {
diff --git
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCBatch.java
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCBatch.java
index b4875fc..69120da 100644
---
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCBatch.java
+++
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCBatch.java
@@ -51,6 +51,9 @@ public class BenchMarkCRCBatch {
private static int dataSize = 64 * 1024 * 1024;
+ /**
+ * Benchmark state.
+ */
@State(Scope.Thread)
public static class BenchmarkState {
diff --git
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCStreaming.java
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCStreaming.java
index 5dd5da8..669d858 100644
---
a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCStreaming.java
+++
b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCStreaming.java
@@ -68,6 +68,9 @@ public class BenchMarkCRCStreaming {
private static int dataSize = 64 * 1024 * 1024;
+ /**
+ * Benchmark state.
+ */
@State(Scope.Thread)
public static class BenchmarkState {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
