Feature-57: deleteObject Refactor

README.md

@@ -132,7 +132,7 @@ and the store width. Lastly, objects are 'tagged' with a given identifier (ex. p
 identifier (pid)). This process produces reference files, which allow objects to be found and
 retrieved with a given identifier.
 - Note 1: An identifier can only be used once
-- Note 2: Objects are stored once and only once using its content identifier (a checksum generated
+- Note 2: Each object is stored once and only once using its content identifier (a checksum generated
   from using a hashing algorithm). Clients that attempt to store duplicate objects will receive
   the expected ObjectMetadata - with HashStore handling the de-duplication process under the hood.
 
@@ -153,7 +153,7 @@ objectMetadata objInfo = storeObject(InputStream, pid, additionalAlgorithm, chec
 objectMetadata objInfo = storeObject(InputStream);
 // Validate object, if the parameters do not match, the data object associated with the objInfo
 // supplied will be deleted
-deleteInvalidObject(objInfo, checksum, checksumAlgorithn, objSize);
+deleteIfInvalidObject(objInfo, checksum, checksumAlgorithn, objSize);
 // Tag object, makes the object discoverable (find, retrieve, delete)
 tagObject(pid, cid);
 ```

src/main/java/org/dataone/hashstore/HashStore.java

@@ -21,10 +21,11 @@ public interface HashStore {
         /**
          * The {@code storeObject} method is responsible for the atomic storage of objects to
          * disk using a given InputStream. Upon successful storage, the method returns a
-         * (ObjectMetadata) object containing relevant file information, such as the file's id
-         * (which can be used to locate the object on disk), the file's size, and a hex digest
-         * dict of algorithms and checksums. Storing an object with {@code store_object} also
-         * tags an object (creating references) which allow the object to be discoverable.
+         * (@Code ObjectMetadata) object containing relevant file information, such as the file's
+         * id (which can be used by a system administrator -- but not by an API client -- to locate
+         * the object on disk), the file's size, and a hex digest dict of algorithms and
+         * checksums. Storing an object with {@code store_object} also tags an object (creating
+         * references) which allow the object to be discoverable.
          *
          * {@code storeObject} also ensures that an object is stored only once by synchronizing
          * multiple calls and rejecting calls to store duplicate objects. Note, calling {@code

src/main/java/org/dataone/hashstore/HashStoreClient.java

@@ -124,19 +124,18 @@ public static void main(String[] args) throws Exception {
                     String originDirectory = cmd.getOptionValue("sdir");
                     String numObjects = cmd.getOptionValue("nobj");
                     String sizeOfFilesToSkip = cmd.getOptionValue("gbskip");
-                    FileHashStoreUtility.ensureNotNull(objType, "-stype", "HashStoreClient");
-                    FileHashStoreUtility.ensureNotNull(originDirectory, "-sdir", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(objType, "-stype");
+                    FileHashStoreUtility.ensureNotNull(originDirectory, "-sdir");
                     FileHashStoreUtility.ensureNotNull(
-                        action, "-sts, -rav, -dfs", "HashStoreClient"
-                    );
+                        action, "-sts, -rav, -dfs");
 
                     testWithKnbvm(action, objType, originDirectory, numObjects, sizeOfFilesToSkip);
 
                 } else if (cmd.hasOption("getchecksum")) {
                     String pid = cmd.getOptionValue("pid");
                     String algo = cmd.getOptionValue("algo");
-                    FileHashStoreUtility.ensureNotNull(pid, "-pid", "HashStoreClient");
-                    FileHashStoreUtility.ensureNotNull(algo, "-algo", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(pid, "-pid");
+                    FileHashStoreUtility.ensureNotNull(algo, "-algo");
 
                     String hexDigest = hashStore.getHexDigest(pid, algo);
                     System.out.println(hexDigest);
@@ -145,8 +144,8 @@ public static void main(String[] args) throws Exception {
                     System.out.println("Storing object");
                     String pid = cmd.getOptionValue("pid");
                     Path path = Paths.get(cmd.getOptionValue("path"));
-                    FileHashStoreUtility.ensureNotNull(pid, "-pid", "HashStoreClient");
-                    FileHashStoreUtility.ensureNotNull(path, "-path", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(pid, "-pid");
+                    FileHashStoreUtility.ensureNotNull(path, "-path");
 
                     String additional_algo = null;
                     if (cmd.hasOption("algo")) {
@@ -179,9 +178,9 @@ public static void main(String[] args) throws Exception {
                     String pid = cmd.getOptionValue("pid");
                     Path path = Paths.get(cmd.getOptionValue("path"));
                     String formatId = cmd.getOptionValue("format_id");
-                    FileHashStoreUtility.ensureNotNull(pid, "-pid", "HashStoreClient");
-                    FileHashStoreUtility.ensureNotNull(path, "-path", "HashStoreClient");
-                    FileHashStoreUtility.ensureNotNull(formatId, "-formatId", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(pid, "-pid");
+                    FileHashStoreUtility.ensureNotNull(path, "-path");
+                    FileHashStoreUtility.ensureNotNull(formatId, "-formatId");
 
                     InputStream pidObjStream = Files.newInputStream(path);
                     String metadataCid = hashStore.storeMetadata(pidObjStream, pid, formatId);
@@ -191,7 +190,7 @@ public static void main(String[] args) throws Exception {
 
                 } else if (cmd.hasOption("retrieveobject")) {
                     String pid = cmd.getOptionValue("pid");
-                    FileHashStoreUtility.ensureNotNull(pid, "-pid", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(pid, "-pid");
 
                     InputStream objStream = hashStore.retrieveObject(pid);
                     byte[] buffer = new byte[1000];
@@ -205,8 +204,8 @@ public static void main(String[] args) throws Exception {
                 } else if (cmd.hasOption("retrievemetadata")) {
                     String pid = cmd.getOptionValue("pid");
                     String formatId = cmd.getOptionValue("format_id");
-                    FileHashStoreUtility.ensureNotNull(pid, "-pid", "HashStoreClient");
-                    FileHashStoreUtility.ensureNotNull(formatId, "-formatId", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(pid, "-pid");
+                    FileHashStoreUtility.ensureNotNull(formatId, "-formatId");
 
                     InputStream metadataStream = hashStore.retrieveMetadata(pid, formatId);
                     byte[] buffer = new byte[1000];
@@ -221,16 +220,16 @@ public static void main(String[] args) throws Exception {
 
                 } else if (cmd.hasOption("deleteobject")) {
                     String pid = cmd.getOptionValue("pid");
-                    FileHashStoreUtility.ensureNotNull(pid, "-pid", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(pid, "-pid");
 
                     hashStore.deleteObject(pid);
                     System.out.println("Object for pid (" + pid + ") has been deleted.");
 
                 } else if (cmd.hasOption("deletemetadata")) {
                     String pid = cmd.getOptionValue("pid");
                     String formatId = cmd.getOptionValue("format_id");
-                    FileHashStoreUtility.ensureNotNull(pid, "-pid", "HashStoreClient");
-                    FileHashStoreUtility.ensureNotNull(formatId, "-formatId", "HashStoreClient");
+                    FileHashStoreUtility.ensureNotNull(pid, "-pid");
+                    FileHashStoreUtility.ensureNotNull(formatId, "-formatId");
 
                     hashStore.deleteMetadata(pid, formatId);
                     System.out.println(
@@ -358,11 +357,11 @@ private static void createNewHashStore(
         String storePath, String storeDepth, String storeWidth, String storeAlgorithm,
         String storeNameSpace
     ) throws HashStoreFactoryException, IOException {
-        FileHashStoreUtility.ensureNotNull(storePath, "storePath", "HashStoreClient");
-        FileHashStoreUtility.ensureNotNull(storeDepth, "storeDepth", "HashStoreClient");
-        FileHashStoreUtility.ensureNotNull(storeWidth, "storeWidth", "HashStoreClient");
-        FileHashStoreUtility.ensureNotNull(storeAlgorithm, "storeAlgorithm", "HashStoreClient");
-        FileHashStoreUtility.ensureNotNull(storeNameSpace, "storeNameSpace", "HashStoreClient");
+        FileHashStoreUtility.ensureNotNull(storePath, "storePath");
+        FileHashStoreUtility.ensureNotNull(storeDepth, "storeDepth");
+        FileHashStoreUtility.ensureNotNull(storeWidth, "storeWidth");
+        FileHashStoreUtility.ensureNotNull(storeAlgorithm, "storeAlgorithm");
+        FileHashStoreUtility.ensureNotNull(storeNameSpace, "storeNameSpace");
 
         Properties storeProperties = new Properties();
         storeProperties.setProperty("storePath", storePath);