Error logging for Unsuccessful L10n Fetch ( plus code clean up)

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

@@ -8,6 +8,7 @@
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.ResourceBundle;
 
@@ -23,6 +24,7 @@
 import com.vmware.vipclient.i18n.exceptions.VIPClientInitException;
 import com.vmware.vipclient.i18n.messages.dto.MessagesDTO;
 import com.vmware.vipclient.i18n.messages.service.ProductService;
+import com.vmware.vipclient.i18n.util.LocaleUtility;
 
 /**
  * a class uses to define the global environment setting for I18nFactory
@@ -176,6 +178,8 @@ public void initialize(String cfg) throws VIPClientInitException {
         if (prop.containsKey("cacheExpiredTime"))
             this.cacheExpiredTime = Long.parseLong(prop
                     .getString("cacheExpiredTime"));
+        if (prop.containsKey("defaultLocale"))
+        	LocaleUtility.setDefaultLocale(Locale.forLanguageTag(prop.getString("defaultLocale")));
 	}	
 
     /**

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

@@ -4,23 +4,37 @@
  */
 package com.vmware.vipclient.i18n.base;
 
+import com.vmware.vipclient.i18n.messages.api.opt.LocaleOpt;
 import com.vmware.vipclient.i18n.messages.api.opt.MessageOpt;
+import com.vmware.vipclient.i18n.messages.api.opt.local.LocalLocaleOpt;
 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;
+import com.vmware.vipclient.i18n.messages.api.opt.server.RemoteLocaleOpt;
 
 public enum DataSourceEnum {
     Bundle {
     	@Override
         public MessageOpt createMessageOpt(MessagesDTO dto) {
             return new LocalMessagesOpt(dto);
         }
+
+		@Override
+		public LocaleOpt createLocaleOpt() {
+			return new LocalLocaleOpt();
+		}
     }, 
     VIP {
     	@Override
         public MessageOpt createMessageOpt(MessagesDTO dto) {
             return new ComponentBasedOpt(dto);
         }
+
+		@Override
+		public LocaleOpt createLocaleOpt() {
+			return new RemoteLocaleOpt();
+		}
     };
     public abstract MessageOpt createMessageOpt(MessagesDTO dto);
+    public abstract LocaleOpt createLocaleOpt();
 }

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

@@ -40,10 +40,6 @@ 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);

src/main/java/com/vmware/vipclient/i18n/base/instances/LocaleMessage.java

@@ -9,6 +9,7 @@
 import java.util.List;
 import java.util.Map;
 
