Package com.broadleafcommerce.i18n.enterprise.config.service

Class InternationalMessageServiceImpl

java.lang.Object

com.broadleafcommerce.i18n.enterprise.config.service.InternationalMessageServiceImpl

All Implemented Interfaces:

InternationalMessageService, InternationalMessageSupport

@Service("blInternationalMessageService")
public class InternationalMessageServiceImpl
extends Object
implements InternationalMessageService, InternationalMessageSupport

Service that retrieves International Messages from the database.

Author:

Elbert Bautista (elbertbautista), Jeff Fischer

Field Summary

Fields

Modifier and Type	Field	Description
protected org.broadleafcommerce.common.extensibility.cache.JCacheUtil	cacheUtil
protected org.broadleafcommerce.common.entity.service.EntityInformationService	entityInformationService
protected InternationalMessageServiceExtensionManager	extensionManager
protected javax.cache.Cache	internationalMessageCache
protected InternationalMessageDao	internationalMessageDao
protected List<InternationalMessageOverrideStrategy>	strategies
protected int	templateThresholdForFullCache
protected int	thresholdForFullCache

Constructor Summary

Constructors

Constructor	Description
InternationalMessageServiceImpl()

Method Summary

Modifier and Type	Method	Description
InternationalMessage	findBestStandardMessage(String specificPropertyKey, String generalPropertyKey, Map<String,org.broadleafcommerce.common.extension.StandardCacheItem> propertyTranslationMap)	Find the most appropriate message in the map.
InternationalMessage	findBestTemplateMessage(String specificPropertyKey, String generalPropertyKey, Map<String,InternationalMessage> propertyTranslationMap)	Find the most appropriate message in the map.
InternationalMessage	findById(Long id)
String	getCacheKey(String propertyName, org.broadleafcommerce.common.extension.ResultType resultType)	Build a cache key
List<String>	getCacheKeyListForTemplateSite(String propertyName)	Returns a list of cacheKeys for a template site
javax.cache.Cache	getInternationalMessageCache()	Retrieve the backing cache
protected String	getOverrideMessage(String propertyName, Locale locale)
protected String	getTemplateMessage(String standardCacheKey, String propertyName, String localeCode, String localeCountryCode, String specificPropertyKey, String generalPropertyKey)
int	getTemplateThresholdForFullCache()	Retrieve the threshold under which the full list of template catalog messages are cached.
int	getThresholdForFullCache()	Retrieve the threshold under which the full list of standard site message overrides are cached.
org.broadleafcommerce.common.extension.StandardCacheItem	lookupMessageFromMap(String key, Map<String,org.broadleafcommerce.common.extension.StandardCacheItem> propertyTranslationMap)	Look up a cached message from the map based on a key
void	removeFromCache(InternationalMessage internationalMessage, String profileId)
protected String	replaceEmptyWithNullResponse(String response)
String	resolveInternationalMessage(String name, Locale locale)	This method adds some complexity to the seemingly simple task of looking up a message based on locale.
void	setTemplateThresholdForFullCache(int templateThresholdForFullCache)
void	setThresholdForFullCache(int thresholdForFullCache)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

internationalMessageCache

protected javax.cache.Cache internationalMessageCache

internationalMessageDao

protected InternationalMessageDao internationalMessageDao

entityInformationService

protected org.broadleafcommerce.common.entity.service.EntityInformationService entityInformationService

extensionManager

protected InternationalMessageServiceExtensionManager extensionManager

thresholdForFullCache

@Value("${i18nMessages.thresholdForFullCache:1000}")
protected int thresholdForFullCache

templateThresholdForFullCache

@Value("${i18nMessages.thresholdForFullCache:1000}")
protected int templateThresholdForFullCache

cacheUtil

@Autowired
protected org.broadleafcommerce.common.extensibility.cache.JCacheUtil cacheUtil

strategies

protected List<InternationalMessageOverrideStrategy> strategies

Constructor Details

InternationalMessageServiceImpl

public InternationalMessageServiceImpl()

Method Details

resolveInternationalMessage

public String resolveInternationalMessage(String name,
 Locale locale)

This method adds some complexity to the seemingly simple task of looking up a message based on locale.

