Top Description Fields Constructors Methods
org.springframework.context.support

public abstract Class AbstractResourceBasedMessageSource

extends AbstractMessageSource
Class Inheritance
Known Direct Subclasses
org.springframework.context.support.ReloadableResourceBundleMessageSource, org.springframework.context.support.ResourceBundleMessageSource
Imports
java.util.LinkedHashSet, .Locale, .Set, org.springframework.lang.Nullable, org.springframework.util.Assert, .ObjectUtils
Abstract base class for MessageSource implementations based on resource bundle conventions, such as ResourceBundleMessageSource and ReloadableResourceBundleMessageSource. Provides common configuration methods and corresponding semantic definitions.
Author
Juergen Hoeller
Since
4.3
See Also
ResourceBundleMessageSource, ReloadableResourceBundleMessageSource

Field Summary

Modifier and TypeField and Description
private final Set<String>
basenameSet

private long
cacheMillis

private String
defaultEncoding

private Locale
defaultLocale

private boolean
fallbackToSystemLocale

Constructor Summary

AccessConstructor and Description
public
AbstractResourceBasedMessageSource()

Method Summary

Modifier and TypeMethod and Description
public void
addBasenames(String... basenames)

Add the specified basenames to the existing basename configuration.

public Set<String>
getBasenameSet()

Return this MessageSource's basename set, containing entries in the order of registration.

protected long
getCacheMillis()

Return the number of milliseconds to cache loaded properties files.

protected String
getDefaultEncoding()

Return the default charset to use for parsing properties files, if any.

protected Locale
getDefaultLocale()

Determine a default Locale to fall back to: either a locally specified default Locale or the system Locale, or null for no fallback locale at all.

protected boolean
isFallbackToSystemLocale()

Deprecated as of 5.2.2, in favor of getDefaultLocale()
Return whether to fall back to the system Locale if no files for a specific Locale have been found.
public void
setBasename(String
the single basename
basename)

Set a single basename, following the basic ResourceBundle convention of not specifying file extension or language codes.

public void
setBasenames(String...
an array of basenames
basenames)

Set an array of basenames, each following the basic ResourceBundle convention of not specifying file extension or language codes.

public void
setCacheMillis(long cacheMillis)

Set the number of milliseconds to cache loaded properties files.

public void
setCacheSeconds(int cacheSeconds)

Set the number of seconds to cache loaded properties files.

public void
setDefaultEncoding(String
the default charset
defaultEncoding)

Set the default charset to use for parsing properties files.

public void
setDefaultLocale(Locale defaultLocale)

Specify a default Locale to fall back to, as an alternative to falling back to the system Locale.

public void
setFallbackToSystemLocale(boolean fallbackToSystemLocale)

Set whether to fall back to the system Locale if no files for a specific Locale have been found.

Inherited from org.springframework.context.support.AbstractMessageSource:
getCommonMessagesgetDefaultMessagegetDefaultMessagegetMessagegetMessagegetMessagegetMessageFromParentgetMessageInternalgetParentMessageSourceisUseCodeAsDefaultMessageresolveArgumentsresolveCoderesolveCodeWithoutArgumentssetCommonMessagessetParentMessageSourcesetUseCodeAsDefaultMessage

Field Detail

basenameSetback to summary
private final Set<String> basenameSet
cacheMillisback to summary
private long cacheMillis
defaultEncodingback to summary
private String defaultEncoding
Annotations
@Nullable
defaultLocaleback to summary
private Locale defaultLocale
Annotations
@Nullable
fallbackToSystemLocaleback to summary
private boolean fallbackToSystemLocale

Constructor Detail

AbstractResourceBasedMessageSourceback to summary
public AbstractResourceBasedMessageSource()

Method Detail

addBasenamesback to summary
public void addBasenames(String... basenames)

Add the specified basenames to the existing basename configuration.

Note

If a given basename already exists, the position of its entry will remain as in the original set. New entries will be added at the end of the list, to be searched after existing basenames.

Since
4.3
See Also
setBasenames, java.util.ResourceBundle
getBasenameSetback to summary
public Set<String> getBasenameSet()

Return this MessageSource's basename set, containing entries in the order of registration.

Calling code may introspect this set as well as add or remove entries.

Since
4.3
See Also
setBasenames, addBasenames
getCacheMillisback to summary
protected long getCacheMillis()

Return the number of milliseconds to cache loaded properties files.

Since
4.3
getDefaultEncodingback to summary
protected String getDefaultEncoding()

Return the default charset to use for parsing properties files, if any.

Annotations
@Nullable
Since
4.3
getDefaultLocaleback to summary
protected Locale getDefaultLocale()

Determine a default Locale to fall back to: either a locally specified default Locale or the system Locale, or null for no fallback locale at all.

