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

Interface InternationalMessageSupport

All Known Implementing Classes:

InternationalMessageServiceImpl

public interface InternationalMessageSupport

InternationalMessageService functionality, primarily in support of InternationalMessageOverrideStrategy instances.

Author:

Jeff Fischer

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.
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
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	setTemplateThresholdForFullCache(int templateThresholdForFullCache)
void	setThresholdForFullCache(int thresholdForFullCache)

Method Details

getInternationalMessageCache

javax.cache.Cache getInternationalMessageCache()

Retrieve the backing cache

Returns:

getThresholdForFullCache

int getThresholdForFullCache()

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

Returns:

setThresholdForFullCache

void setThresholdForFullCache(int thresholdForFullCache)

getTemplateThresholdForFullCache

int getTemplateThresholdForFullCache()

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

Returns:

setTemplateThresholdForFullCache

void setTemplateThresholdForFullCache(int templateThresholdForFullCache)

findBestStandardMessage

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

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

Parameters:

specificPropertyKey -

generalPropertyKey -

propertyTranslationMap -

Returns:

lookupMessageFromMap

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

Parameters:

key -

propertyTranslationMap -

Returns:

findBestTemplateMessage

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

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

Parameters:

specificPropertyKey -

generalPropertyKey -

propertyTranslationMap -

Returns:

getCacheKey

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

Build a cache key

Parameters:

propertyName -

resultType -

Returns:

getCacheKeyListForTemplateSite

List<String> getCacheKeyListForTemplateSite(String propertyName)

Returns a list of cacheKeys for a template site

Parameters:

propertyName -

Returns: