Loading offline resource bundles

sample-client-app/src/main/java/com/vmware/vipclient/sample/Main.java

@@ -10,6 +10,7 @@
 
 import com.vmware.vipclient.i18n.I18nFactory;
 import com.vmware.vipclient.i18n.VIPCfg;
+import com.vmware.vipclient.i18n.base.DataSourceEnum;
 import com.vmware.vipclient.i18n.base.cache.FormattingCache;
 import com.vmware.vipclient.i18n.base.cache.MessageCache;
 import com.vmware.vipclient.i18n.util.LocaleUtility;
@@ -33,11 +34,24 @@ public static void main(String[] args) {
 		} catch (VIPClientInitException e) {
 			System.out.println(e.getMessage());
 		}
+
 		cfg.initializeVIPService();
 		cfg.createTranslationCache(MessageCache.class);
 		cfg.createFormattingCache(FormattingCache.class);
 		I18nFactory.getInstance(cfg);
 
+		// Demonstrate French locale (online mode - from remote service)
+		demonstrate(thislocale);
+
+		// Demonstrate Filipino locale (offline mode - from local bundle)
+		cfg.setMessageOrigin(DataSourceEnum.Bundle);
+    	cfg.setOfflineResourcesBaseUrl("offlineBundles/");
+    	LocaleUtility.setLocale(new Locale("fil"));
+    	demonstrate(new Locale("fil"));
+
+	}
+
+	private static void demonstrate(Locale locale) {
 		// Get translation
 		String key = "global_text_username";
 		String source = "User name";
@@ -49,9 +63,9 @@ public static void main(String[] args) {
 		System.out.println(">>>>>> Get translation by key: \"" + key + "\"");
 		String trans2 = Translation.getTranslation2(key);
 		System.out.println(trans2);
-
+		
 		System.out.println(">>>>>> Check translation status of key: \"" + key + "\"");
-		boolean bReady = Translation.isTranslationReady("default", key, thislocale);
+		boolean bReady = Translation.isTranslationReady("default", key, locale);
 		System.out.println(bReady);
 
 		// Number format

sample-client-app/src/main/resources/offlineBundles/default/messages_en-US.json

@@ -0,0 +1,10 @@
+{
+  "component": "JAVA",
+  "messages": {
+    "LeadTest": "[{0}] Test alert",
+    "global_text_username": "User name",
+    "table.host": "Host",
+    "sample.plural.key1": "{0, plural, one{There is one file on disk \"{1}\".} other{There are # files on disk \"{1}\".}}"
+  },
+  "locale": "en-US"
+}

sample-client-app/src/main/resources/offlineBundles/default/messages_fil.json

@@ -0,0 +1,9 @@
+{
+  "component": "JAVA",
+  "messages": {
+    "LeadTest": "[{0}] Alerto sa pagsusuri",
+    "global_text_username": "Pangalan ng gumagamit",
+    "table.host": "Punong-abala"
+  },
+  "locale": "fil"
+}

sample-client-app/src/main/resources/offlineBundles/default/messages_fr.json

@@ -0,0 +1,9 @@
+{
+  "component": "JAVA",
+  "messages": {
+    "LeadTest": "[{0}] Alerte de test",
+    "global_text_username": "Nom d'utilisateur",
+    "table.host": "Hôte"
+  },
+  "locale": "fr"
+}

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

@@ -53,6 +53,7 @@ public static synchronized I18nFactory getInstance(VIPCfg cfg) {
         if (factory == null) {
             factory = new I18nFactory(cfg);
         }
+        factory.setCfg(cfg);
         return factory;
     }
 
@@ -76,10 +77,13 @@ public Message getMessageInstance(Class c, VIPCfg cfg) {
         Message i = null;
         if (c == null) {
             return i;
-        } else if (this.getCfg().getVipServer() == null
-                || this.getCfg().getProductName() == null
+        } else if (this.getCfg().getProductName() == null
                 || this.getCfg().getVersion() == null) {
-            logger.error("VipServer|ProductName|Version is null!");
+            logger.error("ProductName|Version is null!");
+            return i;
+        } else if (this.getCfg().getVipServer() == null 
+        		&& this.getCfg().getOfflineResourcesBaseUrl() == null) {
+        	logger.error("One of offlineResourcesBaseUrl and vipServer must not be null!");
             return i;
         }
         String key;

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

@@ -6,6 +6,8 @@
 
 import java.net.MalformedURLException;
 import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
 import java.util.Map;
 import java.util.ResourceBundle;
 
@@ -19,6 +21,7 @@
 import com.vmware.vipclient.i18n.base.cache.CacheMode;
 import com.vmware.vipclient.i18n.base.cache.TranslationCacheManager;
 import com.vmware.vipclient.i18n.exceptions.VIPClientInitException;
+import com.vmware.vipclient.i18n.messages.api.opt.SourceOpt;
 import com.vmware.vipclient.i18n.messages.dto.MessagesDTO;
 import com.vmware.vipclient.i18n.messages.service.ProductService;
 
@@ -36,15 +39,18 @@ public class VIPCfg {
     private TranslationCacheManager    translationCacheManager;
 
     // data origin
+    @Deprecated
     private DataSourceEnum             messageOrigin = DataSourceEnum.VIP;
-
+    private List<DataSourceEnum>	   msgOriginsQueue = new LinkedList<DataSourceEnum>();
+
     // cache mode
     private CacheMode                  cacheMode     = CacheMode.MEMORY;
 
     private String                     cachePath;
 
     // define the global parameters
     private boolean                    pseudo;
+    @Deprecated
     private boolean                    collectSource;
     private boolean                    cleanCache;
     private long                       cacheExpiredTime;
@@ -56,7 +62,18 @@ public class VIPCfg {
     private String                     version;
     private String                     vipServer;
     private String                     i18nScope     = "numbers,dates,currencies,plurals,measurements";
-
+    private String					   offlineResourcesBaseUrl;
+
+    /**
+     * The optional SourceOpt object to access source messages. If SourceOpt is defined, then you can use a source message:
+     * 	a. as fallback if neither localized message nor default locale message was not retrieved successfully
+     * 	b. for pseudo-translation
+     * 	c. if the message hasn't been collected for localization
+     * e.g. ResourceBundleSrcOpt is the SourceOpt implementation that retrieves source messages from a .properties file. 
+     * If source messages need to come from another location such as a DB, then have another implementation like DBSourceOpt.
+     */
+    private SourceOpt				   srcOpt;
+
     // define key for cache management
     public static final String         CACHE_L3      = "CACHE_L3";
     public static final String         CACHE_L2      = "CACHE_L2";
@@ -86,6 +103,10 @@ public static synchronized VIPCfg getInstance() {
         }
         return gcInstance;
     }
+
+    public static synchronized void resetInstance() {
+        gcInstance = null;
+    }
 
     /**
      * create a default instance of VIPCfg
@@ -120,9 +141,19 @@ public void initialize(String vipServer, String productName, String version) {
     }
 
     /**
-     * initialize the instance by a properties file
+     * Initialize VIPCfg instance using a configuration file
+     * 
+     * @param cfg The configuration file
+     * @param srcOpt The optional SourceOpt object which gives access to source messages
+     */
+    public void initialize(String cfg, SourceOpt srcOpt) throws VIPClientInitException {
+    	initialize(cfg);
+    	this.setSrcOpt(srcOpt);
+    }
+    /**
+     * Initialize VIPCfg instance using a configuration file
      * 
-     * @param cfg
+     * @param cfg The configuration file
      */
     public void initialize(String cfg) throws VIPClientInitException {
     	ResourceBundle prop = ResourceBundle.getBundle(cfg);
@@ -138,8 +169,17 @@ public void initialize(String cfg) throws VIPClientInitException {
         }
         if (prop.containsKey("version"))
             this.version = prop.getString("version");
-        if (prop.containsKey("vipServer"))
+
+        // Remote VIP resources takes priority over offline resources
+        // so add DataSourceEnum.VIP first to msgOriginsQueue
+        if (prop.containsKey("vipServer")) {
             this.vipServer = prop.getString("vipServer");
+            this.msgOriginsQueue.add(DataSourceEnum.VIP);
+        }
+        if (prop.containsKey("offlineResourcesBaseUrl")) {
+        	this.offlineResourcesBaseUrl = prop.getString("offlineResourcesBaseUrl");
+        	this.msgOriginsQueue.add(DataSourceEnum.Bundle);
+        }
         if (prop.containsKey("pseudo"))
             this.pseudo = Boolean.parseBoolean(prop.getString("pseudo"));
         if (prop.containsKey("collectSource"))
@@ -159,7 +199,6 @@ public void initialize(String cfg) throws VIPClientInitException {
         if (prop.containsKey("cacheExpiredTime"))
             this.cacheExpiredTime = Long.parseLong(prop
                     .getString("cacheExpiredTime"));
-
 	}	
 
     /**
@@ -303,10 +342,12 @@ public void setPseudo(boolean pseudo) {
         this.pseudo = pseudo;
     }
 
+    @Deprecated
     public boolean isCollectSource() {
         return collectSource;
     }
 
+    @Deprecated
     public void setCollectSource(boolean collectSource) {
         this.collectSource = collectSource;
     }
@@ -350,11 +391,13 @@ public boolean isMachineTranslation() {
     public void setMachineTranslation(boolean machineTranslation) {
         this.machineTranslation = machineTranslation;
     }
-
+
+    @Deprecated
     public DataSourceEnum getMessageOrigin() {
         return messageOrigin;
     }
 
+    @Deprecated
     public void setMessageOrigin(DataSourceEnum messageOrigin) {
         this.messageOrigin = messageOrigin;
     }
@@ -393,4 +436,27 @@ public void setCachePath(String cachePath) {
         this.cachePath = cachePath;
     }
 
+	public String getOfflineResourcesBaseUrl() {
+		return offlineResourcesBaseUrl;
+	}
+
+	public void setOfflineResourcesBaseUrl(String offlineResourcesBaseUrl) {
+		this.offlineResourcesBaseUrl = offlineResourcesBaseUrl;
+	}
+
+	public List<DataSourceEnum> getMsgOriginsQueue() {
+		return msgOriginsQueue;
+	}
+
+	public void setMsgOriginsQueue(List<DataSourceEnum> msgOriginsQueue) {
+		this.msgOriginsQueue = msgOriginsQueue;
+	}
+
+	public SourceOpt getSrcOpt() {
+		return srcOpt;
+	}
+
+	public void setSrcOpt(SourceOpt srcOpt) {
+		this.srcOpt = srcOpt;
+	}
 }

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

@@ -4,6 +4,23 @@
  */
 package com.vmware.vipclient.i18n.base;
 
+import com.vmware.vipclient.i18n.messages.api.opt.MessageOpt;
+import com.vmware.vipclient.i18n.messages.api.opt.local.LocalMessagesOpt;
+import com.vmware.vipclient.i18n.messages.api.opt.server.ComponentBasedOpt;
+import com.vmware.vipclient.i18n.messages.dto.MessagesDTO;
+
 public enum DataSourceEnum {
-    Bundle, VIP
+    Bundle {
+    	@Override
+        public MessageOpt createMessageOpt(MessagesDTO dto) {
+            return new LocalMessagesOpt(dto);
+        }
+    }, 
+    VIP {
+    	@Override
+        public MessageOpt createMessageOpt(MessagesDTO dto) {
+            return new ComponentBasedOpt(dto);
+        }
+    };
+    public abstract MessageOpt createMessageOpt(MessagesDTO dto);
 }

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

@@ -85,7 +85,7 @@ public synchronized boolean put(String cacheKey, CacheItem itemToCache) {
 	    		if (cacheItem == null) {
 	    			cachedComponentsMap.put(cacheKey, (MessageCacheItem) itemToCache);
 	    		} else {
-	    			cacheItem.addCacheItem((MessageCacheItem) itemToCache);
+	    			cacheItem.setCacheItem((MessageCacheItem) itemToCache);
 	    		}
 	        }
     	}

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

@@ -1,4 +1,5 @@
 /*
+
  * Copyright 2019 VMware, Inc.
  * SPDX-License-Identifier: EPL-2.0
  */
@@ -31,16 +32,28 @@ public MessageCacheItem (Map<String, String> dataMap) {
 
 	private String etag;
 	private long timestamp;
-	private Long maxAgeMillis = 864000000l;
+	private Long maxAgeMillis = 86400000l;
+
+	private final Map<String, String> cachedData = new HashMap<String, String>();
 
-	public final Map<String, String> cachedData = new HashMap<String, String>();
+	public void addCacheData(String key, String value) {
+		this.cachedData.put(key, value);
+	}
+
+	public boolean isCachedDataEmpty() {
+		return this.cachedData.isEmpty();
+	}
 
 	public synchronized void addCachedData(Map<String, String> cachedData) {
 		if (cachedData != null) 
 			this.cachedData.putAll(cachedData);
 	}
 
-	public synchronized void addCacheItem (MessageCacheItem cacheItem) {
+	public synchronized void setCacheItem (MessageCacheItem cacheItem) {
+		// Do not update cacheItem if timestamp is earlier than current. 
+		// An older timestamp comes from an old thread that was blocked.
+		if (cacheItem.getTimestamp() < this.timestamp) 
+			return;
 		this.addCachedData(cacheItem.getCachedData());
 		this.etag = cacheItem.etag;
 		this.timestamp = cacheItem.timestamp;
@@ -76,6 +89,10 @@ public synchronized void setMaxAgeMillis(Long maxAgeMillis) {
 	}
 
 	public boolean isExpired() {
+		// If offline mode only, cache never expires.
+		if (VIPCfg.getInstance().getVipServer() == null) {
+			return false;
+		}
     	// If maxAgeFromConfig is present, it means it is using the old way 
     	// of caching expiration, so do not expire individual CacheItem object
     	if (VIPCfg.getInstance().getCacheExpiredTime() != 0) {
@@ -94,5 +111,5 @@ public boolean isExpired() {
 
     	return System.currentTimeMillis() - responseTimeStamp > maxAgeMillis;
     }
-	
+
 }