v1.12.3 Early Access Feature Support

ishaileshmishra · ishaileshmishra · commit f615e816cd3d · 2023-11-16T14:59:21.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## v1.13.0
+
+### Date: 17-Nov-2023
+
+- Updated Latest version of Utils SDK to 1.2.6
+- Snyk Issues fixed
+- Updated dependencies
+- Added support for early access feature
+
 ## v1.12.3
 
 ### Date: 28-SEP-2023
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>java</artifactId>
-    <version>1.12.3</version>
+    <version>1.13.0</version>
     <packaging>jar</packaging>
     <name>contentstack-java</name>
     <description>Java SDK for Contentstack Content Delivery API</description>
@@ -25,18 +25,18 @@
         <loggin.version>5.0.0-alpha.11</loggin.version>
         <jococo-plugin.version>0.8.5</jococo-plugin.version>
         <lombok-source.version>1.18.30</lombok-source.version>
-        <junit-jupiter.version>5.10.0</junit-jupiter.version>
+        <junit-jupiter.version>5.10.1</junit-jupiter.version>
         <junit-jupiter-engine.version>5.8.0-M1</junit-jupiter-engine.version>
         <gson.version>2.8.8</gson.version>
         <json-simple-version>1.1.1</json-simple-version>
         <maven-site-plugin.version>3.3</maven-site-plugin.version>
         <maven-gpg-plugin.version>1.5</maven-gpg-plugin.version>
         <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
         <nexus-staging-maven-plugin.version>1.6.13</nexus-staging-maven-plugin.version>
-        <json-version>20230618</json-version>
+        <json-version>20231013</json-version>
         <jacoco-maven-plugin-version>0.8.7</jacoco-maven-plugin-version>
         <maven-release-plugin-version>2.5.3</maven-release-plugin-version>
-        <contentstack-utils-version>1.2.4</contentstack-utils-version>
+        <contentstack-utils-version>1.2.6</contentstack-utils-version>
     </properties>
 
     <parent>
diff --git a/src/main/java/com/contentstack/sdk/Config.java b/src/main/java/com/contentstack/sdk/Config.java
@@ -1,5 +1,7 @@
 package com.contentstack.sdk;
 
+import lombok.Getter;
+import lombok.Setter;
 import okhttp3.ConnectionPool;
 import org.jetbrains.annotations.NotNull;
 import org.json.JSONObject;
