Merge pull request #37 from contentstack/taxonomy

Taxonomy :  Taxonomy, Team, Keep Alive Duration and Snyk Issues

Author: Shailesh Mishra

.env

@@ -0,0 +1 @@
+dev-host=***REMOVED***

.github/workflows/sast-scan.yml

@@ -7,13 +7,14 @@
     <artifactId>cms</artifactId>
     <packaging>jar</packaging>
     <name>contentstack-management-java</name>
-    <version>1.0.0</version>
+    <version>1.1.0-SNAPSHOT</version>
     <description>Contentstack Java Management SDK for Content Management API, Contentstack is a headless CMS with an
         API-first approach
     </description>
     <url>https://github.com/contentstack/contentstack-management-java/</url>
 
-    <!--    Release the package using mvn clean deploy -->
+    <!--mvn versions:display-dependency-updates-->
+    <!--Release the package using mvn clean deploy -->
     <parent>
         <groupId>org.sonatype.oss</groupId>
         <artifactId>oss-parent</artifactId>
@@ -87,15 +88,14 @@
         <maven-source-plugin.version>2.2.1</maven-source-plugin.version>
         <maven-javadoc-plugin.version>3.0.0</maven-javadoc-plugin.version>
         <dotenv-source.version>5.2.2</dotenv-source.version>
-        <rxjava-source.version>3.1.6</rxjava-source.version>
+        <rxjava-source.version>3.1.8</rxjava-source.version>
         <retrofit-source.version>2.9.0</retrofit-source.version>
         <converter-gson-version>2.9.0</converter-gson-version>
-        <logging.version>4.10.0</logging.version>
+        <logging.version>5.0.0-alpha.11</logging.version>
         <jococo-plugin.version>0.8.7</jococo-plugin.version>
-        <lombok-source.version>1.18.28</lombok-source.version>
-        <junit-jupiter.version>5.9.2</junit-jupiter.version>
+        <lombok-source.version>1.18.30</lombok-source.version>
+        <junit-jupiter.version>5.10.0</junit-jupiter.version>
         <junit-jupiter-engine.version>5.8.0-M1</junit-jupiter-engine.version>
-        <junit-vintage-engine.version>5.9.2</junit-vintage-engine.version>
         <gson.version>2.10.1</gson.version>
         <maven-site-plugin.version>3.3</maven-site-plugin.version>
         <maven-gpg-plugin.version>1.5</maven-gpg-plugin.version>
@@ -162,7 +162,13 @@
         <dependency>
             <groupId>org.junit.vintage</groupId>
             <artifactId>junit-vintage-engine</artifactId>
