com.haulmont.cuba.core.sys

Class AbstractMessages

java.lang.Object

com.haulmont.cuba.core.sys.AbstractMessages

All Implemented Interfaces:

Messages

Direct Known Subclasses:

MessagesClientImpl, MessagesImpl

public abstract class AbstractMessages
extends java.lang.Object
implements Messages

Messages implementation common for all tiers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLE_NAME
protected java.lang.String	confDir
static java.lang.String	EXT
protected com.google.common.cache.Cache<java.lang.String,java.util.Properties>	filePropertiesCache
protected FormatStringsRegistry	formatStringsRegistry
protected GlobalConfig	globalConfig
protected java.lang.String	mainMessagePack
protected MessageTools	messageTools
protected java.util.Map<java.lang.String,java.lang.String>	notFoundCache
protected static java.util.Properties	PROPERTIES_NOT_FOUND
protected com.google.common.cache.Cache<java.lang.String,java.util.Properties>	resourcePropertiesCache
protected java.util.Map<java.lang.String,java.lang.String>	strCache

Fields inherited from interface com.haulmont.cuba.core.global.Messages

NAME

Constructor Summary

Constructors

Constructor and Description
AbstractMessages()

Method Summary

Modifier and Type	Method and Description
protected void	cache(java.lang.String key, java.lang.String msg)
void	clearCache()
protected boolean	enterPack(java.lang.String pack, java.util.Locale locale, java.util.Locale truncatedLocale, java.util.Set<java.lang.String> passedPacks)
java.lang.String	findMessage(java.lang.String packs, java.lang.String key, java.util.Locale locale) Returns localized message or null if not found.
java.lang.String	formatMainMessage(java.lang.String key, java.lang.Object... params) Get localized message from main message pack and use it as a format string for parameters provided. Locale is determined by the current user session.
java.lang.String	formatMessage(java.lang.Class caller, java.lang.String key, java.util.Locale locale, java.lang.Object... params) Get localized message and use it as a format string for parameters provided
java.lang.String	formatMessage(java.lang.Class caller, java.lang.String key, java.lang.Object... params) Get localized message and use it as a format string for parameters provided. Locale is determined by the current user session.
java.lang.String	formatMessage(java.lang.String pack, java.lang.String key, java.util.Locale locale, java.lang.Object... params) Get localized message and use it as a format string for parameters provided
java.lang.String	formatMessage(java.lang.String pack, java.lang.String key, java.lang.Object... params) Get localized message and use it as a format string for parameters provided. Locale is determined by the current user session.
int	getCacheSize()
protected java.lang.String	getLocaleSuffix(java.util.Locale locale)
java.lang.String	getMainMessage(java.lang.String key) Returns localized message using main message pack. Locale is determined by the current user session.
java.lang.String	getMainMessage(java.lang.String key, java.util.Locale locale) Returns localized message
java.lang.String	getMainMessagePack()
java.lang.String	getMessage(java.lang.Class caller, java.lang.String key) Returns localized message. Locale is determined by the current user session.
java.lang.String	getMessage(java.lang.Class caller, java.lang.String key, java.util.Locale locale) Returns localized message
java.lang.String	getMessage(java.lang.Enum caller) Returns localized message. Locale is determined by the current user session.
java.lang.String	getMessage(java.lang.Enum caller, java.util.Locale locale) Returns localized message
java.lang.String	getMessage(java.lang.String pack, java.lang.String key) Returns localized message. Locale is determined by the current user session.
java.lang.String	getMessage(java.lang.String packs, java.lang.String key, java.util.Locale locale) Returns localized message
protected java.lang.String	getMessageFromProperties(java.lang.String pack, java.lang.String key, java.util.Locale locale, java.util.Locale truncatedLocale, java.util.Properties properties, java.util.Set<java.lang.String> passedPacks)
protected java.lang.String	getPackName(java.lang.Class c)
MessageTools	getTools() Convenient access to MessageTools bean.
protected abstract java.util.Locale	getUserLocale()
protected void	init()
protected java.lang.String	internalGetMessage(java.lang.String packs, java.lang.String key, java.util.Locale locale, java.lang.String defaultValue, boolean searchMainIfNotFound)
protected java.util.Properties	loadPropertiesFromFile(java.lang.String packPath, java.util.Locale locale, java.util.Locale truncatedLocale)
protected java.util.Properties	loadPropertiesFromResource(java.lang.String packPath, java.util.Locale locale, java.util.Locale truncatedLocale)
protected java.lang.String	makeCacheKey(java.lang.String pack, java.lang.String key, java.util.Locale locale, java.util.Locale truncatedLocale)
protected java.lang.String	searchClasspath(java.lang.String pack, java.lang.String key, java.util.Locale locale, java.util.Locale truncatedLocale, java.util.Set<java.lang.String> passedPacks)
protected java.lang.String	searchFiles(java.lang.String pack, java.lang.String key, java.util.Locale locale, java.util.Locale truncatedLocale, java.util.Set<java.lang.String> passedPacks)
protected java.lang.String	searchIncludes(java.util.Properties properties, java.lang.String key, java.util.Locale locale, java.util.Locale truncatedLocale, java.util.Set<java.lang.String> passedPacks)
protected java.lang.String	searchMessage(java.lang.String packs, java.lang.String key, java.util.Locale locale, java.util.Locale truncatedLocale, java.util.Set<java.lang.String> passedPacks)
protected java.lang.String	searchOnePack(java.lang.String pack, java.lang.String key, java.util.Locale locale, java.util.Locale truncatedLocale, java.util.Set<java.lang.String> passedPacks)
protected abstract java.lang.String	searchRemotely(java.lang.String pack, java.lang.String key, java.util.Locale locale)
void	setConfiguration(Configuration configuration)

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_NAME

