HDDS-12364. Add missing Override annotation

dev-support/pmd/pmd-ruleset.xml

@@ -26,5 +26,7 @@
         PMD Ruleset for Apache Ozone
     </description>
 
+    <rule ref="category/java/bestpractices.xml/MissingOverride" />
+
     <exclude-pattern>.*/generated-sources/.*</exclude-pattern>
 </ruleset>

hadoop-hdds/client/src/main/java/org/apache/hadoop/ozone/client/io/BlockInputStreamFactoryImpl.java

@@ -74,6 +74,7 @@ public BlockInputStreamFactoryImpl(ByteBufferPool byteBufferPool,
    * @param refreshFunction Function to refresh the pipeline if needed
    * @return BlockExtendedInputStream of the correct type.
    */
+  @Override
   public BlockExtendedInputStream create(ReplicationConfig repConfig,
       BlockLocationInfo blockInfo, Pipeline pipeline,
       Token<OzoneBlockTokenIdentifier> token,

hadoop-hdds/client/src/main/java/org/apache/hadoop/ozone/client/io/ECBlockInputStreamFactoryImpl.java

@@ -71,6 +71,7 @@ private ECBlockInputStreamFactoryImpl(BlockInputStreamFactory streamFactory,
    * @param refreshFunction Function to refresh the pipeline if needed
    * @return BlockExtendedInputStream of the correct type.
    */
+  @Override
   public BlockExtendedInputStream create(boolean missingLocations,
       List<DatanodeDetails> failedLocations, ReplicationConfig repConfig,
       BlockLocationInfo blockInfo,

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/net/InnerNode.java

@@ -94,8 +94,10 @@ Node getLeaf(int leafIndex, List<String> excludedScopes,
   @Override
   HddsProtos.NetworkNode toProtobuf(int clientVersion);
 
+  @Override
   boolean equals(Object o);
 
+  @Override
   int hashCode();
 
   static InnerNode fromProtobuf(

hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBuffer.java

@@ -35,7 +35,12 @@ public interface ChecksumByteBuffer extends Checksum {
    * Upon return, the buffer's position will be equal to its limit.
    *
    * @param buffer the bytes to update the checksum with
+   *
+   * @apiNote {@link Override} annotation is missing since {@link Checksum#update(ByteBuffer)} introduced only in Java9.
+   * TODO: Remove when Java 1.8 support is dropped.
+   * TODO: <a href="https://issues.apache.org/jira/browse/HDDS-12366">HDDS-12366</a>
    */
+  @SuppressWarnings("PMD.MissingOverride")
   void update(ByteBuffer buffer);
 
   @Override

hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChunkBuffer.java

@@ -84,6 +84,7 @@ default boolean hasRemaining() {
   /** Similar to {@link ByteBuffer#clear()}. */
   ChunkBuffer clear();
 
+  @Override
   default void close() {
   }
 

hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/lock/BootstrapStateHandler.java

@@ -26,13 +26,16 @@ public interface BootstrapStateHandler {
   /** Bootstrap state handler lock implementation. */
   class Lock implements AutoCloseable {
     private final Semaphore semaphore = new Semaphore(1);
+
     public Lock lock() throws InterruptedException {
       semaphore.acquire();
       return this;
     }
     public void unlock() {
       semaphore.release();
     }
+
+    @Override
     public void close() {
       unlock();
     }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/utils/ReferenceCountedDB.java

@@ -64,6 +64,7 @@ public void decrementReference() {
     }
   }
 
+  @Override
   public boolean cleanup() {
     if (getStore() != null && getStore().isClosed()
         || referenceCount.get() == 0) {

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/DbVolume.java

@@ -104,6 +104,7 @@ public Builder getThis() {
       return this;
     }
 
+    @Override
     public DbVolume build() throws IOException {
       return new DbVolume(this);
     }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/HddsVolume.java

@@ -111,6 +111,7 @@ public Builder getThis() {
       return this;
     }
 
+    @Override
     public HddsVolume build() throws IOException {
       return new HddsVolume(this);
     }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/MetadataVolume.java

@@ -65,6 +65,7 @@ public Builder getThis() {
       return this;
     }
 
+    @Override
     public MetadataVolume build() throws IOException {
       return new MetadataVolume(this);
     }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/KeyValueContainerMetadataInspector.java

@@ -93,6 +93,7 @@ public enum Mode {
       this.name = name;
     }
 
+    @Override
     public String toString() {
       return name;
     }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/KeyValueHandler.java

@@ -1378,11 +1378,13 @@ public void deleteUnreferenced(Container container, long localID)
     }
   }
 
+  @Override
   public void addFinalizedBlock(Container container, long localID) {
     KeyValueContainer keyValueContainer = (KeyValueContainer)container;
     keyValueContainer.getContainerData().addToFinalizedBlockSet(localID);
   }
 
+  @Override
   public boolean isFinalizedBlockExist(Container container, long localID) {
     KeyValueContainer keyValueContainer = (KeyValueContainer)container;
     return keyValueContainer.getContainerData().isFinalizedBlockExist(localID);

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/impl/ChunkManagerDispatcher.java

@@ -72,6 +72,7 @@ public void writeChunk(Container container, BlockID blockID, ChunkInfo info,
         .writeChunk(container, blockID, info, data, dispatcherContext);
   }
 
+  @Override
   public String streamInit(Container container, BlockID blockID)
       throws StorageContainerException {
     return selectHandler(container)

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/metadata/AbstractRDBStore.java

@@ -56,6 +56,7 @@ protected AbstractRDBStore(DEF dbDef, ConfigurationSource config, boolean openRe
     start(config);
   }
 
+  @Override
   public void start(ConfigurationSource config)
       throws IOException {
     if (this.store == null) {
@@ -81,41 +82,49 @@ public void start(ConfigurationSource config)
   protected abstract DBStore initDBStore(DBStoreBuilder dbStoreBuilder, ManagedDBOptions options,
                                          ConfigurationSource config) throws IOException;
 
+  @Override
   public synchronized void stop() throws Exception {
     if (store != null) {
       store.close();
       store = null;
     }
   }
 
+  @Override
   public DBStore getStore() {
     return this.store;
   }
 
+  @Override
   public synchronized boolean isClosed() {
     if (this.store == null) {
       return true;
     }
     return this.store.isClosed();
   }
 
+  @Override
   public BatchOperationHandler getBatchHandler() {
     return this.store;
   }
 
+  @Override
   public void close() throws IOException {
     this.store.close();
     this.cfOptions.close();
   }
 
+  @Override
   public void flushDB() throws IOException {
     store.flushDB();
   }
 
+  @Override
   public void flushLog(boolean sync) throws IOException {
     store.flushLog(sync);
   }
 
+  @Override
   public void compactDB() throws IOException {
     store.compactDB();
   }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/metadata/DatanodeSchemaTwoDBDefinition.java

@@ -112,6 +112,7 @@ public DBColumnFamilyDefinition<String, Long> getMetadataColumnFamily() {
     return DELETE_TRANSACTION;
   }
 
+  @Override
   public DBColumnFamilyDefinition<String, Long> getFinalizeBlocksColumnFamily() {
     return FINALIZE_BLOCKS;
   }

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/metadata/DatanodeStoreSchemaThreeImpl.java

@@ -154,6 +154,7 @@ public static File getDumpDir(File metaDir) {
     return new File(metaDir, DUMP_DIR);
   }
 
+  @Override
   public void compactionIfNeeded() throws Exception {
     // Calculate number of files per level and size per level
     RocksDatabase rocksDB = ((RDBStore)getStore()).getDb();

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/metadata/DatanodeStoreWithIncrementalChunkList.java

@@ -134,6 +134,7 @@ private static boolean shouldAppendLastChunk(boolean endOfBlock,
     return isFullChunk(data.getChunks().get(data.getChunks().size() - 1));
   }
 
+  @Override
   public void putBlockByID(BatchOperation batch, boolean incremental,
       long localID, BlockData data, KeyValueContainerData containerData,
       boolean endOfBlock) throws IOException {

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/CopyContainerResponseStream.java

@@ -33,6 +33,7 @@ class CopyContainerResponseStream
     super(streamObserver, containerId, bufferSize);
   }
 
+  @Override
   protected void sendPart(boolean eof, int length, ByteString data) {
     CopyContainerResponseProto response =
         CopyContainerResponseProto.newBuilder()

hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationTask.java

@@ -92,6 +92,7 @@ public int hashCode() {
     return Objects.hash(getContainerId(), getTarget());
   }
 
+  @Override
   public long getContainerId() {
     return cmd.getContainerID();
   }

hadoop-hdds/erasurecode/src/main/java/org/apache/ozone/erasurecode/rawcoder/XORRawEncoder.java

@@ -35,6 +35,7 @@ public XORRawEncoder(ECReplicationConfig ecReplicationConfig) {
     super(ecReplicationConfig);
   }
 
+  @Override
   protected void doEncode(ByteBufferEncodingState encodingState) {
     CoderUtil.resetOutputBuffers(encodingState.outputs,
         encodingState.encodeLength);

hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/protocolPB/SCMSecurityProtocolClientSideTranslatorPB.java

@@ -198,6 +198,7 @@ public String getSCMCertificate(ScmNodeDetailsProto scmNodeDetails,
    * @return String         - pem encoded SCM signed
    *                          certificate.
    */
+  @Override
   public String getSCMCertificate(ScmNodeDetailsProto scmNodeDetails,
       String certSignReq, boolean renew) throws IOException {
     return getSCMCertChain(scmNodeDetails, certSignReq, renew)

hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/scm/protocolPB/StorageContainerLocationProtocolClientSideTranslatorPB.java

@@ -1162,6 +1162,7 @@ public StatusAndMessages queryUpgradeFinalizationProgress(
         status.getMessagesList());
   }
 
+  @Override
   public Token<?> getContainerToken(
       ContainerID containerID) throws IOException {
     GetContainerTokenRequestProto request =

hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/security/OzoneSecretManager.java

@@ -181,6 +181,7 @@ private OzoneSecretKey updateCurrentKey(KeyPair keyPair,
     return newKey;
   }
 
+  @Override
   public void notifyCertificateRenewed(CertificateClient client,
       String oldCertId, String newCertId) {
     if (!oldCertId.equals(getCertSerialId())) {

hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/security/x509/certificate/client/DefaultCertificateClient.java

@@ -957,6 +957,7 @@ public Logger getLogger() {
     return logger;
   }
 
+  @Override
   public String getComponentName() {
     return component;
   }

hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/security/x509/certificate/client/SCMCertificateClient.java

@@ -133,6 +133,7 @@ public SCMCertificateClient(
    *
    * @return CertificateSignRequest.Builder
    */
+  @Override
   public CertificateSignRequest.Builder configureCSRBuilder()
       throws SCMSecurityException {
     String subject = SCM_SUB_CA_PREFIX + scmHostname;

hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/server/events/FixedThreadPoolWithAffinityExecutor.java

@@ -206,10 +206,12 @@ public long droppedEvents() {
     return dropped.value();
   }
 
+  @Override
   public long longWaitInQueueEvents() {
     return longWaitInQueue.value();
   }
 
+  @Override
   public long longTimeExecutionEvents() {
     return longTimeExecution.value();
   }

hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/DumpFileLoader.java

@@ -34,5 +34,6 @@ public interface DumpFileLoader extends Closeable {
   /**
    * Close this file loader.
    */
+  @Override
   void close();
 }

hadoop-hdds/framework/src/main/java/org/apache/hadoop/ozone/upgrade/BasicUpgradeFinalizer.java

@@ -73,6 +73,7 @@ public BasicUpgradeFinalizer(V versionManager,
     this.finalizationLock = new ReentrantLock();
   }
 
+  @Override
   public StatusAndMessages finalize(String upgradeClientID, T service)
       throws IOException {
     // In some components, finalization can be driven asynchronously by a
@@ -114,6 +115,7 @@ public StatusAndMessages finalize(String upgradeClientID, T service)
     }
   }
 
+  @Override
   public synchronized StatusAndMessages reportStatus(
       String upgradeClientID, boolean takeover) throws UpgradeException {
     if (takeover) {

hadoop-hdds/framework/src/main/java/org/apache/hadoop/ozone/upgrade/DefaultUpgradeFinalizationExecutor.java

@@ -36,6 +36,7 @@ public class DefaultUpgradeFinalizationExecutor<T>
   public DefaultUpgradeFinalizationExecutor() {
   }
 
+  @Override
   public void execute(T component, BasicUpgradeFinalizer<T, ?> finalizer)
       throws IOException {
     try {

hadoop-hdds/rocksdb-checkpoint-differ/src/main/java/org/apache/ozone/rocksdiff/RocksDBCheckpointDiffer.java

@@ -1024,6 +1024,7 @@ public String getMetadataDir() {
 
   static class NodeComparator
       implements Comparator<CompactionNode>, Serializable {
+    @Override
     public int compare(CompactionNode a, CompactionNode b) {
       return a.getFileName().compareToIgnoreCase(b.getFileName());
     }

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManagerImpl.java

@@ -70,6 +70,7 @@ public DeletedBlockLogStateManagerImpl(ConfigurationSource conf,
         isRatisEnabled ? ConcurrentHashMap.newKeySet() : null;
   }
 
+  @Override
   public TableIterator<Long, TypedTable.KeyValue<Long,
       DeletedBlocksTransaction>> getReadOnlyIterator() throws IOException {
     return new TableIterator<Long, TypedTable.KeyValue<Long,
@@ -238,6 +239,7 @@ public int resetRetryCountOfTransactionInDB(ArrayList<Long> txIDs)
     return resetCount;
   }
 
+  @Override
   public void onFlush() {
     // onFlush() can be invoked only when ratis is enabled.
     Preconditions.checkNotNull(deletingTxIDs);

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/ContainerManagerImpl.java

@@ -465,6 +465,7 @@ public void close() throws IOException {
   }
 
   // Remove this after fixing Recon
+  @Override
   @VisibleForTesting
   public ContainerStateManager getContainerStateManager() {
     return containerStateManager;

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/ContainerStateManagerImpl.java

@@ -446,6 +446,7 @@ public void updateDeleteTransactionId(
     }
   }
 
+  @Override
   public ContainerInfo getMatchingContainer(final long size, String owner,
       PipelineID pipelineID, NavigableSet<ContainerID> containerIDs) {
     if (containerIDs.isEmpty()) {
@@ -504,6 +505,7 @@ private ContainerInfo findContainerWithSpace(final long size,
   }
 
 
+  @Override
   public void removeContainer(final HddsProtos.ContainerID id)
       throws IOException {
     final ContainerID cid = ContainerID.getFromProtobuf(id);

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancerTask.java

@@ -179,6 +179,7 @@ public ContainerBalancerTask(StorageContainerManager scm,
   /**
    * Run the container balancer task.
    */
+  @Override
   public void run() {
     try {
       if (delayStart) {

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/FindSourceGreedy.java

@@ -70,6 +70,7 @@ private void setLowerLimit(Double lowerLimit) {
   /**
    * {@inheritDoc}
    */
+  @Override
   public void resetPotentialSources(
       @Nonnull Collection<DatanodeDetails> sources) {
     List<DatanodeUsageInfo> usageInfos = new ArrayList<>(sources.size());

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/FindTargetGreedyByNetworkTopology.java

@@ -63,6 +63,7 @@ public FindTargetGreedyByNetworkTopology(
    * network topology.
    * @param source the specified source datanode
    */
+  @Override
   @VisibleForTesting
   public void sortTargetForSource(DatanodeDetails source) {
     Collections.sort(potentialTargets,