G11n java client - New caching workflow

src/main/java/com/vmware/vipclient/i18n/VIPCfg.java

@@ -48,6 +48,7 @@ public class VIPCfg {
     private boolean                    collectSource;
     private boolean                    cleanCache;
     private long                       cacheExpiredTime;
+
     private boolean                    machineTranslation;
     private boolean                    initializeCache;
     private int                        interalCleanCache;
@@ -117,17 +118,17 @@ public void initialize(String vipServer, String productName, String version) {
         this.version = version;
         this.vipServer = vipServer;
     }
-
+    
     /**
      * initialize the instance by a properties file
      * 
      * @param cfg
      */
     public void initialize(String cfg) throws VIPClientInitException {
-        ResourceBundle prop = ResourceBundle.getBundle(cfg);
-        if (prop == null) {
-            throw new VIPClientInitException("Can't not initialize VIPCfg, resource bundle is null.");
-        }
+    	ResourceBundle prop = ResourceBundle.getBundle(cfg);
+    	if (prop == null) {
+    		throw new VIPClientInitException("Can't not initialize VIPCfg, resource bundle is null.");
+    	}
 
         if (prop.containsKey("productName"))
             this.productName = prop.getString("productName");
@@ -158,7 +159,8 @@ public void initialize(String cfg) throws VIPClientInitException {
         if (prop.containsKey("cacheExpiredTime"))
             this.cacheExpiredTime = Long.parseLong(prop
                     .getString("cacheExpiredTime"));
-    }
+
+	}	
 
     /**
      * initialize VIPService instances to provide HTTP requester
@@ -169,7 +171,7 @@ public void initializeVIPService() {
             this.vipService.initializeVIPService(this.productName, this.version,
                     this.vipServer);
         } catch (MalformedURLException e) {
-            logger.error("'vipServer' in configuration isn't a valid URL!");
+            logger.error("'vipServer' " + this.vipServer + " in configuration isn't a valid URL!");
         }
     }
 
@@ -195,7 +197,7 @@ public void setTranslationCache(Cache c) {
         }
         Cache createdCache = TranslationCacheManager
                 .getCache(VIPCfg.CACHE_L3);
-        if (createdCache != null && this.getCacheExpiredTime() > 0) {
+        if (createdCache != null && this.getCacheExpiredTime() != 0) {
             c.setExpiredTime(this.getCacheExpiredTime());
         }
     }
@@ -223,7 +225,7 @@ public synchronized Cache createTranslationCache(Class cacheClass) {
                     Task.startTaskOfCacheClean(VIPCfg.getInstance(), interalCleanCache);
                 }
                 Cache c = TranslationCacheManager.getCache(VIPCfg.CACHE_L3);
-                if (c != null && this.getCacheExpiredTime() > 0) {
+                if (c != null && this.getCacheExpiredTime() != 0) {
                     c.setExpiredTime(this.getCacheExpiredTime());
                 }
             }
@@ -364,15 +366,17 @@ public boolean isInitializeCache() {
     public void setInitializeCache(boolean initializeCache) {
         this.initializeCache = initializeCache;
     }
-
+
+    @Deprecated
     public long getCacheExpiredTime() {
         return cacheExpiredTime;
     }
-
+
+    @Deprecated
     public void setCacheExpiredTime(long cacheExpiredTime) {
         this.cacheExpiredTime = cacheExpiredTime;
     }
-
+    
     public CacheMode getCacheMode() {
         return cacheMode;
     }

src/main/java/com/vmware/vipclient/i18n/base/HttpRequester.java

@@ -16,6 +16,7 @@
 import java.security.NoSuchAlgorithmException;
 import java.security.SecureRandom;
 import java.security.cert.X509Certificate;
+import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -50,17 +51,18 @@ public class HttpRequester {
      */
     private String                  baseURL;
 
-    public void setBaseURL(String baseURL) {
-        this.baseURL = baseURL;
-    }
-
     /**
-     * The extra parameters to add to http header
+     * HTTP headers that are common to all HTTP requests
      */
-    private Map<String, String> customizedHeaderParams = null;
+    private Map<String, String> commonHeaderParams = null;
 
     public void setCustomizedHeaderParams(Map<String, String> params) {
-        customizedHeaderParams = params;
+    	commonHeaderParams = params; 
+    }
+
+
+    public void setBaseURL(String baseURL) {
+        this.baseURL = baseURL;
     }
 
     /**
@@ -99,15 +101,33 @@ protected static boolean ping(String ipAddress) {
         }
         return status;
     }
-
+    
     /**
-     * The get method of requesting a remote server.
+     * Send an HTTP request.
      *
-     * @param url
-     *            The remote server url.
-     * @return
+     * @param url The remote server url
+     * @param method HTTP method
+     * @param requestData HTTP URL parameters
+     * 
+     * @return Map<String, Object> response 
+     */
+    public Map<String, Object> request(final String url, final String method, final Object requestData) {
+    	return request(url, method, requestData, null);
+    }
+
+    /**
+     * Send an HTTP request.
+     *
+     * @param url The remote server url
+     * @param method HTTP method
+     * @param requestData HTTP URL parameters
+     * @param customizedHeaderParams customized HTTP request header for this request
+     * 
+     * @return Map<String, Object> response
      */
-    public String request(final String url, final String method, final Object requestData) {
+    public Map<String, Object> request(final String url, final String method, final Object requestData,
+    		final Map<String, String> customizedHeaderParams) {
+    	Map <String, Object> response = new HashMap<String, Object>();
         String r = "";
         HttpURLConnection conn = null;
         try {
@@ -121,18 +141,31 @@ public String request(final String url, final String method, final Object reques
                 urlStr.append(url);
             }
             logger.info("[" + method + "]" + urlStr.toString());
-            conn = createConnection(urlStr.toString());
+
+            conn = createConnection(urlStr.toString(), customizedHeaderParams);
             if (conn != null) {
                 conn.setRequestMethod(method);
                 if (ConstantsKeys.POST.equalsIgnoreCase(method)) {
                     this.writeData(requestData, conn);
                 } else {
                     conn.connect();
                 }
-                if (HttpURLConnection.HTTP_OK == conn.getResponseCode()) {
-                    r = this.handleResult(conn);
-                    // logger.debug("The response from server is:\n"+r);
+                switch (conn.getResponseCode()) {
+                	case HttpURLConnection.HTTP_NOT_MODIFIED :
+                		break;
+                	case HttpURLConnection.HTTP_OK :
+                		r = this.handleResult(conn);
+	                    response.put(URLUtils.BODY, r);
+	                    // logger.debug("The response from server is:\n"+r);
+	                    break;
                 }
+                response.put(URLUtils.HEADERS, conn.getHeaderFields());
+                response.put(URLUtils.RESPONSE_CODE, conn.getResponseCode());
+                response.put(URLUtils.RESPONSE_MSG, conn.getResponseMessage());
+                response.put(URLUtils.RESPONSE_TIMESTAMP, System.currentTimeMillis());
+                Long maxAgeMillis = URLUtils.getMaxAgeMillis(conn.getHeaderFields());
+                if (maxAgeMillis != null)
+                	response.put(URLUtils.MAX_AGE_MILLIS, maxAgeMillis);
             }
         } catch (IOException e) {
             logger.info(e.getMessage());
@@ -142,9 +175,9 @@ public String request(final String url, final String method, final Object reques
                 conn = null;
             }
         }
-        return r;
+        return response;
     }
-
+    
     public String getBaseURL() {
         return this.baseURL;
     }
@@ -210,7 +243,7 @@ private String getFormStr(Map<String, String> params) {
      *            The remote server url.
      * @return
      */
-    private HttpURLConnection createConnection(String path) {
+    private HttpURLConnection createConnection(String path, Map<String, String> customizedHeaderParams) {
         HttpURLConnection connection = null;
         try {
             URL url = new URL(path.trim());
@@ -239,7 +272,7 @@ public boolean verify(String hostname, SSLSession session) {
             connection.setDoInput(true);
             connection.setRequestProperty("accept", "*/*");
 
-            addHeaderParams(connection);
+            addHeaderParams(connection, customizedHeaderParams);
         }
         return connection;
     }
@@ -283,13 +316,17 @@ public boolean isConnected() {
         return HttpRequester.ping(ipAddress);
     }
 
-    private void addHeaderParams(HttpURLConnection connection) {
-        if (null == customizedHeaderParams || null == connection) {
-            return;
+    private void addHeaderParams(HttpURLConnection connection, Map<String, String> customizedHeaderParams) {
+        if (customizedHeaderParams != null) {
+	        for (final Entry<String, String> entry : customizedHeaderParams.entrySet()) {
+	            connection.setRequestProperty(entry.getKey(), entry.getValue());
+	        }
         }
-
-        for (final Entry<String, String> entry : customizedHeaderParams.entrySet()) {
-            connection.setRequestProperty(entry.getKey(), entry.getValue());
+
+        if (commonHeaderParams != null) {
+	        for (final Entry<String, String> entry : commonHeaderParams.entrySet()) {
+	            connection.setRequestProperty(entry.getKey(), entry.getValue());
+	        }
         }
     }
 }

src/main/java/com/vmware/vipclient/i18n/base/cache/Cache.java

@@ -4,27 +4,27 @@
  */
 package com.vmware.vipclient.i18n.base.cache;
 
-import java.util.Map;
 import java.util.Set;
+import com.vmware.vipclient.i18n.base.cache.CacheItem;
 
 public interface Cache {
-
+	
     /**
-     * get a component's strings by key
+     * get a component's cached data by key
      * 
      * @param key
-     * @return map of all strings under the component
+     * @return CacheItem object instance that holds the cached data (messages and associated properties)
      */
-    public Map<String, String> get(String key);
-
+    public CacheItem get(String key);
+    
     /**
      * put strings to cache by key
      * 
-     * @param key
-     * @param map
+     * @param key cache key
+     * @param cacheItem item to be stored in the cache 
      * @return false if failed to put
      */
-    public boolean put(String key, Map<String, String> map);
+    public boolean put(String key, CacheItem cacheItem);
 
     /**
      * remove a component from cache by key
@@ -110,5 +110,4 @@ public interface Cache {
      * @return a drop id
      */
     public String getDropId();
-
 }

src/main/java/com/vmware/vipclient/i18n/base/cache/CacheItem.java

@@ -0,0 +1,9 @@
+/*
+ * Copyright 2019 VMware, Inc.
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package com.vmware.vipclient.i18n.base.cache;
+
+public interface CacheItem {
+
+}

src/main/java/com/vmware/vipclient/i18n/base/cache/FormatCacheItem.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 VMware, Inc.
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package com.vmware.vipclient.i18n.base.cache;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class FormatCacheItem implements CacheItem {
+	public FormatCacheItem() {
+
+	}
+
+	public FormatCacheItem (Map<String, String> dataMap) {
+		super();
+		this.addCachedData(dataMap);
+	}
+
+	public final Map<String, String> cachedData = new HashMap<String, String>();
+
+	public void addCachedData(Map<String, String> cachedData) {
+		if (cachedData != null)
+			this.cachedData.putAll(cachedData);
+	}
+
+    public Map<String, String> getCachedData() {
+		return cachedData;
+	}
+
+}

src/main/java/com/vmware/vipclient/i18n/base/cache/FormattingCache.java

@@ -12,20 +12,20 @@ public class FormattingCache implements Cache {
     private long                             expiredTime   = 86400000;                                        // 24hr
     private long                             lastClean     = System.currentTimeMillis();
 
-    private Map<String, Map<String, String>> formattingMap = new LinkedHashMap<String, Map<String, String>>();
+    private Map<String, FormatCacheItem> formattingMap = new LinkedHashMap<String, FormatCacheItem>();
 
     public FormattingCache() {
         super();
     }
 
     @SuppressWarnings("unchecked")
-    public Map<String, String> get(String cacheKey) {
-        Object cachedObject = formattingMap.get(cacheKey);
-        return cachedObject == null ? null : (Map<String, String>) cachedObject;
+    public FormatCacheItem get(String cacheKey) {
+    	return formattingMap.get(cacheKey);
     }
 
-    public synchronized boolean put(String cacheKey, Map<String, String> map) {
-        formattingMap.put(cacheKey, map);
+    @Override
+    public synchronized boolean put(String cacheKey, CacheItem itemToCache) {
+    	formattingMap.put(cacheKey, (FormatCacheItem) itemToCache);
         return formattingMap.get(cacheKey) != null;
     }