SLDSS-6468: Improve proxy using in Java SDK

Author: alexburchak

api-sdk/artifacts/smartling-api-sdk-1.3.0.zip

@@ -1,10 +1,10 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-  <modelVersion>4.0.0</modelVersion>
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
 
     <groupId>smartling</groupId>
     <artifactId>smartling-api-sdk</artifactId>
-    <version>1.2.0</version>
+    <version>1.3.0</version>
     <packaging>jar</packaging>
 
     <build>
@@ -123,7 +123,7 @@
 
     <name>smartling-api-sdk</name>
     <url>http://maven.apache.org</url>
-    
+
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <spring.version>3.0.5.RELEASE</spring.version>
@@ -178,4 +178,4 @@
             <version>2.1</version>
         </dependency>
     </dependencies>
-</project>
+</project>

api-sdk/pom.xml

@@ -20,18 +20,22 @@
 /**
  * Utility class for handling dates with the Smartling Translation API.
  */
-public class DateFormatter
+public abstract class DateFormatter
 {
     /** Date format used by the Smartling Translation API */
     private static final String API_DATE_FORMAT = "YYYY-MM-DDThh:mm:ss";
 
+    private DateFormatter()
+    {
+    }
+
     /**
      * Simple method to format a date into the string format used by the Smartling Translation API.
      *
      * @param date the date to format
      * @return formatted string version of the date or null if the date is null.
      */
-    public static final String formatDate(Date date)
+    public static String formatDate(Date date)
     {
         if (null == date)
             return null;

api-sdk/src/main/java/com/smartling/api/sdk/file/DateFormatter.java

@@ -1,4 +1,5 @@
-/* Copyright 2012 Smartling, Inc.
+/*
+ * Copyright 2012 Smartling, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this work except in compliance with the License.
@@ -10,7 +11,8 @@
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
- * limitations under the License. */
+ * limitations under the License.
+ */
 package com.smartling.api.sdk.file;
 
 import com.smartling.api.sdk.file.response.ApiResponse;
@@ -88,4 +90,4 @@ public interface FileApiClientAdapter
      * @throws FileApiException if a non success is returned from the service.
      */
     ApiResponse<EmptyResponse> renameFile(String fileUri, String newFileUri) throws FileApiException;
-}
+}

api-sdk/src/main/java/com/smartling/api/sdk/file/FileApiClientAdapter.java

@@ -1,4 +1,5 @@
-/* Copyright 2012 Smartling, Inc.
+/*
+ * Copyright 2012 Smartling, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this work except in compliance with the License.
@@ -10,7 +11,8 @@
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
- * limitations under the License. */
+ * limitations under the License.
+ */
 package com.smartling.api.sdk.file;
 
 import static com.smartling.api.sdk.file.FileApiParams.API_KEY;
@@ -35,6 +37,7 @@
 import com.google.gson.reflect.TypeToken;
 import com.smartling.api.sdk.file.response.ApiResponse;
 import com.smartling.api.sdk.file.response.ApiResponseWrapper;
+import com.smartling.api.sdk.file.response.Data;
 import com.smartling.api.sdk.file.response.EmptyResponse;
 import com.smartling.api.sdk.file.response.FileList;
 import com.smartling.api.sdk.file.response.FileStatus;
@@ -44,7 +47,6 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.StringWriter;
-import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -101,6 +103,8 @@ public class FileApiClientAdapterImpl implements FileApiClientAdapter
     private String              apiKey;
     private String              projectId;
 