We want to minimize queries based on locale as well as recognize that in a multi-site installation, messages are likely to be shared from top level down to the sites. For example, consider that an installation has 1,000 sites. All of these sites probably calls the "Login" button "Login" in english. We'd prefer to get efficient cache hits in a scenario like this.

Specified by:

resolveInternationalMessage in interface InternationalMessageService

Returns:

- a DB InternationalMessage or null if not found.

findById

public InternationalMessage findById(Long id)

Specified by:

findById in interface InternationalMessageService

removeFromCache

public void removeFromCache(InternationalMessage internationalMessage,
 String profileId)

Specified by:

removeFromCache in interface InternationalMessageService

getOverrideMessage

protected String getOverrideMessage(String propertyName,
 Locale locale)

getTemplateMessage

protected String getTemplateMessage(String standardCacheKey,
 String propertyName,
 String localeCode,
 String localeCountryCode,
 String specificPropertyKey,
 String generalPropertyKey)

findBestStandardMessage

public InternationalMessage findBestStandardMessage(String specificPropertyKey,
 String generalPropertyKey,
 Map<String,org.broadleafcommerce.common.extension.StandardCacheItem> propertyTranslationMap)

Description copied from interface: InternationalMessageSupport

Find the most appropriate message in the map. The most specific qualified message will win.

Specified by:

findBestStandardMessage in interface InternationalMessageSupport

Returns:

findBestTemplateMessage

public InternationalMessage findBestTemplateMessage(String specificPropertyKey,
 String generalPropertyKey,
 Map<String,InternationalMessage> propertyTranslationMap)

Description copied from interface: InternationalMessageSupport

Find the most appropriate message in the map. The most specific qualified message will win.

Specified by:

findBestTemplateMessage in interface InternationalMessageSupport

Returns:

getCacheKey

public String getCacheKey(String propertyName,
 org.broadleafcommerce.common.extension.ResultType resultType)

Description copied from interface: InternationalMessageSupport

Build a cache key

Specified by:

getCacheKey in interface InternationalMessageSupport

Returns:

getCacheKeyListForTemplateSite

public List<String> getCacheKeyListForTemplateSite(String propertyName)

Description copied from interface: InternationalMessageSupport

Returns a list of cacheKeys for a template site

Specified by:

getCacheKeyListForTemplateSite in interface InternationalMessageSupport

Returns:

getInternationalMessageCache

public javax.cache.Cache getInternationalMessageCache()

Description copied from interface: InternationalMessageSupport

Retrieve the backing cache

Specified by:

getInternationalMessageCache in interface InternationalMessageSupport

Returns:

getThresholdForFullCache

public int getThresholdForFullCache()

Description copied from interface: InternationalMessageSupport

Retrieve the threshold under which the full list of standard site message overrides are cached. See thresholdForFullCache for more information on setting the value.

Specified by:

getThresholdForFullCache in interface InternationalMessageSupport

Returns:

setThresholdForFullCache

public void setThresholdForFullCache(int thresholdForFullCache)

Specified by:

setThresholdForFullCache in interface InternationalMessageSupport

getTemplateThresholdForFullCache

public int getTemplateThresholdForFullCache()

Description copied from interface: InternationalMessageSupport

Retrieve the threshold under which the full list of template catalog messages are cached. See templateThresholdForFullCache for more information on setting the value.

Specified by:

getTemplateThresholdForFullCache in interface InternationalMessageSupport

Returns:

setTemplateThresholdForFullCache

public void setTemplateThresholdForFullCache(int templateThresholdForFullCache)

Specified by:

setTemplateThresholdForFullCache in interface InternationalMessageSupport

lookupMessageFromMap

public org.broadleafcommerce.common.extension.StandardCacheItem lookupMessageFromMap(String key,
 Map<String,org.broadleafcommerce.common.extension.StandardCacheItem> propertyTranslationMap)

Description copied from interface: InternationalMessageSupport

Look up a cached message from the map based on a key

Specified by:

lookupMessageFromMap in interface InternationalMessageSupport

Returns:

replaceEmptyWithNullResponse

protected String replaceEmptyWithNullResponse(String response)