Annotations
@Nullable
Since
5.2.2
See Also
setDefaultLocale, setFallbackToSystemLocale, Locale#getDefault()
isFallbackToSystemLocaleback to summary
protected boolean isFallbackToSystemLocale()

Deprecated

as of 5.2.2, in favor of getDefaultLocale()

Return whether to fall back to the system Locale if no files for a specific Locale have been found.

Annotations
@Deprecated
Since
4.3
setBasenameback to summary
public void setBasename(String basename)

Set a single basename, following the basic ResourceBundle convention of not specifying file extension or language codes. The resource location format is up to the specific MessageSource implementation.

Regular and XMl properties files are supported: e.g. "messages" will find a "messages.properties", "messages_en.properties" etc arrangement as well as "messages.xml", "messages_en.xml" etc.

Parameters
basename:String

the single basename

See Also
setBasenames, org.springframework.core.io.ResourceEditor, java.util.ResourceBundle
setBasenamesback to summary
public void setBasenames(String... basenames)

Set an array of basenames, each following the basic ResourceBundle convention of not specifying file extension or language codes. The resource location format is up to the specific MessageSource implementation.

Regular and XMl properties files are supported: e.g. "messages" will find a "messages.properties", "messages_en.properties" etc arrangement as well as "messages.xml", "messages_en.xml" etc.

The associated resource bundles will be checked sequentially when resolving a message code. Note that message definitions in a previous resource bundle will override ones in a later bundle, due to the sequential lookup.

Note

In contrast to addBasenames, this replaces existing entries with the given names and can therefore also be used to reset the configuration.

Parameters
basenames:String[]

an array of basenames

See Also
setBasename, java.util.ResourceBundle
setCacheMillisback to summary
public void setCacheMillis(long cacheMillis)

Set the number of milliseconds to cache loaded properties files. Note that it is common to set seconds instead: setCacheSeconds.

  • Default is "-1", indicating to cache forever (matching the default behavior of java.util.ResourceBundle). Note that this constant follows Spring conventions, not java.util.ResourceBundle.Control#getTimeToLive.
  • A positive number will cache loaded properties files for the given number of milliseconds. This is essentially the interval between refresh checks. Note that a refresh attempt will first check the last-modified timestamp of the file before actually reloading it; so if files don't change, this interval can be set rather low, as refresh attempts will not actually reload.
  • A value of "0" will check the last-modified timestamp of the file on every message access. Do not use this in a production environment!
Since
4.3
See Also
setCacheSeconds
setCacheSecondsback to summary
public void setCacheSeconds(int cacheSeconds)

Set the number of seconds to cache loaded properties files.

  • Default is "-1", indicating to cache forever (matching the default behavior of java.util.ResourceBundle). Note that this constant follows Spring conventions, not java.util.ResourceBundle.Control#getTimeToLive.
  • A positive number will cache loaded properties files for the given number of seconds. This is essentially the interval between refresh checks. Note that a refresh attempt will first check the last-modified timestamp of the file before actually reloading it; so if files don't change, this interval can be set rather low, as refresh attempts will not actually reload.
  • A value of "0" will check the last-modified timestamp of the file on every message access. Do not use this in a production environment!

Note that depending on your ClassLoader, expiration might not work reliably since the ClassLoader may hold on to a cached version of the bundle file. Prefer ReloadableResourceBundleMessageSource over ResourceBundleMessageSource in such a scenario, in combination with a non-classpath location.

setDefaultEncodingback to summary
public void setDefaultEncoding(String defaultEncoding)

Set the default charset to use for parsing properties files. Used if no file-specific charset is specified for a file.

The effective default is the java.util.Properties default encoding: ISO-8859-1. A null value indicates the platform default encoding.

Only applies to classic properties files, not to XML files.

Parameters
defaultEncoding:String

the default charset

setDefaultLocaleback to summary
public void setDefaultLocale(Locale defaultLocale)

Specify a default Locale to fall back to, as an alternative to falling back to the system Locale.

Default is to fall back to the system Locale. You may override this with a locally specified default Locale here, or enforce no fallback locale at all through disabling "fallbackToSystemLocale".

Since
5.2.2
See Also
setFallbackToSystemLocale, getDefaultLocale()
setFallbackToSystemLocaleback to summary
public void setFallbackToSystemLocale(boolean fallbackToSystemLocale)

Set whether to fall back to the system Locale if no files for a specific Locale have been found. Default is "true"; if this is turned off, the only fallback will be the default file (e.g. "messages.properties" for basename "messages").

Falling back to the system Locale is the default behavior of java.util.ResourceBundle. However, this is often not desirable in an application server environment, where the system Locale is not relevant to the application at all: set this flag to "false" in such a scenario.

See Also
setDefaultLocale