public static final java.lang.String BUNDLE_NAME

See Also:

Constant Field Values

EXT

public static final java.lang.String EXT

See Also:

Constant Field Values

messageTools

@Inject
protected MessageTools messageTools

formatStringsRegistry

@Inject
protected FormatStringsRegistry formatStringsRegistry

globalConfig

protected GlobalConfig globalConfig

confDir

protected java.lang.String confDir

mainMessagePack

protected java.lang.String mainMessagePack

strCache

protected java.util.Map<java.lang.String,java.lang.String> strCache

notFoundCache

protected java.util.Map<java.lang.String,java.lang.String> notFoundCache

filePropertiesCache

protected com.google.common.cache.Cache<java.lang.String,java.util.Properties> filePropertiesCache

resourcePropertiesCache

protected com.google.common.cache.Cache<java.lang.String,java.util.Properties> resourcePropertiesCache

PROPERTIES_NOT_FOUND

protected static final java.util.Properties PROPERTIES_NOT_FOUND

Constructor Detail

AbstractMessages

public AbstractMessages()

Method Detail

getUserLocale

protected abstract java.util.Locale getUserLocale()

searchRemotely

@Nullable
protected abstract java.lang.String searchRemotely(java.lang.String pack,
                                                             java.lang.String key,
                                                             java.util.Locale locale)

setConfiguration

@Inject
public void setConfiguration(Configuration configuration)

init

@PostConstruct
protected void init()

getTools

public MessageTools getTools()

Description copied from interface: Messages

Convenient access to MessageTools bean.

Specified by:

getTools in interface Messages

Returns:

MessageTools instance

getMainMessagePack

public java.lang.String getMainMessagePack()

Specified by:

getMainMessagePack in interface Messages

Returns:

main message pack for this application tier

getMessage

public java.lang.String getMessage(java.lang.Class caller,
                                   java.lang.String key)

Description copied from interface: Messages

Returns localized message.
Locale is determined by the current user session.

Specified by:

getMessage in interface Messages

Parameters:

caller - class determining the message pack as full package name

key - message key

Returns:

localized message or the key if the message not found

formatMessage

public java.lang.String formatMessage(java.lang.Class caller,
                                      java.lang.String key,
                                      java.lang.Object... params)

