HotDeployResourceBundleMessageSource (bboss-core 5.2.7 API)

java.lang.Object
- org.frameworkset.spi.support.MessageSourceSupport
- - org.frameworkset.spi.support.AbstractMessageSource
  - - org.frameworkset.spi.support.HotDeployResourceBundleMessageSource

All Implemented Interfaces:

ResourceLoaderAware, HierarchicalMessageSource, MessageSource
```
public class HotDeployResourceBundleMessageSource
extends AbstractMessageSource
implements ResourceLoaderAware
```
Title: HotDeployResourceBundleMessageSource.java

Description:

bboss workgroup

Copyright (c) 2007

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class HotDeployResourceBundleMessageSource.PropertiesHolder
PropertiesHolder for caching.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`HotDeployResourceBundleMessageSource.PropertiesHolder` PropertiesHolder for caching.

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger log
Logger available to subclasses
- Fields inherited from class org.frameworkset.spi.support.MessageSourceSupport
  logger

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`log` Logger available to subclasses

Constructor Summary

Constructors
Constructor and Description

HotDeployResourceBundleMessageSource()

Constructors
Constructor and Description
`HotDeployResourceBundleMessageSource()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.List`	`calculateAllFilenames(java.lang.String basename, java.util.Locale locale)` Calculate all filenames for the given bundle basename and Locale.
`protected java.util.List`	`calculateFilenamesForLocale(java.lang.String basename, java.util.Locale locale)` Calculate the filenames for the given bundle basename and Locale, appending language code, country code, and variant code.
`void`	`clearCache()` Clear the resource bundle cache.
`void`	`clearCacheIncludingAncestors()` Clear the resource bundle caches of this MessageSource and all its ancestors.
`void`	`destroy()` 注销国际化资源
`protected HotDeployResourceBundleMessageSource.PropertiesHolder`	`firstLoadProperties(java.lang.String filename)`
`java.lang.ClassLoader`	`getBundleClassLoader()`
`protected HotDeployResourceBundleMessageSource.PropertiesHolder`	`getMergedProperties(java.util.Locale locale)` Get a PropertiesHolder that contains the actually visible properties for a Locale, after merging all specified resource bundles.
`protected HotDeployResourceBundleMessageSource.PropertiesHolder`	`getProperties(java.lang.String filename)` Get a PropertiesHolder for the given filename, either from the cache or freshly loaded.
`boolean`	`isChangemonitor()`
`protected java.util.Properties`	`loadProperties(org.frameworkset.util.io.Resource resource, java.lang.String filename)` Load the properties from the given resource.
`protected HotDeployResourceBundleMessageSource.PropertiesHolder`	`refreshProperties(java.io.File filepath, java.lang.String basename, java.lang.String relativefile)` Refresh the PropertiesHolder for the given bundle filename.
`protected java.text.MessageFormat`	`resolveCode(java.lang.String code, java.util.Locale locale)` Resolves the given message code as key in the retrieved bundle files, using a cached MessageFormat instance per message code.
`protected java.lang.String`	`resolveCodeWithoutArguments(java.lang.String code, java.util.Locale locale)` Resolves the given message code as key in the retrieved bundle files, returning the value found in the bundle as-is (without MessageFormat parsing).
`void`	`setBasename(java.lang.String basename)` Set a single basename, following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to {ResourceBundleMessageSource} referring to a Bboss resource location: e.g.
`void`	`setBasenames(java.lang.String[] basenames)` Set an array of basenames, each following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to { ResourceBundleMessageSource} referring to a Bboss resource location: e.g.
`void`	`setBundleClassLoader(java.lang.ClassLoader bundleClassLoader)`
`void`	`setChangemonitor(boolean changemonitor)`
`void`	`setDefaultEncoding(java.lang.String defaultEncoding)` Set the default charset to use for parsing properties files.
`void`	`setFallbackToSystemLocale(boolean fallbackToSystemLocale)` Set whether to fall back to the system Locale if no files for a specific Locale have been found.
`void`	`setFileEncodings(java.util.Properties fileEncodings)` Set per-file charsets to use for parsing properties files.
`void`	`setPropertiesPersister(org.frameworkset.util.PropertiesPersister propertiesPersister)` Set the PropertiesPersister to use for parsing properties files.
`void`	`setResourceLoader(org.frameworkset.util.io.ResourceLoader resourceLoader)` Set the ResourceLoader to use for loading bundle properties files.
`static void`	`stopmonitor()`
`java.lang.String`	`toString()`

Methods inherited from class org.frameworkset.spi.support.AbstractMessageSource
getDefaultMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessageFromParent, getMessageInternal, getParentMessageSource, isUseCodeAsDefaultMessage, renderDefaultMessage, resolveArguments, setParentMessageSource, setUseCodeAsDefaultMessage

