HashStore-java 1.1.0 Release

README.md

@@ -24,6 +24,45 @@ and then install or build the package with `mvn install` or `mvn package`, respe
 
 We also maintain a parallel [Python-based version of HashStore](https://github.com/DataONEorg/hashstore).
 
+## HashStore Client Usage
+
+```sh
+
+# Step 1: Get HashStore Jar file
+$ mvn clean package -Dmaven.test.skip=true
+
+# Get help
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -h
+
+# Step 2:
+## Create a HashStore (long option)
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client --createhashstore --storepath=/path/to/store --storedepth=3 --storewidth=2 --storealgo=SHA-256 --storenamespace=http://ns.dataone.org/service/types/v2.0
+
+## Create a HashStore (short option)
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -chs -store /path/to/store -dp 3 -wp 2 -ap SHA-256 -nsp http://ns.dataone.org/service/types/v2
+
+# Get the checksum of a data object
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -store /path/to/store -getchecksum -pid testpid1 -algo SHA-256
+
+# Store a data object
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -store /path/to/store -storeobject -path /path/to/data.ext -pid testpid1
+
+# Store a metadata object
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -store /path/to/store -storemetadata -path /path/to/metadata.ext -pid testpid1 -format_id http://ns.dataone.org/service/types/v2
+
+# Retrieve a data object
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -store /path/to/store -retrieveobject -pid testpid1
+
+# Retrieve a metadata object
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -store /path/to/store -retrievemetadata -pid testpid1 -format_id http://ns.dataone.org/service/types/v2
+
+# Delete a data object
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -store /path/to/store -deleteobject -pid testpid1
+
+# Delete a metadata file
+$ java -cp ./target/hashstore-1.0-SNAPSHOT.jar org.dataone.hashstore.Client -store /path/to/store -deletemetadata -pid testpid1 -format_id http://ns.dataone.org/service/types/v2
+```
+
 ## License
 
 ```txt

pom.xml

@@ -10,8 +10,7 @@
   <version>1.0-SNAPSHOT</version>
 
   <name>hashstore</name>
-  <!-- FIXME change it to the project's website -->
-  <url>http://www.example.com</url>
+  <url>https://github.com/DataONEorg/hashstore-java</url>
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -26,9 +25,20 @@
       <version>1.2</version>
     </dependency>
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.13.2</version>
+      <groupId>commons-cli</groupId>
+      <artifactId>commons-cli</artifactId>
+      <version>1.5.0</version>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>5.8.2</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <version>5.8.2</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -39,19 +49,88 @@
     <dependency>
       <groupId>com.fasterxml.jackson.dataformat</groupId>
       <artifactId>jackson-dataformat-yaml</artifactId>
-      <version>2.12.2</version>
+      <version>2.15.2</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>
       <version>2.15.2</version>
     </dependency>
+    <dependency>
+      <groupId>org.postgresql</groupId>
+      <artifactId>postgresql</artifactId>
+      <version>42.4.3</version>
+    </dependency>
   </dependencies>
 
   <build>
-    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to
-      parent pom) -->
+    <!-- <pluginManagement> -->
       <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-compiler-plugin</artifactId>
+          <version>3.8.1</version>
+          <configuration>
+              <source>8</source>
+              <target>8</target>
+          </configuration>
+        </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-shade-plugin</artifactId>
+          <version>3.2.1</version>
+          <executions>
+            <execution>
+              <phase>package</phase>
+              <goals>
+                  <goal>shade</goal>
+              </goals>
+              <configuration>
+                <transformers>
+                  <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                    <manifestEntries>
+                        <Main-Class>org.dataone.hashstore.Client</Main-Class>
+                        <Build-Number>${project.version}</Build-Number>
+                    </manifestEntries>
+                  </transformer>
+                </transformers>
+                <!--
+                See https://issues.apache.org/jira/browse/LOG4J2-673
+                and https://stackoverflow.com/questions/48033792/log4j2-error-statuslogger-unrecognized-conversion-specifier
+                -->
+                <filters>
+                  <filter>
+                    <artifact>*:*</artifact>
+                    <excludes>
+                        <exclude>**/Log4j2Plugins.dat</exclude>
+                    </excludes>
+                  </filter>
+                  <filter>
+                      <artifact>*:*</artifact>
+                      <excludes>
+                        <exclude>META-INF/*.SF</exclude>
+                        <exclude>META-INF/*.DSA</exclude>
+                        <exclude>META-INF/*.RSA</exclude>
+                      </excludes>
+                  </filter>
+                </filters>
+              </configuration>
+            </execution>
+          </executions>
+        </plugin>
+        <plugin>
+            <artifactId>maven-jar-plugin</artifactId>
+            <version>3.3.0</version>
+            <executions>
+                <execution>
+                    <id>default-jar</id>
+                    <phase>package</phase>
+                    <goals>
+                        <goal>jar</goal>
+                    </goals>
+                </execution>
+            </executions>
+        </plugin>
         <!-- clean lifecycle, see
         https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
         <plugin>
@@ -64,18 +143,10 @@
           <artifactId>maven-resources-plugin</artifactId>
           <version>3.3.0</version>
         </plugin>
-        <plugin>
-          <artifactId>maven-compiler-plugin</artifactId>
-          <version>3.11.0</version>
-        </plugin>
         <plugin>
           <artifactId>maven-surefire-plugin</artifactId>
           <version>2.22.1</version>
         </plugin>
-        <plugin>
-          <artifactId>maven-jar-plugin</artifactId>
-          <version>3.3.0</version>
-        </plugin>
         <plugin>
           <artifactId>maven-install-plugin</artifactId>
           <version>2.5.2</version>
@@ -95,6 +166,6 @@
           <version>3.4.2</version>
         </plugin>
       </plugins>
-    </pluginManagement>
+    <!-- </pluginManagement> -->
   </build>
 </project>