EELFResourceManager (Event and Error logging framework 0.0.1 API)

java.lang.Object
- com.att.eelf.i18n.EELFResourceManager

```
public final class EELFResourceManager
extends Object
```
The resource manager is used to retrieve and format resources from pluggable resource bundles and is capable of managing sets of bundles over multiple locales for message skeletons, message descriptions, message resolutions, and just basic resources.
Resource Bundles are pluggable definitions of any type of resource that may be needed by the application and can be externalized. In a typical GUI application, for example, resources may be things like icons, bitmaps, cursors, or other graphic character definitions. In many cases, resources are also the messages that are issued by an application.

By externalizing the resources, and then providing a mechanism to load different versions of the resources, the application can be made to support multiple different languages and formatting customs. This is the essential mechanism in java to support internationalization (i18n). The key concept in the java support is that of a resource bundle. A resource bundle is a set, or collection, of resources identified by a key, and where each bundle represents a set of the same resource keys but with values specific to a particular language or region. For example, a message with the resource key of "ERROR_123" could have an entry in a US-English bundle as well as a France-French bundle. Bundles are usually identified by both a language and region code, although that is not required. For example, a bundle specifying only the French language would be used for Canada French as well as France.

This class supports the loading of multiple types of resource bundles and the formatting of messages from those bundles. A default bundle is loaded based on the server locale for use by server-side implementation. However, for client-side implementations, this resource manager also allows the locale to be specified and a resource obtained from a locale-specific bundle. This allows the code to format messages and resources appropriate to the client, and not just the server.

This ResourceManager also allows for additional bundles to be loaded to support bundles that may be needed for specific providers or extensions that may be loaded dynamically. In these cases, these provider implementations can request that their bundles be loaded and managed as part of the overall resources. It is important to have each provider or extension identify their resources using unique keys, because the resource manager will format the first resource it finds using the specified key by scanning the bundles. If two (or more) bundles define resources with the same key, the first occurrence found will be used.

lastly, this resource manager has the ability to manage multiple different sets of resource bundles, segregated from each other to support different uses. for example, a set of bundles can be loaded for the messages, while another set can be loaded for the resolutions, and yet another set loaded for the descriptions. this support can be extended to support any number of different sets of resource bundles in the future if needed.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`asList(String... values)` This method is a helper that allows a caller to format a variable set of strings as a list of the form "[value,...,value]"
`static String`	`format(EELFResolvableErrorEnum resourceId, String... arguments)` Formats a message identified by the application msg enumeration
`static String`	`format(EELFResolvableErrorEnum resourceId, Throwable exception, String... arguments)` Formats a message identified by the application msg enumeration
`static String`	`format(Locale locale, EELFResolvableErrorEnum resourceId, String... arguments)` Formats a message identified by the application msg enumeration
`static String`	`format(Locale locale, EELFResolvableErrorEnum resourceId, Throwable exception, String... arguments)` Formats a message identified by the application msg enumeration
`static String`	`format(Throwable t)` This method formats an exception object (throwable) in a standard way and returns the result as a string.
`static String`	`format(Throwable t, String contextMsg)` This method formats an exception object (throwable) in a standard way and returns the result as a string.
`static String`	`getDescription(EELFResolvableErrorEnum resourceId)` This is a convenience method that returns the message description indicated by the specified id, or key, in the resource bundle.
`static String`	`getDescription(Locale locale, EELFResolvableErrorEnum resourceId)` Obtains the specified description from description resource bundles that are loaded based on the resource id.
`static String`	`getIdentifier(EELFResolvableErrorEnum resourceId)` This is a convenience method that returns the message error code indicated by the specified id, or key, in the resource bundle.
`static String`	`getIdentifier(Locale locale, EELFResolvableErrorEnum resourceId)` Obtains the specified description from description resource bundles that are loaded based on the resource id.
`static String`	`getMessage(EELFResolvableErrorEnum resourceId)` This is a method that returns the resource indicated by the specified id, or key, in the resource bundle.
`static String`	`getMessage(EELFResolvableErrorEnum resourceId, String... args)` This is a method that returns the resource indicated by the specified id, or key, in the resource bundle.
`static String`	`getMessage(Locale locale, String resourceId)` Returns the message resource indicated by the specified id, or key, in the first message resource bundle loaded for the locale that contains the resource.
`static String`	`getMessage(String resourceId)` This is a convenience method that returns the resource indicated by the specified id, or key, in the resource bundle.
`static String`	`getResolution(EELFResolvableErrorEnum resource)` This is a convenience method that returns the message resolution indicated by the specified id, or key, in the resource bundle.
`static String`	`getResolution(Locale locale, EELFResolvableErrorEnum resource)` Obtains the specified resolution from the resource bundles that are loaded based on the resource id.
`static void`	`loadDescriptionBundle(String baseName)` Called to request that a specified description bundle base name be added to the set of resources managed by the resource manager.
`static void`	`loadMessageBundle(String baseName)` Called to request that a specified message bundle base name be added to the set of resources managed by the resource manager.
`static void`	`loadResolutionBundle(String baseName)` Called to request that a specified resolution bundle base name be added to the set of resources managed by the resource manager.

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