@@ -17,6 +19,7 @@ public class Config {
     protected String livePreviewHash = null;
     protected String livePreviewContentType = null;
     protected String livePreviewEntryUid = null;
+    @Getter
     protected String host = "cdn.contentstack.io";
     protected String version = "v3";
     protected String scheme = "https://";
@@ -26,38 +29,36 @@ public class Config {
     protected JSONObject livePreviewEntry = null;
     protected ContentstackRegion region = ContentstackRegion.US;
     protected String managementToken;
+    @Setter
+    @Getter
     protected String branch;
+    /**
+     * -- SETTER --
+     *  Proxy can be set like below.
+     *
+     * @param proxy Proxy setting, typically a type (http, socks) and a socket address. A Proxy is an immutable object
+     *              <br>
+     *              <br>
+     *              <b>Example:</b><br>
+     *              <br>
+     *              <code>
+     *              java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP,  new InetSocketAddress("proxyHost", "proxyPort"));
+     *              java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("sl.theproxyvpn.io", 80)); Config
+     *              config = new Config(); config.setProxy(proxy);
+     *              </code>
+     */
+    @Setter
     protected Proxy proxy = null;
     protected ConnectionPool connectionPool = new ConnectionPool();
 
     protected List<ContentstackPlugin> plugins = null;
 
-    public String getBranch() {
-        return branch;
-    }
-
-    public void setBranch(String branch) {
-        this.branch = branch;
-    }
-
     /**
-     * Proxy can be set like below.
-     *
-     * @param proxy
-     *         Proxy setting, typically a type (http, socks) and a socket address. A Proxy is an immutable object
-     *         <br>
-     *         <br>
-     *         <b>Example:</b><br>
-     *         <br>
-     *         <code>
-     *         java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP,  new InetSocketAddress("proxyHost", "proxyPort"));
-     *         java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("sl.theproxyvpn.io", 80)); Config
-     *         config = new Config(); config.setProxy(proxy);
-     *         </code>
+     * -- GETTER --
+     * The configuration for the contentstack that contains support for
      */
-    public void setProxy(Proxy proxy) {
-        this.proxy = proxy;
-    }
+    @Getter
+    protected String[] earlyAccess;
 
     /**
      * Returns the Proxy instance
@@ -73,12 +74,9 @@ public Proxy getProxy() {
      * {@link okhttp3.Address} may share a {@link okhttp3.Connection}. This class implements the policy * of which
      * connections to keep open for future use.
      *
-     * @param maxIdleConnections
-     *         the maxIdleConnections default value is 5
-     * @param keepAliveDuration
-     *         the keepAliveDuration default value is 5
-     * @param timeUnit
-     *         the timeUnit default value is TimeUnit. MINUTES
+     * @param maxIdleConnections the maxIdleConnections default value is 5
+     * @param keepAliveDuration  the keepAliveDuration default value is 5
+     * @param timeUnit           the timeUnit default value is TimeUnit. MINUTES
      * @return ConnectionPool
      */
     public ConnectionPool connectionPool(int maxIdleConnections, long keepAliveDuration, TimeUnit timeUnit) {
@@ -98,8 +96,7 @@ public ContentstackRegion getRegion() {
     /**
      * Sets region.
      *
-     * @param region
-     *         the region
+     * @param region the region
      * @return the region
      */
     public ContentstackRegion setRegion(ContentstackRegion region) {
@@ -119,20 +116,10 @@ public void setPlugins(List<ContentstackPlugin> plugins) {
         this.plugins = plugins;
     }
 
-    /**
-     * Gets host.
-     *
-     * @return the host
-     */
-    public String getHost() {
-        return host;
-    }
-
     /**
      * Sets host.
      *
-     * @param hostName
-     *         the host name
+     * @param hostName the host name
      */
     public void setHost(String hostName) {
         if (hostName != null && !hostName.isEmpty()) {
@@ -152,8 +139,7 @@ public String getVersion() {
     /**
      * Enable live preview config.
      *
-     * @param enableLivePreview
-     *         to enable live preview
+     * @param enableLivePreview to enable live preview
      * @return the config
      */
     public Config enableLivePreview(boolean enableLivePreview) {
@@ -164,8 +150,7 @@ public Config enableLivePreview(boolean enableLivePreview) {
     /**
      * Sets live preview host.
      *
-     * @param livePreviewHost
-     *         the live preview host
+     * @param livePreviewHost the live preview host
      * @return the live preview host
      */
     public Config setLivePreviewHost(@NotNull String livePreviewHost) {
@@ -181,8 +166,7 @@ protected Config setLivePreviewEntry(@NotNull JSONObject livePreviewEntry) {
     /**
      * Sets management token.
      *
-     * @param managementToken
-     *         the management token
+     * @param managementToken the management token
      * @return the management token
      */
     public Config setManagementToken(@NotNull String managementToken) {
@@ -197,4 +181,23 @@ public enum ContentstackRegion {
         US, EU, AZURE_NA, AZURE_EU
     }
 
+
+    /**
+     * The configuration for the contentstack that contains support for Early Access Feature
+     *
+     * @param earlyAccessFeatures The list of Early Access Features
+     *                            {@code
+     *                            Config config = new Config();
+     *                            String[] earlyAccess = {"Taxonomy", "Teams", "Terms", "LivePreview"};
+     *                            config.earlyAccess(earlyAccess);
+     *                            Stack stack = Contentstack.stack(API_KEY, DELIVERY_TOKEN, ENV, config);
+     *                            <p>
+     *                            }
+     * @return Config
+     */
+    public Config earlyAccess(@NotNull String[] earlyAccessFeatures) {
+        this.earlyAccess = earlyAccessFeatures;
+        return this;
+    }
+
 }
diff --git a/src/main/java/com/contentstack/sdk/Constants.java b/src/main/java/com/contentstack/sdk/Constants.java
@@ -21,7 +21,7 @@
 public class Constants {
 
     private static final Logger logger = Logger.getLogger(Constants.class.getSimpleName());
-    protected static final String SDK_VERSION = "1.12.3";
+    protected static final String SDK_VERSION = "1.13.0";
     protected static final String ENVIRONMENT = "environment";
     protected static final String CONTENT_TYPE_UID = "content_type_uid";
     protected static final String ENTRY_UID = "entry_uid";
diff --git a/src/main/java/com/contentstack/sdk/Contentstack.java b/src/main/java/com/contentstack/sdk/Contentstack.java
@@ -31,27 +31,23 @@ protected Contentstack() throws IllegalAccessException {
      * key of your stack. <br>
      * Find Your Stack Credentials from Contentstack .
      *
-     * @param stackApiKey
-     *                      The API Key is a unique key assigned to each stack.
-     * @param deliveryToken
-     *                      The Delivery Token is a read-only credential that you
+     * @param stackApiKey   The API Key is a unique key assigned to each stack.
+     * @param deliveryToken The Delivery Token is a read-only credential that you
      *                      can create for different environments of your
      *                      stack
-     * @param environment
-     *                      the environment for the stack
+     * @param environment   the environment for the stack
      * @return the stack
-     * @throws IllegalAccessException
-     *                                the illegal access exception
+     * @throws IllegalAccessException the illegal access exception
      *                                <p>
      *                                <b>Example</b>
      *
      *                                <pre>
-     *                                {
-     *                                    &#64;Code
-     *                                    Stack stack = contentstack.Stack("apiKey", "deliveryToken", "environment");
-     *                                }
+     *                                                                                              {
+     *                                                                                                  &#64;Code
+     *                                                                                                  Stack stack = contentstack.Stack("apiKey", "deliveryToken", "environment");
+     *                                                                                              }
      *
-     *                                </pre>
+     *                                                                                              </pre>
      */
     public static Stack stack(String stackApiKey, String deliveryToken, String environment)
             throws IllegalAccessException {
@@ -66,19 +62,14 @@ public static Stack stack(String stackApiKey, String deliveryToken, String envir
      * create content structures, content entries, users, etc. related to the
      * project.
      *
-     * @param stackApiKey
-     *                      The API Key is a unique key assigned to each stack.
-     * @param deliveryToken
-     *                      The Delivery Token is a read-only credential that you
+     * @param stackApiKey   The API Key is a unique key assigned to each stack.
+     * @param deliveryToken The Delivery Token is a read-only credential that you
      *                      can create for different environments of your
      *                      stack
-     * @param environment
-     *                      the environment for the stack
-     * @param config
-     *                      the config
+     * @param environment   the environment for the stack
+     * @param config        the config
      * @return the stack
-     * @throws IllegalAccessException
-     *                                the illegal access exception <b>Example</b>
+     * @throws IllegalAccessException the illegal access exception <b>Example</b>
      *                                <p>
      *                                { @Code Stack stack =
      *                                contentstack.Stack("apiKey", "deliveryToken",
@@ -115,6 +106,10 @@ private static Stack initializeStack(String stackApiKey, String deliveryToken, S
         if (config.getBranch() != null && !config.getBranch().isEmpty()) {
             stack.setHeader("branch", config.getBranch());
         }
+        if (config.getEarlyAccess() != null && config.getEarlyAccess().length > 0) {
+            String eaValues = String.join(",", config.earlyAccess).replace("\"", "");
+            stack.setHeader("x-header-ea", eaValues);
+        }
         stack.setConfig(config);
         return stack;
     }
diff --git a/src/main/java/com/contentstack/sdk/Stack.java b/src/main/java/com/contentstack/sdk/Stack.java
@@ -276,7 +276,7 @@ public void setHeader(@NotNull String headerKey, @NotNull String headerValue) {
      * @return the string
      */
     public String imageTransform(@NotNull String imageUrl, @NotNull Map<String, Object> parameters) {
-        if (parameters.size() == 0) {
+        if (parameters.isEmpty()) {
             return imageUrl;
         }
         String query = getQueryParam(parameters);
diff --git a/src/test/java/com/contentstack/sdk/TestContentstack.java b/src/test/java/com/contentstack/sdk/TestContentstack.java
@@ -105,4 +105,29 @@ void initStackWithConfigs() throws IllegalAccessException {
         Assertions.assertEquals("cdn.contentstack.io", config.host);
         Assertions.assertNotNull(stack);
     }
+
+
+    @Test
+    void testConfigEarlyAccessSingleFeature() throws IllegalAccessException {
+        Config config = new Config();
+        String[] earlyAccess = {"Taxonomy"};
+        config.earlyAccess(earlyAccess);
+        Stack stack = Contentstack.stack(API_KEY, DELIVERY_TOKEN, ENV, config);
+        Assertions.assertEquals(earlyAccess[0], config.earlyAccess[0]);
+        Assertions.assertNotNull(stack.headers.containsKey("x-header-ea"));
+        Assertions.assertEquals("Taxonomy", stack.headers.get("x-header-ea"));
+
+    }
+
+    @Test
+    void testConfigEarlyAccessMultipleFeature() throws IllegalAccessException {
+        Config config = new Config();
+        String[] earlyAccess = {"Taxonomy", "Teams", "Terms", "LivePreview"};
+        config.earlyAccess(earlyAccess);
+        Stack stack = Contentstack.stack(API_KEY, DELIVERY_TOKEN, ENV, config);
+        Assertions.assertEquals(4, stack.headers.keySet().size());
+        Assertions.assertEquals(earlyAccess[1], config.earlyAccess[1]);
+        Assertions.assertTrue(stack.headers.containsKey("x-header-ea"));
+        Assertions.assertEquals("Taxonomy,Teams,Terms,LivePreview", stack.headers.get("x-header-ea"));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,7 @@ public void setHeader(@NotNull String headerKey, @NotNull String headerValue) {`
`276`	`276`	`* @return the string`
`277`	`277`	`*/`
`278`	`278`	`public String imageTransform(@NotNull String imageUrl, @NotNull Map<String, Object> parameters) {`
`279`		`- if (parameters.size() == 0) {`
	`279`	`+ if (parameters.isEmpty()) {`
`280`	`280`	`return imageUrl;`
`281`	`281`	`}`
`282`	`282`	`String query = getQueryParam(parameters);`