+    private ProxyConfiguration  proxyConfiguration;
+
     /**
      * Instantiate a {@link FileApiClientAdapterImpl} using the production mode setting (non sandbox).
      *
@@ -112,6 +116,18 @@ public FileApiClientAdapterImpl(String apiKey, String projectId)
         this(SMARTLING_API_URL, apiKey, projectId);
     }
 
+    /**
+     * Instantiate a {@link FileApiClientAdapterImpl} using the production mode setting (non sandbox).
+     *
+     * @param apiKey your apiKey. Can be found at https://dashboard.smartling.com/settings/api
+     * @param projectId your projectId. Can be found at https://dashboard.smartling.com/settings/api
+     * @param proxyConfiguration proxy configuration, pass {@code NULL} to never use proxy
+     */
+    public FileApiClientAdapterImpl(String apiKey, String projectId, ProxyConfiguration proxyConfiguration)
+    {
+        this(SMARTLING_API_URL, apiKey, projectId, proxyConfiguration);
+    }
+
     /**
      * Instantiate a {@link FileApiClientAdapterImpl}.
      *
@@ -127,6 +143,22 @@ public FileApiClientAdapterImpl(boolean productionMode, String apiKey, String pr
         this(productionMode ? SMARTLING_API_URL : SMARTLING_SANDBOX_API_URL, apiKey, projectId);
     }
 
+    /**
+     * Instantiate a {@link FileApiClientAdapterImpl}.
+     *
+     * @param productionMode True if the production version of the api should be used, false if the Sandbox should be used.
+     * It is recommended when first integrating your application with the API, that you use the Sandbox and not the production version.
+     * For more information on the Sandbox, please see https://docs.smartling.com.
+     *
+     * @param apiKey your apiKey. Can be found at https://dashboard.smartling.com/settings/api
+     * @param projectId your projectId. Can be found at https://dashboard.smartling.com/settings/api
+     * @param proxyConfiguration proxy configuration, pass {@code NULL} to never use proxy
+     */
+    public FileApiClientAdapterImpl(boolean productionMode, String apiKey, String projectId, ProxyConfiguration proxyConfiguration)
+    {
+        this(productionMode ? SMARTLING_API_URL : SMARTLING_SANDBOX_API_URL, apiKey, projectId, proxyConfiguration);
+    }
+
     /**
      * Instantiate a {@link FileApiClientAdapterImpl}.
      *
@@ -135,6 +167,19 @@ public FileApiClientAdapterImpl(boolean productionMode, String apiKey, String pr
      * @param projectId your projectId. Can be found at https://dashboard.smartling.com/settings/api
      */
     public FileApiClientAdapterImpl(String baseApiUrl, String apiKey, String projectId)
+    {
+        this(baseApiUrl, apiKey, projectId, null);
+    }
+
+    /**
+     * Instantiate a {@link FileApiClientAdapterImpl}.
+     *
+     * @param baseApiUrl the apiUrl to use for interacting with the Smartling Translation API.
+     * @param apiKey your apiKey. Can be found at https://dashboard.smartling.com/settings/api
+     * @param projectId your projectId. Can be found at https://dashboard.smartling.com/settings/api
+     * @param proxyConfiguration proxy configuration, pass {@code NULL} to never use proxy
+     */
+    public FileApiClientAdapterImpl(String baseApiUrl, String apiKey, String projectId, ProxyConfiguration proxyConfiguration)
     {
         Assert.notNull(baseApiUrl, "Api url is required");
         Assert.notNull(apiKey, "apiKey is required");
@@ -143,64 +188,69 @@ public FileApiClientAdapterImpl(String baseApiUrl, String apiKey, String project
         this.baseApiUrl = baseApiUrl;
         this.apiKey = apiKey;
         this.projectId = projectId;
+        this.proxyConfiguration = proxyConfiguration;
     }
 
+    @Override
     public StringResponse getFile(String fileUri, String locale, RetrievalType retrievalType) throws FileApiException
     {
         String params = buildParamsQuery(new BasicNameValuePair(FILE_URI, fileUri), new BasicNameValuePair(LOCALE, locale),
                                          new BasicNameValuePair(RETRIEVAL_TYPE, null == retrievalType ? null : retrievalType.name()));
         HttpGet getRequest = new HttpGet(buildUrl(GET_FILE_API_URL, params));
-        StringResponse response = executeHttpcall(getRequest);
-
-        return response;
+        return executeHttpCall(getRequest);
     }
 
+    @Override
     public ApiResponse<FileList> getFilesList(FileListSearchParams fileListSearchParams) throws FileApiException
     {
         String params = buildFileListParams(fileListSearchParams);
         HttpGet getRequest = new HttpGet(buildUrl(GET_FILE_LIST_API_URL, params));
-        StringResponse response = executeHttpcall(getRequest);
+        StringResponse response = executeHttpCall(getRequest);
 
-        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<FileList>>() {}.getType());
+        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<FileList>>(){});
     }
 