Description copied from interface: Messages

Get localized message and use it as a format string for parameters provided.
Locale is determined by the current user session.

Specified by:

formatMessage in interface Messages

Parameters:

caller - class determining the message pack as full package name

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getMessage

public java.lang.String getMessage(java.lang.Class caller,
                                   java.lang.String key,
                                   java.util.Locale locale)

Description copied from interface: Messages

Returns localized message

Specified by:

getMessage in interface Messages

Parameters:

caller - class determining the message pack as full package name

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

formatMessage

public java.lang.String formatMessage(java.lang.Class caller,
                                      java.lang.String key,
                                      java.util.Locale locale,
                                      java.lang.Object... params)

Description copied from interface: Messages

Get localized message and use it as a format string for parameters provided

Specified by:

formatMessage in interface Messages

Parameters:

caller - class determining the message pack as full package name

key - message key

locale - message locale

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getMessage

public java.lang.String getMessage(java.lang.Enum caller)

Description copied from interface: Messages

Returns localized message.
Locale is determined by the current user session.

Specified by:

getMessage in interface Messages

Parameters:

caller - enum determining the message pack and key:

• pack - enum's full package name
• key - enum's short class name (after last dot), plus dot, plus enum value

Returns:

localized message or the key if the message not found

getMessage

public java.lang.String getMessage(java.lang.Enum caller,
                                   java.util.Locale locale)

Description copied from interface: Messages

Returns localized message

Specified by:

getMessage in interface Messages

Parameters:

caller - enum determining the message pack and key:

• pack - enum's full package name
• key - enum's short class name (after last dot), plus dot, plus enum value

locale - message locale

Returns:

localized message or the key if the message not found

getMessage

public java.lang.String getMessage(java.lang.String pack,
                                   java.lang.String key)

Description copied from interface: Messages

Returns localized message.
Locale is determined by the current user session.

Specified by:

getMessage in interface Messages

Parameters:

pack - package name to start searching the message. If the key is not found in this package, it will be searched in parent package, and so forth

key - message key

Returns:

localized message or the key if the message not found

getMainMessage

public java.lang.String getMainMessage(java.lang.String key)

Description copied from interface: Messages

Returns localized message using main message pack.
Locale is determined by the current user session.

Specified by:

getMainMessage in interface Messages

Parameters:

key - message key

Returns:

localized message or the key if the message not found

getMainMessage

public java.lang.String getMainMessage(java.lang.String key,
                                       java.util.Locale locale)

Description copied from interface: Messages

Returns localized message

Specified by:

getMainMessage in interface Messages

Parameters:

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

formatMessage

public java.lang.String formatMessage(java.lang.String pack,
                                      java.lang.String key,
                                      java.lang.Object... params)

Description copied from interface: Messages

Get localized message and use it as a format string for parameters provided.
Locale is determined by the current user session.

Specified by:

formatMessage in interface Messages

Parameters:

pack - package name to start searching the message. If the key is not found in this package, it will be searched in parent package, and so forth

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

formatMainMessage

public java.lang.String formatMainMessage(java.lang.String key,
                                          java.lang.Object... params)

Description copied from interface: Messages

Get localized message from main message pack and use it as a format string for parameters provided.
Locale is determined by the current user session.

Specified by:

formatMainMessage in interface Messages

Parameters:

key - message key

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getMessage

public java.lang.String getMessage(java.lang.String packs,
                                   java.lang.String key,
                                   java.util.Locale locale)

Description copied from interface: Messages

Returns localized message

Specified by:

getMessage in interface Messages

Parameters:

packs - list of whitespace-separated package names. Searching of message is performed in reverse order - starts from last name in the list. Each package is searched for the key, if the key is not found in this package, it is searched in parent package, and so forth

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

findMessage

@Nullable
public java.lang.String findMessage(java.lang.String packs,
                                              java.lang.String key,
                                              @Nullable
                                              java.util.Locale locale)

Description copied from interface: Messages

Returns localized message or null if not found.