- Method Detail
  - asList
```
public static String asList(String... values)
```
    This method is a helper that allows a caller to format a variable set of strings as a list of the form "[value,...,value]"
    
    Parameters:
    
    values - The variable argument list of string values to be formatted as a list
    
    Returns:
    
    The list of values
  - format
```
public static String format(Locale locale,
                            EELFResolvableErrorEnum resourceId,
                            String... arguments)
```
    Formats a message identified by the application msg enumeration
    
    Parameters:
    
    locale - The locale that we want to load the resource for
    
    resourceId - The resource to be formatted
    
    arguments - The arguments to the message
    
    Returns:
    
    The formatted message
  - format
```
public static String format(Locale locale,
                            EELFResolvableErrorEnum resourceId,
                            Throwable exception,
                            String... arguments)
```
    Formats a message identified by the application msg enumeration
    
    Parameters:
    
    locale - The locale that we want to load the resource for
    
    resourceId - The resource to be formatted
    
    exception - The exception to be formatted
    
    arguments - The arguments to the message
    
    Returns:
    
    The formatted message
  - format
```
public static String format(EELFResolvableErrorEnum resourceId,
                            String... arguments)
```
    Formats a message identified by the application msg enumeration
    
    Parameters:
    
    resourceId - The resource to be formatted
    
    arguments - The arguments to the message
    
    Returns:
    
    The formatted message
  - format
```
public static String format(EELFResolvableErrorEnum resourceId,
                            Throwable exception,
                            String... arguments)
```
    Formats a message identified by the application msg enumeration
    
    Parameters:
    
    resourceId - The resource to be formatted
    
    exception - the exception to be formatted
    
    arguments - The arguments to the message
    
    Returns:
    
    The formatted message
  - format
```
public static String format(Throwable t)
```
    This method formats an exception object (throwable) in a standard way and returns the result as a string. This enables the exception to be written to a log file easily.
    
    Parameters:
    
    t - The throwable to be formatted
    
    Returns:
    
    The formatted exception
  - format
```
public static String format(Throwable t,
                            String contextMsg)
```
    This method formats an exception object (throwable) in a standard way and returns the result as a string. This enables the exception to be written to a log file easily.
    
    Parameters:
    
    t - The throwable to be formatted
    
    contextMsg - Message to provide application context of this exception
    
    Returns:
    
    The formatted exception
  - getDescription
```
public static String getDescription(Locale locale,
                                    EELFResolvableErrorEnum resourceId)
```
    Obtains the specified description from description resource bundles that are loaded based on the resource id.
    
    Parameters:
    
    locale - The locale that we want to load the resource for
    
    resourceId - The EELFResolvableErrorEnum to be located
    
    Returns:
    
    The requested resource, or a default message indicating that the resource id could not be found, or a default error message indicating that no bundles could be loaded.
  - getDescription
```
public static String getDescription(EELFResolvableErrorEnum resourceId)
```
    This is a convenience method that returns the message description indicated by the specified id, or key, in the resource bundle.
    
    Parameters:
    
    resourceId - The EELFResolvableErrorEnum to be located
    
    Returns:
    
    The requested description, or a default message indicating that the resource id could not be found.
  - getMessage