Methods inherited from class org.frameworkset.spi.support.MessageSourceSupport
createMessageFormat, formatMessage, isAlwaysUseMessageFormat, setAlwaysUseMessageFormat

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
protected static final org.slf4j.Logger log
```
    Logger available to subclasses
- Constructor Detail
  - HotDeployResourceBundleMessageSource
```
public HotDeployResourceBundleMessageSource()
```
- Method Detail
  - setBasename
```
public void setBasename(java.lang.String basename)
```
    Set a single basename, following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to {ResourceBundleMessageSource} referring to a Bboss resource location: e.g. "WEB-INF/messages" for "WEB-INF/messages.properties", "WEB-INF/messages_en.properties", etc.
    As of Bboss 1.2.2, XML properties files are also supported: e.g. "WEB-INF/messages" will find and load "WEB-INF/messages.xml", "WEB-INF/messages_en.xml", etc as well. Note that this will only work on JDK 1.5+.
    
    Parameters:
    
    basename - the single basename
    
    See Also:
    
    setBasenames(java.lang.String[]), ResourceEditor, ResourceBundle
  - setBasenames
```
public void setBasenames(java.lang.String[] basenames)
```
    Set an array of basenames, each following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to { ResourceBundleMessageSource} referring to a Bboss resource location: e.g. "WEB-INF/messages" for "WEB-INF/messages.properties", "WEB-INF/messages_en.properties", etc.
    As of Bboss 1.2.2, XML properties files are also supported: e.g. "WEB-INF/messages" will find and load "WEB-INF/messages.xml", "WEB-INF/messages_en.xml", etc as well. Note that this will only work on JDK 1.5+.
    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.
    
    Parameters:
    
    basenames - an array of basenames
    
    See Also:
    
    setBasename(java.lang.String), ResourceBundle
  - setDefaultEncoding
```
public void setDefaultEncoding(java.lang.String defaultEncoding)
```
    Set the default charset to use for parsing properties files. Used if no file-specific charset is specified for a file.
    Default is none, using the java.util.Properties default encoding.
    Only applies to classic properties files, not to XML files.
    
    Parameters:
    
    defaultEncoding - the default charset
    
    See Also:
    
    setFileEncodings(java.util.Properties)
  - setFileEncodings
```
public void setFileEncodings(java.util.Properties fileEncodings)
```
    Set per-file charsets to use for parsing properties files.
    Only applies to classic properties files, not to XML files.
    
    Parameters:
    
    fileEncodings - Properties with filenames as keys and charset names as values. Filenames have to match the basename syntax, with optional locale-specific appendices: e.g. "WEB-INF/messages" or "WEB-INF/messages_en".
    
    See Also:
    
    setBasenames(java.lang.String[])
  - setFallbackToSystemLocale
```
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.
  - setPropertiesPersister
```
public void setPropertiesPersister(org.frameworkset.util.PropertiesPersister propertiesPersister)
```
    Set the PropertiesPersister to use for parsing properties files.
    The default is a DefaultPropertiesPersister.
  - setResourceLoader
```
public void setResourceLoader(org.frameworkset.util.io.ResourceLoader resourceLoader)
```
    Set the ResourceLoader to use for loading bundle properties files.
    The default is a DefaultResourceLoader. Will get overridden by the ApplicationContext if running in a context, as it implements the ResourceLoaderAware interface. Can be manually overridden when running outside of an ApplicationContext.
    
    Specified by:
    
    setResourceLoader in interface ResourceLoaderAware
    
    Parameters:
    
    resourceLoader - ResourceLoader object to be used by this object
    
    See Also:
    
    DefaultResourceLoader, ResourceLoaderAware
  - resolveCodeWithoutArguments
```
protected java.lang.String resolveCodeWithoutArguments(java.lang.String code,
                                                       java.util.Locale locale)
```
    Resolves the given message code as key in the retrieved bundle files, returning the value found in the bundle as-is (without MessageFormat parsing).
    
    Overrides:
    
    resolveCodeWithoutArguments in class AbstractMessageSource
    
    Parameters:
    
    code - the code of the message to resolve
    
    locale - the Locale to resolve the code for (subclasses are encouraged to support internationalization)
    
    Returns:
    
    the message String, or null if not found
    
    See Also:
    
    AbstractMessageSource.resolveCode(java.lang.String, java.util.Locale), MessageFormat
  - resolveCode
```
protected java.text.MessageFormat resolveCode(java.lang.String code,
                                              java.util.Locale locale)
```
    Resolves the given message code as key in the retrieved bundle files, using a cached MessageFormat instance per message code.
    
    Specified by:
    
    resolveCode in class AbstractMessageSource
    
    Parameters:
    
    code - the code of the message to resolve
    
    locale - the Locale to resolve the code for (subclasses are encouraged to support internationalization)
    
    Returns:
    
    the MessageFormat for the message, or null if not found
    
    See Also:
    
    AbstractMessageSource.resolveCodeWithoutArguments(String, java.util.Locale)
  - getMergedProperties