Specified by:

findMessage in interface Messages

Parameters:

packs - list of whitespace-separated package names. Searching of message is performed in reverse order - starts from last name in the list. Each package is searched for the key, if the key is not found in this package, it is searched in parent package, and so forth

key - message key

locale - message locale. If null, current user locale is used.

Returns:

localized message or null if the message not found

formatMessage

public java.lang.String formatMessage(java.lang.String pack,
                                      java.lang.String key,
                                      java.util.Locale locale,
                                      java.lang.Object... params)

Description copied from interface: Messages

Get localized message and use it as a format string for parameters provided

Specified by:

formatMessage in interface Messages

Parameters:

pack - package name to start searching the message. If the key is not found in this package, it will be searched in parent package, and so forth

key - message key

locale - message locale

params - parameter values

Returns:

formatted string or the key in case of IllegalFormatException

getCacheSize

public int getCacheSize()

Specified by:

getCacheSize in interface Messages

clearCache

public void clearCache()

Specified by:

clearCache in interface Messages

internalGetMessage

protected java.lang.String internalGetMessage(java.lang.String packs,
                                              java.lang.String key,
                                              java.util.Locale locale,
                                              java.lang.String defaultValue,
                                              boolean searchMainIfNotFound)

searchMessage

@Nullable
protected java.lang.String searchMessage(java.lang.String packs,
                                                   java.lang.String key,
                                                   java.util.Locale locale,
                                                   java.util.Locale truncatedLocale,
                                                   java.util.Set<java.lang.String> passedPacks)

enterPack

protected boolean enterPack(java.lang.String pack,
                            java.util.Locale locale,
                            java.util.Locale truncatedLocale,
                            java.util.Set<java.lang.String> passedPacks)

searchOnePack

protected java.lang.String searchOnePack(java.lang.String pack,
                                         java.lang.String key,
                                         java.util.Locale locale,
                                         java.util.Locale truncatedLocale,
                                         java.util.Set<java.lang.String> passedPacks)

cache

protected void cache(java.lang.String key,
                     java.lang.String msg)

searchFiles

protected java.lang.String searchFiles(java.lang.String pack,
                                       java.lang.String key,
                                       java.util.Locale locale,
                                       java.util.Locale truncatedLocale,
                                       java.util.Set<java.lang.String> passedPacks)

searchClasspath

protected java.lang.String searchClasspath(java.lang.String pack,
                                           java.lang.String key,
                                           java.util.Locale locale,
                                           java.util.Locale truncatedLocale,
                                           java.util.Set<java.lang.String> passedPacks)

getMessageFromProperties

@Nullable
protected java.lang.String getMessageFromProperties(java.lang.String pack,
                                                              java.lang.String key,
                                                              java.util.Locale locale,
                                                              java.util.Locale truncatedLocale,
                                                              java.util.Properties properties,
                                                              java.util.Set<java.lang.String> passedPacks)

searchIncludes

@Nullable
protected java.lang.String searchIncludes(java.util.Properties properties,
                                                    java.lang.String key,
                                                    java.util.Locale locale,
                                                    @Nullable
                                                    java.util.Locale truncatedLocale,
                                                    java.util.Set<java.lang.String> passedPacks)

loadPropertiesFromFile

protected java.util.Properties loadPropertiesFromFile(java.lang.String packPath,
                                                      java.util.Locale locale,
                                                      java.util.Locale truncatedLocale)

loadPropertiesFromResource

protected java.util.Properties loadPropertiesFromResource(java.lang.String packPath,
                                                          java.util.Locale locale,
                                                          java.util.Locale truncatedLocale)

getLocaleSuffix

protected java.lang.String getLocaleSuffix(java.util.Locale locale)

makeCacheKey

protected java.lang.String makeCacheKey(java.lang.String pack,
                                        java.lang.String key,
                                        @Nullable
                                        java.util.Locale locale,
                                        @Nullable
                                        java.util.Locale truncatedLocale)

getPackName

protected java.lang.String getPackName(java.lang.Class c)