maven: enabling gpg signing, attaching javadoc and source (#251)

G-Research · Apr 23, 2021 · 91cf590 · 91cf590
1 parent 695d9f3
commit 91cf590
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 6 deletions.
diff --git a/...g-core/src/main/java/uk/co/gresearch/siembol/parsers/netflow/NetflowTransportMessage.java b/...g-core/src/main/java/uk/co/gresearch/siembol/parsers/netflow/NetflowTransportMessage.java
@@ -4,6 +4,8 @@ public interface NetflowTransportMessage<T> {
 
     /**
      * Get an unique global Id that identifies the template in the global store
+     * @param header a netflow header
+     * @param templateId id of the template
      * @return Object of the type T that  will be used as a key in a templates store
      */
 

diff --git a/...-core/src/main/java/uk/co/gresearch/siembol/parsers/netflow/NetflowTransportProvider.java b/...-core/src/main/java/uk/co/gresearch/siembol/parsers/netflow/NetflowTransportProvider.java
@@ -6,8 +6,9 @@ public interface NetflowTransportProvider<T> {
 
     /**
      * Get a netflow transport message from binary data
-     * @param  data byte array that contains netflow packet along with source identification
-     * @return creates NetflowTransportMessage from an byte array data
+     * @param metadata metadata of the netflow message that should contain source identification
+     * @param data byte array that contains netflow packet along with source identification
+     * @return      creates NetflowTransportMessage from an byte array data
      */
     NetflowTransportMessage<T> message(String metadata, byte[] data);
 
@@ -16,8 +17,8 @@ public interface NetflowTransportProvider<T> {
      * Get a template from a template store for parsing netflow dataSets
      * @param transportMessage message with related netflow packet
      * @param header netflow header of the processed packet
-     * @param templateId  from netflow packet
-     * @return template from the store if available otherwise the empty
+     * @param templateId from netflow packet
+     * @return           template from the store if available otherwise the empty
      */
     Optional<List<NetflowField>> getTemplate(NetflowTransportMessage<T> transportMessage,
                                              NetflowHeader header,
@@ -27,9 +28,8 @@ Optional<List<NetflowField>> getTemplate(NetflowTransportMessage<T> transportMes
      * Update templates store by the provided template
      * @param transportMessage message with related netflow packet
      * @param header netflow header of the processed packet
-     * @param templateId tenplateId from netwflow packet
+     * @param templateId templateId from netflow packet
      * @param template template for update
-     * @return creates NetflowTransportMessage from an byte array
      */
 
     void updateTemplate(NetflowTransportMessage<T> transportMessage,

diff --git a/pom.xml b/pom.xml
@@ -141,11 +141,57 @@
                     <stagingProgressTimeoutMinutes>60</stagingProgressTimeoutMinutes>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-gpg-plugin</artifactId>
+                <version>1.6</version>
+                <executions>
+                    <execution>
+                        <id>sign-artifacts</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>sign</goal>
+                        </goals>
+                        <configuration>
+                            <gpgArguments>
+                                <arg>--pinentry-mode</arg>
+                                <arg>loopback</arg>
+                            </gpgArguments>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>versions-maven-plugin</artifactId>
                 <version>2.8.1</version>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.2.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>