[CS-36689] compare merge branch

Author: ishaileshmishra

README.md

@@ -2,11 +2,21 @@
 
 ## Contentstack Management Java SDK
 
-Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. All you have to do is build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
-
-This SDK uses the [Content Management API](https://www.contentstack.com/docs/developers/apis/content-management-api/) (CMA). The CMA is used to manage the content of your Contentstack account. This includes creating, updating, deleting, and fetching content of your account. To use the CMA, you will need to authenticate your users with a [Management Token](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens) or an [Authtoken](https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken). Read more about it in [Authentication](https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication).
-
-Note: By using CMA, you can execute GET requests for fetching content. However, we strongly recommend that you always use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) to deliver content to your web or mobile properties.
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful
+cross-platform applications in their favorite languages. All you have to do is build your application frontend, and
+Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
+
+This SDK uses the [Content Management API](https://www.contentstack.com/docs/developers/apis/content-management-api/) (
+CMA). The CMA is used to manage the content of your Contentstack account. This includes creating, updating, deleting,
+and fetching content of your account. To use the CMA, you will need to authenticate your users with
+a [Management Token](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens) or
+an [Authtoken](https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken). Read
+more about it
+in [Authentication](https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication).
+
+Note: By using CMA, you can execute GET requests for fetching content. However, we strongly recommend that you always
+use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) to deliver
+content to your web or mobile properties.
 
 ### Prerequisite
 
@@ -18,54 +28,56 @@ Install it via maven:
 
 ```java
 <dependency>
- <groupId>com.contentstack.sdk</groupId>
- <artifactId>cms</artifactId>
- <version>{version}</version>
+<groupId>com.contentstack.sdk</groupId>
+<artifactId>cms</artifactId>
+<version>{version}</version>
 </dependency>
 ```
 
 Install it via gradle:
 
 ```java
-implementation 'com.contentstack.sdk:cms:{version}'
+   implementation'com.contentstack.sdk:cms:{version}'
 ```
 
 To import the SDK, use the following command:
 
 ```java
-package com.contentstack.cms;
-
-Contentstack contentstack = new Contentstack.Builder().build();
+    package com.contentstack.cms;
+    Contentstack contentstack=new Contentstack.Builder().build();
 ```
 
 ### Authentication
 
-To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token).
+To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (
+stack-level token).
 
 ### Authtoken
 