+    @Override
     public ApiResponse<FileStatus> getFileStatus(String fileUri, String locale) throws FileApiException
     {
         String params = buildParamsQuery(new BasicNameValuePair(FILE_URI, fileUri), new BasicNameValuePair(LOCALE, locale));
         HttpGet getRequest = new HttpGet(buildUrl(GET_FILE_STATUS_API_URL, params));
-        StringResponse response = executeHttpcall(getRequest);
+        StringResponse response = executeHttpCall(getRequest);
 
-        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<FileStatus>>() {}.getType());
+        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<FileStatus>>(){});
     }
 
+    @Override
     public ApiResponse<UploadData> uploadFile(FileType fileType, String fileUri, File fileToUpload, Boolean approveContent, String fileEncoding, String callbackUrl)
             throws FileApiException
     {
         String params = buildParamsQuery(new BasicNameValuePair(FILE_URI, fileUri), new BasicNameValuePair(FILE_TYPE, fileType.getIdentifier()),
                                          new BasicNameValuePair(APPROVED, null == approveContent ? null : Boolean.toString(approveContent)),
                                          new BasicNameValuePair(CALLBACK_URL, callbackUrl));
         HttpPost httpPostFile = createFileUploadHttpPostRequest(params, fileToUpload, fileEncoding);
-        StringResponse response = executeHttpcall(httpPostFile);
+        StringResponse response = executeHttpCall(httpPostFile);
 
-        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<UploadData>>() {}.getType());
+        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<UploadData>>(){});
     }
 
+    @Override
     public ApiResponse<EmptyResponse> deleteFile(String fileUri) throws FileApiException
     {
         String params = buildParamsQuery(new BasicNameValuePair(FILE_URI, fileUri));
         HttpDelete httpDeleteFileRequest = new HttpDelete(buildUrl(DELETE_FILE_URL, params));
-        StringResponse response = executeHttpcall(httpDeleteFileRequest);
+        StringResponse response = executeHttpCall(httpDeleteFileRequest);
 
-        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<EmptyResponse>>() {}.getType());
+        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<EmptyResponse>>(){});
     }
 
+    @Override
     public ApiResponse<EmptyResponse> renameFile(String fileUri, String newFileUri) throws FileApiException
     {
         String params = buildParamsQuery(new BasicNameValuePair(FILE_URI, fileUri), new BasicNameValuePair(NEW_FILE_URI, newFileUri));
         HttpPost httpPostRequest = new HttpPost(buildUrl(RENAME_FILE_URL, params));
-        StringResponse response = executeHttpcall(httpPostRequest);
+        StringResponse response = executeHttpCall(httpPostRequest);
 
-        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<EmptyResponse>>() {}.getType());
+        return getApiResponse(response.getContents(), new TypeToken<ApiResponseWrapper<EmptyResponse>>(){});
     }
 
     private HttpPost createFileUploadHttpPostRequest(String apiParameters, File fileToUpload, String fileEncoding)
