Dev/v1.1.0 snapshot (#12)

* dev/v1.1.0-SNAPSHOT Signed-off-by: Edi Permadi <[email protected]> * convert tags to lowercase. close #3 Signed-off-by: Edi Permadi <[email protected]> * made javadoc-pluggin happy * added interface to list tags within container. This closes #2 Signed-off-by: Edi Permadi <[email protected]> * update doc Signed-off-by: Edi Permadi <[email protected]> * addblob parameter checking. This closes #8 Signed-off-by: Edi Permadi <[email protected]> * Added list directory interface. This closes #7 Signed-off-by: Edi Permadi <[email protected]> * added get blob by path interface. This closes #11 Signed-off-by: Edi Permadi <[email protected]> * added interface to decode metadata by id/path. This closes #5 #9 Signed-off-by: Edi Permadi <[email protected]> * update unit test Signed-off-by: Edi Permadi <[email protected]> * added interface to get payload. This closes #6 #10 Signed-off-by: Edi Permadi <[email protected]> * added interface to list blob by tags. This closes #4 Signed-off-by: Edi Permadi <[email protected]>
edipermadi · Oct 3, 2017 · 7c4d8ec · 7c4d8ec
1 parent 8429a6b
commit 7c4d8ec
Show file tree

Hide file tree

Showing 10 changed files with 2,131 additions and 78 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,30 @@
+# Blobfish Changelog
+
+## v1.1.1-SNAPSHOT
+
+**New Features**
+
+- Generate javadoc-jar while building package
+- Generate source-jar while building package
+- Added error_prone checking
+- Tags forced to lowercase during encoding
+- List available tags
+- List directory
+- Get blob by id/path
+- Get blob metadata by id/path
+- Get blob payload by id/path
+- List blob by tags
+
+## v1.0.0 [October 1, 2017]
+
+**Features:**
+- Multiple blob support
+- PBKDF2WithHmacSHA1 based key from password derivation
+- AES/CBC/PKCS5Padding blob protection
+- RSA/ECB/OAEPWithSHA1AndMGF1Padding symmetric key protection
+- SHA256withECDSA blob authentication
+- HmacSHA256 blob integration checking
+- Multiple recipient based key protection
+- Blob mimetype hint
+- Blob tagging
+- Blob path to simulate directory view
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>com.github.edipermadi.security</groupId>
     <artifactId>blobfish</artifactId>
-    <version>1.0.0</version>
+    <version>1.1.0-SNAPSHOT</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -71,6 +71,7 @@
         </extensions>
 
         <plugins>
+            <!-- unit testing -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
@@ -82,6 +83,7 @@
                 </configuration>
             </plugin>
 
+            <!-- compile protobuf source code -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-dependency-plugin</artifactId>
@@ -110,6 +112,7 @@
                 </executions>
             </plugin>
 
+            <!-- compile protobuf source code -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-antrun-plugin</artifactId>
@@ -148,6 +151,7 @@
                 </executions>
             </plugin>
 
+            <!-- generated source-code inclusion -->
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>build-helper-maven-plugin</artifactId>
@@ -167,6 +171,45 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <!-- generate source jar -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <!-- generate javadoc -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.0.0-M1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <sourceFileExcludes>
+                        <sourceFileExclude>
+                            **/com/github/edipermadi/security/blobfish/generated/*.java
+                        </sourceFileExclude>
+                    </sourceFileExcludes>
+                </configuration>
+            </plugin>
+
+            <!-- set java source and target level -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
@@ -175,6 +218,18 @@
                     <source>${java.version}</source>
                     <target>${java.version}</target>
                 </configuration>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.codehaus.plexus</groupId>
+                        <artifactId>plexus-compiler-javac-errorprone</artifactId>
+                        <version>2.8.2</version>
+                    </dependency>
+                    <dependency>
+                        <groupId>com.google.errorprone</groupId>
+                        <artifactId>error_prone_core</artifactId>
+                        <version>2.1.1</version>
+                    </dependency>
+                </dependencies>
             </plugin>
         </plugins>
     </build>

diff --git a/src/main/java/com/github/edipermadi/security/blobfish/Blob.java b/src/main/java/com/github/edipermadi/security/blobfish/Blob.java
@@ -11,7 +11,7 @@ public interface Blob {
     /**
      * Get blob metadata
      *
-     * @return
+     * @return metadata object, see {@link Metadata}
      */
     Metadata getMetadata();
 
@@ -28,10 +28,25 @@ public interface Blob {
      * @author Edi Permadi
      */
     interface Metadata {
+        /**
+         * Get blob path
+         *
+         * @return string of blob path
+         */
         String getPath();
 
+        /**
+         * Get blob tags
+         *
+         * @return set of blob tags (in lower case)
+         */
         Set<String> getTags();
 
+        /**
+         * Blob mime-type hint
+         *
+         * @return string of mime-type detected while encoding
+         */
         String getMimeType();
     }
 }