+import com.vmware.vipclient.i18n.VIPCfg;
 import com.vmware.vipclient.i18n.messages.service.LocaleService;
 
 /**
@@ -45,7 +46,8 @@ public Map<String, Map<String, String>> getRegionList(List<String> supportedLang
      *         determined by the displanLanguage parameter
      */
     public Map<String, String> getDisplayLanguagesList(String displayLanguage) {
-        return new LocaleService().getDisplayNamesFromCLDR(displayLanguage);
+        return new LocaleService().getDisplayNamesFromCLDR(displayLanguage, 
+        		VIPCfg.getInstance().getMsgOriginsQueue().listIterator());
     }
 
     /**
@@ -55,7 +57,8 @@ public Map<String, String> getDisplayLanguagesList(String displayLanguage) {
      */
     public List<String> getSupportedLanguageTagList() {
         Map<String, String> languageTagMap = new LocaleService()
-                .getDisplayNamesFromCLDR(java.util.Locale.ENGLISH.toLanguageTag());
+                .getDisplayNamesFromCLDR(java.util.Locale.ENGLISH.toLanguageTag(), 
+                		VIPCfg.getInstance().getMsgOriginsQueue().listIterator());
         Collection<String> keyCollection = languageTagMap.keySet();
         List<String> languageTagList = new ArrayList<String>(keyCollection);
         return languageTagList;
@@ -69,7 +72,8 @@ public List<String> getSupportedLanguageTagList() {
      * @return a list contains the display names
      */
     public List<String> getSupportedDisplayNameList(String displayLanguage) {
-        Map<String, String> dispNameMap = new LocaleService().getDisplayNamesFromCLDR(displayLanguage);
+        Map<String, String> dispNameMap = new LocaleService().getDisplayNamesFromCLDR(displayLanguage, 
+        		VIPCfg.getInstance().getMsgOriginsQueue().listIterator());
         Collection<String> valueCollection = dispNameMap.values();
         List<String> dispNameList = new ArrayList<String>(valueCollection);
         return dispNameList;

src/main/java/com/vmware/vipclient/i18n/base/instances/TranslationMessage.java

@@ -139,7 +139,7 @@ public String getString(final Locale locale, final String component,
             // source as latest, not return the old translation
             if (source != null && !"".equals(source) && !VIPCfg.getInstance().isPseudo()) {
                 MessagesDTO remoteEnDTO = new MessagesDTO(component, key, source, 
-                		LocaleUtility.defaultLocale.toLanguageTag(), this.cfg);
+                		LocaleUtility.getDefaultLocale().toLanguageTag(), this.cfg);
                 String remoteEnMsg = s.getString(remoteEnDTO);
                 if (!source.equals(remoteEnMsg)) {
                     translation = source;
@@ -176,7 +176,7 @@ public String getString(final Locale locale, final String component,
         if (args != null && args.length > 0) {
             if ((null != translation && translation.equals(source)) || VIPCfg.getInstance().isPseudo()) {
                 translation = FormatUtils.formatMsg(translation,
-                        LocaleUtility.defaultLocale, args);
+                        LocaleUtility.getDefaultLocale(), args);
             } else {
                 translation = FormatUtils.formatMsg(translation, locale, args);
             }
@@ -366,7 +366,7 @@ public String getString2(final String component,
         String source;
         try {
             ResourceBundle rb = ResourceBundle.getBundle(bundle,
-                    LocaleUtility.defaultLocale);
+                    LocaleUtility.getDefaultLocale());
             source = rb.getString(key);
         } catch (Exception e) {
             this.logger.error(e.getMessage());

src/main/java/com/vmware/vipclient/i18n/l2/text/MessageFormat.java

@@ -53,7 +53,7 @@ public MessageFormat() {
     }
 
     public MessageFormat(String pattern) {
-        this.locale = LocaleUtility.defaultLocale;
+        this.locale = LocaleUtility.getDefaultLocale();
         applyPattern(pattern);
     }
 

src/main/java/com/vmware/vipclient/i18n/messages/api/opt/LocaleOpt.java

@@ -0,0 +1,11 @@
+/*
+ * Copyright 2019 VMware, Inc.
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package com.vmware.vipclient.i18n.messages.api.opt;
+
+import java.util.Map;
+
+public interface LocaleOpt {
+	public Map<String, String> getLanguages(String displayLanguage);
+}

src/main/java/com/vmware/vipclient/i18n/messages/api/opt/local/LocalLocaleOpt.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2019 VMware, Inc.
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package com.vmware.vipclient.i18n.messages.api.opt.local;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
+import java.util.stream.Stream;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.vmware.vipclient.i18n.VIPCfg;
+import com.vmware.vipclient.i18n.messages.api.opt.LocaleOpt;
+
+public class LocalLocaleOpt implements LocaleOpt{
+
+    private Logger logger = LoggerFactory.getLogger(LocalLocaleOpt.class);
+    private static final String BUNDLE_PREFIX = "messages_";
+
+    @Override
+    public Map<String, String> getLanguages(String displayLanguage) {
+
+    	Map<String, String> supportedLocales = new HashMap<String, String>();
+    	Locale inLocale = Locale.forLanguageTag(displayLanguage); 
+    	String offlineResourcesBaseUrl = VIPCfg.getInstance().getOfflineResourcesBaseUrl();
+		try {
+			Path path = Paths.get(Thread.currentThread().getContextClassLoader().
+					getResource(Paths.get(offlineResourcesBaseUrl).toString()).toURI());
+
+			try (Stream<Path> listOfFiles = Files.walk(path).filter(p -> p.toFile().isFile())) {
+				listOfFiles.map(file -> {
+					String fileName = file.getFileName().toString();
+					return fileName.substring(BUNDLE_PREFIX.length(), fileName.indexOf('.'));
+				}).forEach(s->supportedLocales.put(s, Locale.forLanguageTag(s).getDisplayName(inLocale)));
+			}		
+		} catch (Exception e) {
+			logger.debug(e.getMessage());
+		}
+    	return supportedLocales;
+    }
+
+}

src/main/java/com/vmware/vipclient/i18n/messages/api/opt/local/LocalMessagesOpt.java

@@ -6,11 +6,18 @@
 
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 
 import org.json.simple.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import com.vmware.vipclient.i18n.VIPCfg;
+import com.vmware.vipclient.i18n.base.DataSourceEnum;
 import com.vmware.vipclient.i18n.base.cache.MessageCacheItem;
 import com.vmware.vipclient.i18n.messages.api.opt.MessageOpt;
 import com.vmware.vipclient.i18n.messages.api.opt.Opt;
@@ -20,6 +27,8 @@
 
 public class LocalMessagesOpt implements Opt, MessageOpt {
 
+	private Logger logger = LoggerFactory.getLogger(LocalMessagesOpt.class.getName());
+
 	private static final String OFFLINE_RESOURCE_PATH = "{0}/messages_{1}.json";
     private MessagesDTO dto;
 
@@ -35,18 +44,30 @@ public JSONObject getComponentMessages() {
 
     @Override
     public void getComponentMessages(MessageCacheItem cacheItem) {
-    	String resource = VIPCfg.getInstance().getOfflineResourcesBaseUrl();
-    	String filePath = FormatUtils.format(OFFLINE_RESOURCE_PATH, dto.getComponent(), dto.getLocale());
-    	Path path = Paths.get(resource, filePath);
+        Locale bestMatch = Locale.lookup(Arrays.asList(new Locale.LanguageRange((dto.getLocale()))),
+        		getSupportedLocales());
+        
 		try {
+			String filePath = FormatUtils.format(OFFLINE_RESOURCE_PATH, dto.getComponent(), bestMatch.toLanguageTag());
+	    	Path path = Paths.get(VIPCfg.getInstance().getOfflineResourcesBaseUrl(), filePath);
 			path = Paths.get(Thread.currentThread().getContextClassLoader().
 					getResource(path.toString()).toURI());
 			Map<String, String> messages = JSONBundleUtil.getMessages(path);
 	    	cacheItem.addCachedData(messages);
 	    	cacheItem.setTimestamp(System.currentTimeMillis());
 		} catch (Exception e) {
+			logger.debug(e.getMessage());
 			// Do not update cacheItem
 		}
     }
-
+
+    private List<Locale> getSupportedLocales() {
+    	Map<String, String> supportedLanguages = DataSourceEnum.Bundle.createLocaleOpt()
+    			.getLanguages(dto.getLocale());
+    	List<Locale> supportedLocales = new LinkedList<Locale>();
+    	for (String languageTag : supportedLanguages.keySet()) {
+    		supportedLocales.add(Locale.forLanguageTag(languageTag));
+    	}
+    	return supportedLocales;
+    }
 }

src/main/java/com/vmware/vipclient/i18n/messages/api/opt/server/ComponentBasedOpt.java

@@ -52,13 +52,6 @@ public void getComponentMessages(MessageCacheItem cacheItem) {
 
         if (responseCode != null && (responseCode.equals(HttpURLConnection.HTTP_OK) || 
         		responseCode.equals(HttpURLConnection.HTTP_NOT_MODIFIED))) {
-
-        	if (response.get(URLUtils.RESPONSE_TIMESTAMP) != null)
-	        	cacheItem.setTimestamp((long) response.get(URLUtils.RESPONSE_TIMESTAMP) );
-        	if (response.get(URLUtils.HEADERS) != null)
-	        	cacheItem.setEtag(URLUtils.createEtagString((Map<String, List<String>>) response.get(URLUtils.HEADERS)));
-	        if (response.get(URLUtils.MAX_AGE_MILLIS) != null)
-	        	cacheItem.setMaxAgeMillis((Long) response.get(URLUtils.MAX_AGE_MILLIS));
 
 	        if (responseCode.equals(HttpURLConnection.HTTP_OK)) {
 		        JSONObject respObj = (JSONObject) JSONValue.parse((String) response.get(URLUtils.BODY));
@@ -69,6 +62,12 @@ public void getComponentMessages(MessageCacheItem cacheItem) {
 				        	cacheItem.addCachedData(messages);
 				        }
         			}
+	        		if (response.get(URLUtils.RESPONSE_TIMESTAMP) != null)
+	    	        	cacheItem.setTimestamp((long) response.get(URLUtils.RESPONSE_TIMESTAMP) );
+	            	if (response.get(URLUtils.HEADERS) != null)
+	    	        	cacheItem.setEtag(URLUtils.createEtagString((Map<String, List<String>>) response.get(URLUtils.HEADERS)));
+	    	        if (response.get(URLUtils.MAX_AGE_MILLIS) != null)
+	    	        	cacheItem.setMaxAgeMillis((Long) response.get(URLUtils.MAX_AGE_MILLIS));
 	        	} catch (Exception e) {
 	        		logger.error("Failed to get messages");
 	        	}

src/main/java/com/vmware/vipclient/i18n/messages/api/opt/server/LocaleOpt.java → src/main/java/com/vmware/vipclient/i18n/messages/api/opt/server/RemoteLocaleOpt.java

@@ -15,16 +15,17 @@
 import org.slf4j.LoggerFactory;
 
 import com.vmware.vipclient.i18n.VIPCfg;
+import com.vmware.vipclient.i18n.messages.api.opt.LocaleOpt;
 import com.vmware.vipclient.i18n.messages.api.url.URLUtils;
 import com.vmware.vipclient.i18n.messages.api.url.V2URL;
 import com.vmware.vipclient.i18n.util.ConstantsKeys;
 import com.vmware.vipclient.i18n.util.JSONUtils;
 
-public class LocaleOpt {
+public class RemoteLocaleOpt implements LocaleOpt{
 
-    private Logger logger = LoggerFactory.getLogger(LocaleOpt.class.getName());
+    private Logger logger = LoggerFactory.getLogger(RemoteLocaleOpt.class.getName());
 
-    public LocaleOpt() {
+    public RemoteLocaleOpt() {
     }
 
     public Map<String, String> getTerritoriesFromCLDR(String language) {
@@ -46,7 +47,8 @@ public Map<String, String> getTerritoriesFromCLDR(String language) {
         return respMap;
     }
 
-    public Map<String, String> getDisplayNamesFromCLDR(String language) {
+    @Override
+    public Map<String, String> getLanguages(String language) {
     	Map<String, Object> response = VIPCfg.getInstance().getVipService().getHttpRequester()
                 .request(
                         V2URL.getSupportedLanguageListURL(language,
@@ -70,7 +72,7 @@ public Map<String, String> getDisplayNamesFromCLDR(String language) {
                             tmpMap.get(ConstantsKeys.DISPLAY_NAME).toString());
                 }
             }
-        } catch (ParseException e) {
+        } catch (Exception e) {
             logger.error(e.getMessage());
         }
         return dispMap;

src/main/java/com/vmware/vipclient/i18n/messages/service/CacheService.java

@@ -13,6 +13,7 @@
 
 import com.vmware.vipclient.i18n.VIPCfg;
 import com.vmware.vipclient.i18n.base.cache.Cache;
+import com.vmware.vipclient.i18n.base.cache.FormatCacheItem;
 import com.vmware.vipclient.i18n.base.cache.MessageCacheItem;
 import com.vmware.vipclient.i18n.messages.dto.MessagesDTO;
 import com.vmware.vipclient.i18n.util.ConstantsKeys;
@@ -104,22 +105,21 @@ public void addCacheOfStatus(Map<String, String> dataMap) {
 
     public List<Locale> getSupportedLocalesFromCache() {
         List<Locale> locales = new ArrayList<Locale>();
-        Cache c = VIPCfg.getInstance().getCacheManager().getCache(VIPCfg.CACHE_L3);
+        Cache c = VIPCfg.getInstance().getCacheManager().getCache(VIPCfg.CACHE_L2);
         if (c == null) {
             return locales;
         }
         Set<String> keySet = c.keySet();
-        Object[] keys = keySet.toArray();
-        Map<String, Object> tempMap = new HashMap<String, Object>();
-        for (Object key : keys) {
-            String ckey = (String) key;
-            String locale = ckey.substring(
-                    ckey.indexOf(ConstantsKeys.UNDERLINE_POUND) + 2,
-                    ckey.length());
-            if (!tempMap.containsKey(locale)) {
-                locales.add(Locale.forLanguageTag(locale.replace("_", "-")));
-                tempMap.put(locale, locale);
-            }
+
+        for (String key : keySet) {
+        	if (key.startsWith(LocaleService.DISPN_PREFIX)) {
+        		FormatCacheItem cacheItem = (FormatCacheItem) c.get(key);
+        		Map<String, String> langTagToDisplayNameMap = cacheItem.getCachedData();
+        		for (String languageTag : langTagToDisplayNameMap.keySet()) {
+        			locales.add(Locale.forLanguageTag(languageTag));
+        		}
+        		break;
+        	}
         }
         return locales;
     }