```
protected HotDeployResourceBundleMessageSource.PropertiesHolder getMergedProperties(java.util.Locale locale)
```
    Get a PropertiesHolder that contains the actually visible properties for a Locale, after merging all specified resource bundles. Either fetches the holder from the cache or freshly loads it.
    Only used when caching resource bundle contents forever, i.e. with cacheSeconds < 0. Therefore, merged properties are always cached forever.
  - calculateAllFilenames
```
protected java.util.List calculateAllFilenames(java.lang.String basename,
                                               java.util.Locale locale)
```
    Calculate all filenames for the given bundle basename and Locale. Will calculate filenames for the given Locale, the system Locale (if applicable), and the default file.
    
    Parameters:
    
    basename - the basename of the bundle
    
    locale - the locale
    
    Returns:
    
    the List of filenames to check
    
    See Also:
    
    setFallbackToSystemLocale(boolean), calculateFilenamesForLocale(java.lang.String, java.util.Locale)
  - getProperties
```
protected HotDeployResourceBundleMessageSource.PropertiesHolder getProperties(java.lang.String filename)
```
    Get a PropertiesHolder for the given filename, either from the cache or freshly loaded.
    
    Parameters:
    
    filename - the bundle filename (basename + Locale)
    
    Returns:
    
    the current PropertiesHolder for the bundle
  - refreshProperties
```
protected HotDeployResourceBundleMessageSource.PropertiesHolder refreshProperties(java.io.File filepath,
                                                                                  java.lang.String basename,
                                                                                  java.lang.String relativefile)
```
    Refresh the PropertiesHolder for the given bundle filename. The holder can be null if not cached before, or a timed-out cache entry (potentially getting re-validated against the current last-modified timestamp). relativefile = "org/frameworkset/spi/support/messages_en_US.properties"; basename = "org/frameworkset/spi/support/messages_en_US"; filepath = "d:/workspace/org/frameworkset/spi/support/messages_en_US.properties";
    
    Parameters:
    
    filepath -
    
    basename -
    
    relativefile -
    
    Returns:
  - firstLoadProperties
```
protected HotDeployResourceBundleMessageSource.PropertiesHolder firstLoadProperties(java.lang.String filename)
```
  - loadProperties
```
protected java.util.Properties loadProperties(org.frameworkset.util.io.Resource resource,
                                              java.lang.String filename)
                                       throws java.io.IOException
```
    Load the properties from the given resource.
    
    Parameters:
    
    resource - the resource to load from
    
    filename - the original bundle filename (basename + Locale)
    
    Returns:
    
    the populated Properties instance
    
    Throws:
    
    java.io.IOException - if properties loading failed
  - clearCache
```
public void clearCache()
```
    Clear the resource bundle cache. Subsequent resolve calls will lead to reloading of the properties files.
  - clearCacheIncludingAncestors
```
public void clearCacheIncludingAncestors()
```
    Clear the resource bundle caches of this MessageSource and all its ancestors.
    
    See Also:
    
    clearCache()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - calculateFilenamesForLocale
```
protected java.util.List calculateFilenamesForLocale(java.lang.String basename,
                                                     java.util.Locale locale)
```
    Calculate the filenames for the given bundle basename and Locale, appending language code, country code, and variant code. E.g.: basename "messages", Locale "de_AT_oo" -> "messages_de_AT_OO", "messages_de_AT", "messages_de".
    
    Parameters:
    
    basename - the basename of the bundle
    
    locale - the locale
    
    Returns:
    
    the List of filenames to check
  - stopmonitor
```
public static void stopmonitor()
```
  - getBundleClassLoader
```
public java.lang.ClassLoader getBundleClassLoader()
```
  - setBundleClassLoader
```
public void setBundleClassLoader(java.lang.ClassLoader bundleClassLoader)
```
  - isChangemonitor
```
public boolean isChangemonitor()
```
  - setChangemonitor
```
public void setChangemonitor(boolean changemonitor)
```
  - destroy
```
public void destroy()
```
    注销国际化资源
    
    Overrides:
    
    destroy in class AbstractMessageSource

Class HotDeployResourceBundleMessageSource

Nested Class Summary

Field Summary

Fields inherited from class org.frameworkset.spi.support.MessageSourceSupport

Constructor Summary

Method Summary

Methods inherited from class org.frameworkset.spi.support.AbstractMessageSource

Methods inherited from class org.frameworkset.spi.support.MessageSourceSupport

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

HotDeployResourceBundleMessageSource

Method Detail

setBasename

setBasenames

setDefaultEncoding

setFileEncodings

setFallbackToSystemLocale

setPropertiesPersister

setResourceLoader

resolveCodeWithoutArguments

resolveCode

getMergedProperties

calculateAllFilenames

getProperties

refreshProperties

firstLoadProperties

loadProperties

clearCache

clearCacheIncludingAncestors

toString

calculateFilenamesForLocale

stopmonitor

getBundleClassLoader

setBundleClassLoader

isChangemonitor

setChangemonitor

destroy