@@ -217,12 +267,12 @@ private HttpPost createFileUploadHttpPostRequest(String apiParameters, File file
 
     private String buildUrl(String apiServerUrl, String apiParameters)
     {
-        StringBuffer urlWithParameters = new StringBuffer(String.format(apiServerUrl, baseApiUrl));
+        StringBuilder urlWithParameters = new StringBuilder(String.format(apiServerUrl, baseApiUrl));
         urlWithParameters.append(apiParameters);
         return urlWithParameters.toString();
     }
 
-    private StringResponse executeHttpcall(HttpRequestBase httpRequest) throws FileApiException
+    private StringResponse executeHttpCall(HttpRequestBase httpRequest) throws FileApiException
     {
         HttpClient httpClient = null;
         try
@@ -249,30 +299,46 @@ private StringResponse executeHttpcall(HttpRequestBase httpRequest) throws FileA
 
     private void setupProxy(HttpClient httpClient)
     {
-        HttpHost proxy;
-        String protocol = null;
-
-        if(StringUtils.isNotBlank(System.getProperty(SCHEME_HTTPS + PROPERTY_SUFFIX_PROXY_HOST)) && StringUtils.isNotBlank(System.getProperty(SCHEME_HTTPS + PROPERTY_SUFFIX_PROXY_PORT)))
-            protocol = SCHEME_HTTPS;
-        else if(StringUtils.isNotBlank(System.getProperty(SCHEME_HTTP + PROPERTY_SUFFIX_PROXY_HOST)) && StringUtils.isNotBlank(System.getProperty(SCHEME_HTTP + PROPERTY_SUFFIX_PROXY_PORT)))
-            protocol = SCHEME_HTTP;
+        String proxyHost = null;
+        Integer proxyPort = null;
+        String proxyUsername = null;
+        String proxyPassword = null;
 
-        if(null != protocol)
+        if (proxyConfiguration != null)
+        {
+            proxyHost = proxyConfiguration.getHost();
+            proxyPort = proxyConfiguration.getPort();
+            proxyUsername = proxyConfiguration.getUsername();
+            proxyPassword = proxyConfiguration.getPassword();
+        }
+        else
         {
-            String proxyHost = System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_HOST);
-            Integer proxyPort = Integer.valueOf(System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_PORT));
-            String proxyUsername = System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_USERNAME);
-            String proxyPassword = System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_PASSWORD);
+            String protocol = null;
+            if (StringUtils.isNotBlank(System.getProperty(SCHEME_HTTPS + PROPERTY_SUFFIX_PROXY_HOST)) && StringUtils.isNotBlank(System.getProperty(SCHEME_HTTPS + PROPERTY_SUFFIX_PROXY_PORT)))
+                protocol = SCHEME_HTTPS;
+            else if (StringUtils.isNotBlank(System.getProperty(SCHEME_HTTP + PROPERTY_SUFFIX_PROXY_HOST)) && StringUtils.isNotBlank(System.getProperty(SCHEME_HTTP + PROPERTY_SUFFIX_PROXY_PORT)))
+                protocol = SCHEME_HTTP;
 
-            if(StringUtils.isNotBlank(proxyUsername) && StringUtils.isNotBlank(proxyPassword) && httpClient instanceof DefaultHttpClient)
+            if (protocol != null)
+            {
+                proxyHost = System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_HOST);
+                proxyPort = Integer.valueOf(System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_PORT));
+                proxyUsername = System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_USERNAME);
+                proxyPassword = System.getProperty(protocol + PROPERTY_SUFFIX_PROXY_PASSWORD);
+            }
+        }
+
+        if (proxyHost != null && proxyPort != null)
+        {
+            if (StringUtils.isNotBlank(proxyUsername) && StringUtils.isNotBlank(proxyPassword) && httpClient instanceof DefaultHttpClient)
             {
                 ((DefaultHttpClient)httpClient).getCredentialsProvider().setCredentials(
-                        new AuthScope(proxyHost, proxyPort, protocol),
+                        new AuthScope(proxyHost, proxyPort),
                         new UsernamePasswordCredentials(proxyUsername, proxyPassword)
                 );
             }
 
-            proxy = new HttpHost(proxyHost, proxyPort, protocol);
+            HttpHost proxy = new HttpHost(proxyHost, proxyPort);
             httpClient.getParams().setParameter(ConnRoutePNames.DEFAULT_PROXY, proxy);
         }
     }
@@ -321,10 +387,9 @@ private List<BasicNameValuePair> getNameValuePairs(String name, List<String> val
         return nameValuePairs;
     }
 
-    @SuppressWarnings("rawtypes")
-    private ApiResponse getApiResponse(String response, Type responseType)
+    private <T extends Data> ApiResponse<T> getApiResponse(String response, TypeToken<ApiResponseWrapper<T>> responseType)
     {
-        ApiResponseWrapper responseWrapper = new Gson().fromJson(response, responseType);
+        ApiResponseWrapper<T> responseWrapper = new Gson().fromJson(response, responseType.getType());
         return responseWrapper.getResponse();
     }
 

api-sdk/src/main/java/com/smartling/api/sdk/file/FileApiClientAdapterImpl.java

@@ -1,4 +1,5 @@
-/* Copyright 2012 Smartling, Inc.
+/*
+ * Copyright 2012 Smartling, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this work except in compliance with the License.
@@ -10,7 +11,8 @@
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
- * limitations under the License. */
+ * limitations under the License.
+ */
 package com.smartling.api.sdk.file;
 
 /**

api-sdk/src/main/java/com/smartling/api/sdk/file/FileApiParams.java

@@ -1,4 +1,5 @@
-/* Copyright 2012 Smartling, Inc.
+/*
+ * Copyright 2012 Smartling, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this work except in compliance with the License.