Feature/version user agent (#15)

Added LICENSE.txt and THIRD_PARTY_LICENSES.txt to runtime jar file and LICENSE.txt to sources and javadoc jars.
Add NoSQL-SpringSDK/version as extension user agent.
Add new method on NosqlDbFactory getLibraryVersion() to return the version of the library.

Author: cezarfx

CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [Unreleased]
+### Added
+- Add a way to return the library version using NosqlDbFactory.getLibraryVersion().
+- Add NoSQL-SpringSDK/version as extension to http user agent.
+- Added LICENSE.txt and THIRD_PARTY_LICENSES.txt to runtime jar file and LICENSE.txt to sources and javadoc jars.
+
 ## [1.4.0]
 ### Added
 - On-premise only, added support for setting durability option on writes.

pom.xml

@@ -287,6 +287,7 @@
                     </execution>
                 </executions>
             </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
@@ -329,6 +330,23 @@
                 </executions>
             </plugin>
 
+            <!-- include info in MANIFEST.MF file -->
+            <plugin>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.2.0</version>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <addDefaultEntries>false</addDefaultEntries>
+                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+                            <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
+                            <addBuildEnvironmentEntries>true</addBuildEnvironmentEntries>
+                            <addClasspath>true</addClasspath>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
+
             <!-- create the tar.gz and .zip archives in package phase -->
             <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>

src/main/java/com/oracle/nosql/spring/data/Constants.java

@@ -28,5 +28,7 @@ public class Constants {
     public static final int NOTSET_TABLE_STORAGE_GB = -1;
     public static final int NOTSET_TABLE_TIMEOUT_MS = 0;
 
+    public static final String USER_AGENT = "NoSQL-SpringSDK";
+
     private Constants() {}
 }

src/main/java/com/oracle/nosql/spring/data/NosqlDbFactory.java

@@ -10,6 +10,7 @@
 
 import oracle.nosql.driver.AuthorizationProvider;
 import oracle.nosql.driver.NoSQLHandle;
+import oracle.nosql.driver.NoSQLHandleConfig;
 import oracle.nosql.driver.NoSQLHandleFactory;
 import oracle.nosql.driver.ops.Request;
 
@@ -18,10 +19,17 @@
 
 import org.springframework.util.Assert;
 
+/**
+ * Factory class for connecting to an Oracle NoSQL Database on premise
+ * database or cloud service.
+ */
 public class NosqlDbFactory {
 
+    private static final String libraryVersion = findVersion();
+    private  static final String userAgent = findUserAgent();
+
     private final NosqlDbConfig config;
-    private NoSQLHandle handle;
+    private volatile NoSQLHandle handle;
 
     public NosqlDbFactory(NosqlDbConfig config) {
         Assert.notNull(config, "NosqlDbConfig should not be null.");
@@ -34,8 +42,20 @@ public NoSQLHandle getNosqlClient() {
         if ( handle == null ) {
             synchronized (this) {
                 if (handle == null) {
-                    handle = NoSQLHandleFactory
-                        .createNoSQLHandle(config.getNosqlHandleConfig());
+                    NoSQLHandleConfig nosqlConfig =
+                        config.getNosqlHandleConfig();
+                    String prevUserAgent =
+                        nosqlConfig.getExtensionUserAgent();
+                    String newUserAgent = null;
+                    if (prevUserAgent == null) {
+                        newUserAgent = userAgent;
+                    } else if (!prevUserAgent.contains(Constants.USER_AGENT)) {
+                        newUserAgent = userAgent + " " + prevUserAgent;
+                    } else {
+                        newUserAgent = prevUserAgent;
+                    }
+                    nosqlConfig.setExtensionUserAgent(newUserAgent);
+                    handle = NoSQLHandleFactory.createNoSQLHandle(nosqlConfig);
                 }
             }
         }
@@ -100,7 +120,7 @@ public static NosqlDbFactory createProxyFactory(String endpoint,
     }
 
     /**
-     * Returns the capacity of the prepared query cache. By default this is set
+     * Returns the capacity of the prepared query cache. By default, this is set
      * to {@link Constants#DEFAULT_QUERY_CACHE_CAPACITY}.
      */
     public int getQueryCacheCapacity() {
@@ -109,22 +129,22 @@ public int getQueryCacheCapacity() {
 
     /**
      * Returns the lifetime of the prepared query cache in milliseconds. By
-     * default this is set to
-     * {@link Constants#DEFAULT_QUERY_CACHE_LIFETIME_MS}.
+     * default, this is set to {@link Constants#DEFAULT_QUERY_CACHE_LIFETIME_MS}.
      */
     public int getQueryCacheLifetime() {
         return config.getQueryCacheLifetime();
     }
 
     /**
-     * Returns the table request timeout in milliseconds. By default this is
+     * Returns the table request timeout in milliseconds. By default, this is
      * set to {@link Constants#DEFAULT_TABLE_REQ_TIMEOUT_MS}
      */
     public int getTableReqTimeout() {
         return config.getTableReqTimeout();
     }
 
-    /** Returns the table request poll interval in milliseconds. By default this
+    /**
+     * Returns the table request poll interval in milliseconds. By default, this
      * is  set to {@link Constants#DEFAULT_TABLE_REQ_POLL_INTEVEL_MS}
      */
     public int getTableReqPollInterval() {
@@ -133,15 +153,16 @@ public int getTableReqPollInterval() {
 
     /**
      * Returns the precision of the Timestamp NoSQL DB type when creating a
-     * new table. By default this is set to
-     * {@link Constants#DEFAULT_TIMESTAMP_PRECISION}.
-     * <br>
+     * new table. By default, this is set to
+     * {@link Constants#DEFAULT_TIMESTAMP_PRECISION}.<p>
+     *
      * In the context of a CREATE TABLE statement, a precision must be
      * explicitly specified. This restriction is to prevent users from
      * inadvertently creating TIMESTAMP values with precision 9 (which takes
-     * more space) when in reality they don't need that high precision.
-     * <br>
-     * See <a href="https://docs.oracle.com/en/database/other-databases/nosql-database/20.2/sqlreferencefornosql/data-type-definitions.html">Timestamp documentation</a> for more details.
+     * more space) when in reality they don't need that high precision.<p>
+     *
+     * See <a href="https://docs.oracle.com/en/database/other-databases/nosql-database/20.2/sqlreferencefornosql/data-type-definitions.html">
+     * Timestamp documentation</a> for more details.
      */
     public int getTimestampPrecision() {
         return config.getTimestampPrecision();
@@ -175,6 +196,28 @@ public int getDefaultWriteUnits() {
         return config.getDefaultWriteUnits();
     }
 
+    /**
+     * Pulls the version string from the manifest. The version is added
+     * by maven.
+     */
+    private static String findVersion() {
+        return NosqlDbFactory.class.getPackage().getImplementationVersion();
+    }
+
+    /**
+     * Returns the current version of the NoSQL DB Sprint Data SDK, as a
+     * string in an x.y.z format.
+     */
+    public static String getLibraryVersion() {
+        return libraryVersion;
+    }
+
+    private static String findUserAgent() {
+        String libVersion = findVersion();
+        return Constants.USER_AGENT +
+            (libVersion == null ? "" : "/" + libVersion);
+    }
+
     /**
      * A simple provider that uses a manufactured id for use by the
      * Cloud Simulator. It is used as a namespace for tables and not
@@ -183,7 +226,7 @@ public int getDefaultWriteUnits() {
     public static class CloudSimProvider implements AuthorizationProvider {
 
         private static final String id = "Bearer exampleId";
-        private static AuthorizationProvider provider =
+        private static final AuthorizationProvider provider =
             new CloudSimProvider();
 
         public static AuthorizationProvider getProvider() {

src/main/java/com/oracle/nosql/spring/data/core/mapping/NosqlCapacityMode.java

@@ -12,7 +12,6 @@
  * @see oracle.nosql.driver.ops.TableLimits.CapacityMode
  */
 public enum NosqlCapacityMode {
-
     PROVISIONED,
     ON_DEMAND
 }