-An [Authtoken](https://www.contentstack.com/docs/developers/create-tokens/types-of-tokens/#authentication-tokens-authtokens-) is a read-write token used to make authorized CMA requests, and it is a **user-specific** token.
+An [Authtoken](https://www.contentstack.com/docs/developers/create-tokens/types-of-tokens/#authentication-tokens-authtokens-)
+is a read-write token used to make authorized CMA requests, and it is a **user-specific** token.
 
 ```java
-Contentstack contentstack = new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
+        Contentstack contentstack=new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
 ```
 
 ### Login
 
 To Login to Contentstack by using credentials, you can use the following lines of code:
 
 ```java
-Contentstack contentstack = new Contentstack.Builder().build();
-contentstack.login("EMAIL", "PASSWORD");
+        Contentstack contentstack=new Contentstack.Builder().build();
+        contentstack.login("EMAIL","PASSWORD");
 ```
 
 ### Management Token
 
-[Management Tokens](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens/) are **stack-level** tokens, with no users attached to them.
+[Management Tokens](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens/) are *
+*stack-level** tokens, with no users attached to them.
 
 ```java
-Contentstack  contentstack = new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
-Stack stack = contentstack.stack("API_KEY", "MANAGEMENT_TOKEN");
+        Contentstack contentstack=new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
+        Stack stack=contentstack.stack("API_KEY","MANAGEMENT_TOKEN");
 ```
 
 ### Contentstack Management Java SDK: 5-minute Quickstart
@@ -75,46 +87,46 @@ Stack stack = contentstack.stack("API_KEY", "MANAGEMENT_TOKEN");
 To use the Java CMA SDK, you need to first initialize it. To do this, use the following code:
 
 ```java
-Contentstack contentstack = new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
+   Contentstack contentstack=new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
 ```
 
 #### Fetch Stack Detail
 
 Use the following lines of code to fetch your stack detail using this SDK:
 
 ```java
-Stack stack = contentstack.stack("API_KEY");
-Response<ResponseBody> response = stack.fetch().execute();
+        Stack stack=contentstack.stack("API_KEY");
+        Response<ResponseBody> response=stack.fetch().execute();
 ```
 
 #### Create Entry
 
 To create an entry in a specific content type of a stack, use the following lines of code:
 
 ```java
-Contentstack contentstack = new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
-Stack stack = contentstack.stack("API_KEY");
-JSONObject body = ....
-Response<ResponseBody> response = entry.create(body).execute();
-if (response.isSuccessful()){
-    System.out.println(response.body());
-}
+        Contentstack contentstack=new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
+        Stack stack=contentstack.stack("API_KEY");
+        JSONObject body=....
+        Response<ResponseBody> response=entry.create(body).execute();
+        if(response.isSuccessful()){
+             System.out.println(response.body());
+        }
 ```
 
 #### Create Asset
 
 The following lines of code can be used to upload assets to your stack:
 
 ```java
-Contentstack contentstack = new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
-Stack stack = contentstack.stack("API_KEY");
-Asset asset = stack.asset();
-Response<ResponseBody> response = asset.uploadAsset("filePath", "description").execute();
-if (response.isSuccessful()){
-    System.out.println(response.body());
-}else {
-    System.out.println(response.errorBody());
-}
+        Contentstack contentstack=new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();
+        Stack stack=contentstack.stack("API_KEY");
+        Asset asset=stack.asset();
+        Response<ResponseBody> response=asset.uploadAsset("filePath","description").execute();
+        if(response.isSuccessful()){
+            System.out.println(response.body());
+        }else{
+            System.out.println(response.errorBody());
+        }
 ```
 
 ### Helpful Links
@@ -127,8 +139,14 @@ if (response.isSuccessful()){
 
 Copyright © 2012-2023 [Contentstack](https://www.contentstack.com/). All Rights Reserved
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

changelog.md

@@ -2,15 +2,18 @@
 
 ## v1.0.0
 
-### 30-APR-2023
+### 30-June-2023
 
-- Added support for marketplace API
+- Bug Fixed For Unlocalize An Entry
 - General improvements
-- code coverage improvements
-- code quality improvements
+- Code coverage improvements
+- Code quality improvements
+- Fixed Timeout Issue
 
 ## v0.1.0
 
+### Initial Release
+
 ### 20-OCT-2022
 
 Initial release for Contentstack CMA base Java management SDK

pom.xml

@@ -6,13 +6,13 @@
     <artifactId>cms</artifactId>
     <packaging>jar</packaging>
     <name>contentstack-management-java</name>
-    <version>1.0.0</version>
+    <version>1.0.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 -->
+    <!--    Release the package using mvn clean deploy -->
     <parent>
         <groupId>org.sonatype.oss</groupId>
         <artifactId>oss-parent</artifactId>
@@ -97,6 +97,7 @@
         <nexus-staging-maven-plugin.version>1.6.13</nexus-staging-maven-plugin.version>
         <maven-release-plugin.version>2.5.3</maven-release-plugin.version>
     </properties>
+
     <dependencies>
         <dependency>
             <groupId>com.google.code.gson</groupId>

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

@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.net.Proxy;
+import java.time.Duration;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.logging.Logger;
@@ -447,6 +448,7 @@ public static class Builder {
          */
         protected Proxy proxy;
         private AuthInterceptor authInterceptor;
+
         private String authtoken; // authtoken for client
         private Retrofit instance; // client instance
         private String hostname = Util.HOST; // Default Host for Contentstack API (default: api.contentstack.io)
@@ -554,6 +556,7 @@ public Builder setAuthtoken(String authtoken) {
             return this;
         }
 
+
         /**
          * Build contentstack.
          *
@@ -578,6 +581,7 @@ private OkHttpClient httpClient(Contentstack contentstack, Boolean retryOnFailur
             return new OkHttpClient.Builder().addInterceptor(this.authInterceptor)
                     .addInterceptor(logger())
                     .proxy(this.proxy)
+                    .connectTimeout(Duration.ofSeconds(this.timeout))
                     .retryOnConnectionFailure(retryOnFailure)
                     .build();
         }

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

@@ -21,7 +21,7 @@ public interface Parametron {
      *         the value
      * @return the t
      */
-    public <T> T addParam(@NotNull String key, @NotNull String value);
+    public <T> T addParam(@NotNull String key, @NotNull Object value);
 
     /**
      * Add header t.
@@ -46,7 +46,7 @@ public interface Parametron {
      *         the params
      * @return the t
      */
-    public <T> T addParams(@NotNull HashMap params);
+    public <T> T addParams(@NotNull HashMap<String, Object> params);
 
 
     /**
@@ -58,5 +58,5 @@ public interface Parametron {
      *         the headers
      * @return the t
      */
-    public <T> T addHeaders(@NotNull HashMap headers);
+    public <T> T addHeaders(@NotNull HashMap<String, String> headers);
 }

src/main/java/com/contentstack/cms/core/AuthInterceptor.java

@@ -36,7 +36,7 @@ public void setAuthtoken(String authtoken) {
     @NotNull
     @Override
     public Response intercept(Chain chain) throws IOException {
-        final String xUserAgent = Util.SDK_NAME + "/" + Util.SDK_VERSION;
+        final String xUserAgent = Util.SDK_NAME + "/v" + Util.SDK_VERSION;
         Request.Builder request = chain.request().newBuilder()
                 .header(Util.X_USER_AGENT, xUserAgent)
                 .header(Util.USER_AGENT, Util.defaultUserAgent())

src/main/java/com/contentstack/cms/core/Util.java

@@ -42,6 +42,11 @@ public class Util {
     public static final String MULTIPART = "multipart/form-data";
     public static final String CONTENT_TYPE_VALUE = "application/json";
 
+    // Error Messages
+    public static final String MISSING_INSTALLATION_ID = "installation uid is required";
+    public static final String ERROR_INSTALLATION = "installation uid is required";
+    public static final String MISSING_ORG_ID = "organization uid is required";
+
     Util() throws IllegalAccessException {
         throw new IllegalAccessException("private=modifier");
     }

src/main/java/com/contentstack/cms/marketplace/Marketplace.java

@@ -6,15 +6,16 @@
 import com.contentstack.cms.marketplace.request.AppRequest;
 import org.jetbrains.annotations.NotNull;
 import retrofit2.Retrofit;
+import retrofit2.converter.gson.GsonConverterFactory;
 
 /**
  * The type Marketplace.
  */
 public class Marketplace {
 
-    private final Retrofit client;
+    private Retrofit client;
     private final String orgId;
-    private final String ERR_MESSAGE = "To access the marketplace, the organization_uid parameter is required. " +
+    private final static String ERR_MESSAGE = "To access marketplace instance, the organization_uid parameter is required. " +
             "Please ensure that you provide a valid organization_uid value when calling the marketplace() method";
 
     /**
@@ -24,16 +25,36 @@ public class Marketplace {
      *         the client
      * @param orgId
      *         the org id
+     * @param baseUrl
+     *         the base url
      */
-    public Marketplace(@NotNull Retrofit client, @NotNull String orgId) {
+    public Marketplace(@NotNull Retrofit client, @NotNull String orgId, String baseUrl) {
         this.client = client;
         this.orgId = orgId;
+        if (baseUrl == null) {
+            String parentEndpoint = String.valueOf(this.client.baseUrl());
+            if (parentEndpoint.contains("v3/")) {
+                parentEndpoint = parentEndpoint.replaceFirst("v3/", "");
+            }
+            this.client = updateClient(this.client, parentEndpoint);
+        } else {
+            this.client = updateClient(this.client, baseUrl);
+        }
+
         if (this.orgId.isEmpty()) {
             throw new NullPointerException(ERR_MESSAGE);
         }
     }
 
 
+    private Retrofit updateClient(Retrofit client, String baseUrl) {
+        if (!baseUrl.startsWith("http")) {
+            baseUrl = "https://" + baseUrl;
+        }
+        return client.newBuilder()
+                .baseUrl(baseUrl).addConverterFactory(GsonConverterFactory.create()).build();
+    }
+
     /**
      * App app.
      *
@@ -64,14 +85,26 @@ public Auth authorizations() {
     }
 
     /**
-     * Installation installation.
+     * returns instance of Installation.
      *
-     * @return the instance of installation
+     * @return the instance of {@link Installation}
      */
     public Installation installation() {
         return new Installation(this.client, this.orgId);
     }
 
+
+    /**
+     * returns instance of Installation.
+     *
+     * @param installationId
+     *         the installation uid
+     * @return instance of {@link Installation}
+     */
+    public Installation installation(String installationId) {
+        return new Installation(this.client, this.orgId, installationId);
+    }
+
     /**
      * Request app request.
      *