```
public static String getMessage(Locale locale,
                                String resourceId)
```
    Returns the message resource indicated by the specified id, or key, in the first message resource bundle loaded for the locale that contains the resource. If no bundle can be found that contains the resource, a "BAD_RESOURCE" resource is returned. If no bundles can be found for the specified locale, including the default bundle, then a "NO_BUNDLE" error resource is returned.
    
    Parameters:
    
    locale - The locale that we want to load the resource for
    
    resourceId - The resource to be located
    
    Returns:
    
    The requested resource, or a default message indicating that the resource id could not be found, or a default error message indicating that no bundles could be loaded.
  - getMessage
```
public static String getMessage(String resourceId)
```
    This is a convenience method that returns the resource indicated by the specified id, or key, in the resource bundle.
    
    Parameters:
    
    resourceId - The resource to be located
    
    Returns:
    
    The requested resource, or a default message indicating that the resource id could not be found.
  - getMessage
```
public static String getMessage(EELFResolvableErrorEnum resourceId)
```
    This is a method that returns the resource indicated by the specified id, or key, in the resource bundle.
    
    Parameters:
    
    resourceId - The resource to be located
    
    Returns:
    
    The requested resource, or a default message indicating that the resource id could not be found.
  - getMessage
```
public static String getMessage(EELFResolvableErrorEnum resourceId,
                                String... args)
```
    This is a method that returns the resource indicated by the specified id, or key, in the resource bundle.
    
    Parameters:
    
    resourceId - The resource to be located
    
    Returns:
    
    The requested resource, or a default message indicating that the resource id could not be found.
  - getResolution
```
public static String getResolution(Locale locale,
                                   EELFResolvableErrorEnum resource)
```
    Obtains the specified resolution from the resource bundles that are loaded based on the resource id.
    
    Parameters:
    
    locale - The locale that we want to load the resource for
    
    resource - The resource to be located
    
    Returns:
    
    The requested resource, or a default message indicating that the resource id could not be found, or a default error message indicating that no bundles could be loaded.
  - getResolution
```
public static String getResolution(EELFResolvableErrorEnum resource)
```
    This is a convenience method that returns the message resolution indicated by the specified id, or key, in the resource bundle.
    
    Parameters:
    
    resource - The resource to be located
    
    Returns:
    
    The requested resolution, or a default message indicating that the resource id could not be found.
  - loadDescriptionBundle
```
public static void loadDescriptionBundle(String baseName)
```
    Called to request that a specified description bundle base name be added to the set of resources managed by the resource manager.
    
    Parameters:
    
    baseName - The bundle base name to be added to the set of bundle base names that are being managed.
  - loadMessageBundle
```
public static void loadMessageBundle(String baseName)
```
    Called to request that a specified message bundle base name be added to the set of resources managed by the resource manager.
    
    Parameters:
    
    baseName - The bundle base name to be added to the set of bundle base names that are being managed.
  - loadResolutionBundle
```
public static void loadResolutionBundle(String baseName)
```
    Called to request that a specified resolution bundle base name be added to the set of resources managed by the resource manager.
    
    Parameters:
    
    baseName - The bundle base name to be added to the set of bundle base names that are being managed.
  - getIdentifier
```
public static String getIdentifier(EELFResolvableErrorEnum resourceId)
```
    This is a convenience method that returns the message error code indicated by the specified id, or key, in the resource bundle.
    
    Parameters:
    
    resourceId - The EELFResolvableErrorEnum to be located
    
    Returns:
    
    The requested description, or a default message indicating that the resource id could not be found.
  - getIdentifier
```
public static String getIdentifier(Locale locale,
                                   EELFResolvableErrorEnum resourceId)
```
    Obtains the specified description from description resource bundles that are loaded based on the resource id.
    
    Parameters:
    
    locale - The locale that we want to load the resource for
    
    resourceId - The EELFResolvableErrorEnum to be located
    
    Returns:
    
    The requested resource, or a default message indicating that the resource id could not be found, or a default error message indicating that no bundles could be loaded.

Class EELFResourceManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

asList

format

format

format

format

format

format

getDescription

getDescription

getMessage

getMessage

getMessage

getMessage

getResolution

getResolution

loadDescriptionBundle

loadMessageBundle

loadResolutionBundle

getIdentifier

getIdentifier