-            <version>${junit-vintage-engine.version}</version>
+            <version>${junit-jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>5.6.0</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -328,6 +334,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-pdf-plugin</artifactId>
+                <version>1.6.1</version>
                 <executions>
                     <execution>
                         <id>pdf</id>

.github/workflows/sca-scan.yml

@@ -5,14 +5,13 @@
 import java.util.HashMap;
 
 /**
- * The interface @{@link BaseImplementation}
+ * The interface BaseImplementation
  */
-public interface BaseImplementation {
+public interface BaseImplementation<T> {
 
     /**
      * The function adds a parameter to a collection using a key-value pair.
      *
-     * @param <T>   the type of the parameter
      * @param key   A string representing the key of the parameter. It cannot be
      *              null and must be
      *              provided as a non-null value.
@@ -21,12 +20,11 @@ public interface BaseImplementation {
      *              object as its value.
      * @return The method is returning an object of type T.
      */
-    <T> T addParam(@NotNull String key, @NotNull Object value);
+     T addParam(@NotNull String key, @NotNull Object value);
 
     /**
      * The function adds a header with a key-value pair to a request.
      *
-     * @param <T>   the type of the parameter
      * @param key   The key parameter is a string that represents the name or
      *              identifier of the header.
      *              It is used to specify the type of information being sent in the
@@ -35,30 +33,28 @@ public interface BaseImplementation {
      *              header.
      * @return The method is returning an object of type T.
      */
-    <T> T addHeader(@NotNull String key, @NotNull String value);
+    T addHeader(@NotNull String key, @NotNull String value);
 
     /**
      * The function "addParams" takes a HashMap of String keys and Object values as
      * input and returns a
      * generic type T.
      *
-     * @param <T>    the type of the parameter
      * @param params The "params" parameter is a HashMap that maps String keys to
      *               Object values. It is
      *               annotated with @NotNull, indicating that it cannot be null.
      * @return The method is returning an object of type T.
      */
-    <T> T addParams(@NotNull HashMap<String, Object> params);
+     T addParams(@NotNull HashMap<String, Object> params);
 
     /**
      * The function adds headers to a HashMap.
      *
-     * @param <T>     the type of the parameter
      * @param headers A HashMap containing key-value pairs of headers, where the key
      *                is a String
      *                representing the header name and the value is a String
      *                representing the header value.
      * @return The method is returning an object of type T.
      */
-    <T> T addHeaders(@NotNull HashMap<String, String> headers);
+     T addHeaders(@NotNull HashMap<String, String> headers);
 }

pom.xml

@@ -8,6 +8,7 @@
 import com.contentstack.cms.stack.Stack;
 import com.contentstack.cms.user.User;
 import com.google.gson.Gson;
+import okhttp3.ConnectionPool;
 import okhttp3.OkHttpClient;
 import okhttp3.ResponseBody;
 import okhttp3.logging.HttpLoggingInterceptor;
@@ -22,6 +23,7 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
+import java.util.concurrent.TimeUnit;
 import java.util.logging.Logger;
 
 import static com.contentstack.cms.core.Util.*;
@@ -467,6 +469,12 @@ public static class Builder {
         private int timeout = Util.TIMEOUT; // Default timeout 30 seconds
         private Boolean retry = Util.RETRY_ON_FAILURE;// Default base url for contentstack
 
+        /**
+         * Default ConnectionPool holds up to 5 idle connections which
+         * will be evicted after 5 minutes of inactivity.
+         */
+        private ConnectionPool connectionPool = new ConnectionPool(); // Connection
+
         /**
          * Instantiates a new Builder.
          */
@@ -479,14 +487,13 @@ public Builder() {
          * Proxy(Proxy.Type.HTTP, new
          * InetSocketAddress(proxyHost, proxyPort));
          * <br>
-         *
-         * <pre>
-         * {
-         *     Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
-         *     Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
+         * <p>
+         * {@code
+         * <p>
+         * Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
+         * Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
+         * <p>
          * }
-         * </pre>
-         *
          * @param proxy the proxy
          * @return the Builder instance
          */
@@ -550,6 +557,36 @@ public Builder setTimeout(int timeout) {
             return this;
         }
 
+
+        /**
+         * Create a new connection pool with tuning parameters appropriate for a single-user application.
+         * The tuning parameters in this pool are subject to change in future OkHttp releases. Currently,
+         * this pool holds up to 5 idle connections which will be evicted after 5 minutes of inactivity.
+         * <p>
+         * <p>
+         * public ConnectionPool() {
+         * this(5, 5, TimeUnit.MINUTES);
+         * }
+         *
+         * @param maxIdleConnections Maximum number of idle connections
+         * @param keepAliveDuration  The Keep Alive Duration
+         * @param timeUnit           A TimeUnit represents time durations at a given unit of granularity and provides utility methods to convert across units
+         * @return instance of Builder
+         * <p>
+         * Example:
+         * {@code
+         * Contentstack cs = new Contentstack.Builder()
+         * .setAuthtoken(AUTHTOKEN)
+         * .setConnectionPool(5, 400, TimeUnit.MILLISECONDS)
+         * .setHost("host")
+         * .build();
+         * Connection}
+         */
+        public Builder setConnectionPool(int maxIdleConnections, int keepAliveDuration, TimeUnit timeUnit) {
+            this.connectionPool = new ConnectionPool(maxIdleConnections, keepAliveDuration, timeUnit);
+            return this;
+        }
+
         /**
          * Sets authtoken for the client
          *
@@ -582,7 +619,9 @@ private void validateClient(Contentstack contentstack) {
 
         private OkHttpClient httpClient(Contentstack contentstack, Boolean retryOnFailure) {
             this.authInterceptor = contentstack.interceptor = new AuthInterceptor();
-            return new OkHttpClient.Builder().addInterceptor(this.authInterceptor)
+            return new OkHttpClient.Builder()
+                    .connectionPool(this.connectionPool)
+                    .addInterceptor(this.authInterceptor)
                     .addInterceptor(logger())
                     .proxy(this.proxy)
                     .connectTimeout(Duration.ofSeconds(this.timeout))

src/main/java/com/contentstack/cms/BaseImplementation.java

@@ -8,9 +8,14 @@
  * @since 2022-10-20
  */
 public class CMARuntimeException extends Exception {
-    // The code `public CMARuntimeException(String message) { super(message); }` is
-    // defining a constructor
-    // for the `CMARuntimeException` class.
+
+    /**
+     * The code `public CMARuntimeException(String message) { super(message); }` is
+     * defining a constructor
+     * for the `CMARuntimeException` class.
+     *
+     * @param message the message for exception
+     */
     public CMARuntimeException(String message) {
         super(message);
     }

src/main/java/com/contentstack/cms/Contentstack.java

@@ -1,5 +1,6 @@
 package com.contentstack.cms.organization;
 
+import com.contentstack.cms.BaseImplementation;
 import okhttp3.ResponseBody;
 import org.jetbrains.annotations.NotNull;
 import org.json.simple.JSONObject;
@@ -19,7 +20,7 @@
  * @version v0.1.0
  * @since 2022-10-20
  */
-public class Organization {
+public class Organization implements BaseImplementation<Organization> {
 
     private final OrganizationService service;
     protected HashMap<String, String> headers;
@@ -65,6 +66,18 @@ public Organization addHeader(@NotNull String key, @NotNull String value) {
         return this;
     }
 
+    @Override
+    public Organization addParams(@NotNull HashMap<String, Object> params) {
+        this.params.putAll(params);
+        return this;
+    }
+
+    @Override
+    public Organization addHeaders(@NotNull HashMap<String, String> headers) {
+        this.headers.putAll(headers);
+        return this;
+    }
+
     /**
      * Sets header for the request
      *
@@ -89,17 +102,6 @@ protected Organization clearParams() {
         return this;
     }
 
-    /**
-     * Sets header for the request
-     *
-     * @param key header key for the request
-     * @return instance of {@link Organization}
-     */
-    public Organization removeParam(@NotNull String key) {
-        this.params.remove(key);
-        return this;
-    }
-
     /**
      * <b>Gets all organizations.</b><br>
      * The <b>Get all organizations</b> call lists all organizations related to the