src: reduce code duplication for files' checksum calculation

Author: kofemann

src/main/java/org/dcache/nearline/cta/CtaCli.java

@@ -1,5 +1,6 @@
 package org.dcache.nearline.cta;
 
+import static org.dcache.nearline.cta.Utils.calculateChecksum;
 import static org.dcache.nearline.cta.CtaNearlineStorage.CTA_ENDPOINT;
 import static org.dcache.nearline.cta.CtaNearlineStorage.CTA_GROUP;
 import static org.dcache.nearline.cta.CtaNearlineStorage.CTA_INSTANCE;
@@ -13,14 +14,11 @@
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import cta.admin.CtaAdmin;
-import diskCacheV111.util.Adler32;
 import io.grpc.InsecureChannelCredentials;
 import io.grpc.netty.shaded.io.grpc.netty.NettyChannelBuilder;
 import io.grpc.netty.shaded.io.netty.channel.nio.NioEventLoopGroup;
 import io.grpc.netty.shaded.io.netty.channel.socket.nio.NioSocketChannel;
 import org.dcache.pool.nearline.spi.FlushRequest;
-import org.dcache.util.Checksum;
-import org.dcache.util.ChecksumType;
 import org.dcache.vehicles.FileAttributes;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -29,8 +27,6 @@
 import java.io.IOException;
 import java.net.InetAddress;
 import java.net.URI;
-import java.nio.ByteBuffer;
-import java.nio.channels.FileChannel;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.attribute.PosixFileAttributeView;
@@ -252,25 +248,6 @@ public void completed(Set<URI> uris) {
                 }
             };
         }
-
-
-        private static Checksum calculateChecksum(File file) throws IOException {
-
-            ByteBuffer bb = ByteBuffer.allocate(8192);
-            var adler = new Adler32();
-            try (FileChannel fc = FileChannel.open(file.toPath())) {
-                while (true) {
-                    bb.clear();
-                    int n = fc.read(bb);
-                    if (n < 0) {
-                        break;
-                    }
-                    bb.flip();
-                    adler.update(bb);
-                }
-                return new Checksum(ChecksumType.ADLER32, adler.digest());
-            }
-        }
     }
 
 

src/main/java/org/dcache/nearline/cta/Utils.java

@@ -0,0 +1,45 @@
+package org.dcache.nearline.cta;
+
+import diskCacheV111.util.Adler32;
+import org.dcache.util.Checksum;
+import org.dcache.util.ChecksumType;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.nio.channels.FileChannel;
+
+/**
+ * This class is a collection of utility methods to reduce code duplication.
+ */
+public class Utils {
+    private Utils(){ /* prevent instantiation */ }
+
+
+    /**
+     * Calculates the ADLER32 checksum of a file.
+     *
+     * @param file the file to calculate the checksum for
+     * @return the ADLER32 checksum of the file
+     * @throws IOException if an I/O error occurs
+     */
+    public static Checksum calculateChecksum(File file) throws IOException {
+
+        ByteBuffer bb = ByteBuffer.allocate(8192);
+        var adler = new Adler32();
+
+        try (FileChannel fc = FileChannel.open(file.toPath())) {
+            while (true) {
+                bb.clear();
+                int n = fc.read(bb);
+                if (n < 0) {
+                    break;
+                }
+                bb.flip();
+                adler.update(bb);
+            }
+
+            return new Checksum(ChecksumType.ADLER32, adler.digest());
+        }
+    }
+}

src/main/java/org/dcache/nearline/cta/xrootd/DataServerHandler.java

@@ -16,6 +16,7 @@
  */
 package org.dcache.nearline.cta.xrootd;
 
+import static org.dcache.nearline.cta.Utils.calculateChecksum;
 import static org.dcache.xrootd.protocol.XrootdProtocol.kXR_ArgInvalid;
 import static org.dcache.xrootd.protocol.XrootdProtocol.kXR_FileNotOpen;
 import static org.dcache.xrootd.protocol.XrootdProtocol.kXR_IOError;
@@ -30,15 +31,13 @@
 
 import com.google.common.net.InetAddresses;
 import com.sun.nio.file.ExtendedOpenOption;
-import diskCacheV111.util.Adler32;
 import diskCacheV111.util.CacheException;
 import io.netty.channel.ChannelHandlerContext;
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.net.InetSocketAddress;
 import java.net.URI;
-import java.nio.ByteBuffer;
 import java.nio.channels.ClosedChannelException;
 import java.nio.channels.FileChannel;
 import java.nio.charset.StandardCharsets;
@@ -48,7 +47,6 @@
 import java.time.Instant;
 import java.util.ArrayList;
 import java.util.Base64;
-import java.util.EnumSet;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
@@ -63,7 +61,6 @@
 import org.dcache.pool.nearline.spi.NearlineRequest;
 import org.dcache.pool.nearline.spi.StageRequest;
 import org.dcache.util.Checksum;
-import org.dcache.util.ChecksumType;
 import org.dcache.util.Strings;
 import org.dcache.util.TimeUtils;
 import org.dcache.xrootd.core.XrootdException;
@@ -599,26 +596,6 @@ private FileStatus statusByHandle(int handle) throws XrootdException {
         }
     }
 
-    private static Checksum calculateChecksum(File file) throws IOException {
-
-        ByteBuffer bb = ByteBuffer.allocate(8192);
-        var adler = new Adler32();
-
-        try (FileChannel fc = FileChannel.open(file.toPath())) {
-            while (true) {
-                bb.clear();
-                int n = fc.read(bb);
-                if (n < 0) {
-                    break;
-                }
-                bb.flip();
-                adler.update(bb);
-            }
-
-            return new Checksum(ChecksumType.ADLER32, adler.digest());
-        }
-    }
-
     private String getPnfsId(NearlineRequest<?> request) {
 
         if (request instanceof StageRequest) {