org.openmrs.web.filter.util

Class CustomResourceLoader

java.lang.Object

org.openmrs.web.filter.util.CustomResourceLoader

public class CustomResourceLoader
extends java.lang.Object

This class is responsible for loading messages resources from file system

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX
static java.lang.String	SUFFIX

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.util.Locale>	getAvailablelocales()
protected java.util.ResourceBundle	getFileSystemResource(java.lang.String path, java.lang.String basename, java.util.Locale locale) This method is intended to load resource bundle from the file system by specified messages properties file path and for specified locale
static CustomResourceLoader	getInstance(javax.servlet.http.HttpServletRequest httpRequest) Returns singleton instance of custom resource loader
java.util.Map<java.util.Locale,java.util.ResourceBundle>	getResource()
java.util.ResourceBundle	getResourceBundle(java.util.Locale locale)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

SUFFIX

public static final java.lang.String SUFFIX

See Also:

Constant Field Values

Method Detail

getInstance

public static CustomResourceLoader getInstance(javax.servlet.http.HttpServletRequest httpRequest)

Returns singleton instance of custom resource loader

Parameters:

basedir - (optional) the absolute path to directory, that contains resources to be loaded. If this isn't specified then ${CONTEXT-ROOT}/WEB-INF/ will be used

Returns:

the singleton instance of CustomResourceLoader

getFileSystemResource

protected java.util.ResourceBundle getFileSystemResource(java.lang.String path,
                                                         java.lang.String basename,
                                                         java.util.Locale locale)

This method is intended to load resource bundle from the file system by specified messages properties file path and for specified locale

Parameters:

path - location of the resource on the file system

basename - the name prefix for resource file

locale - the location parameter

Returns:

resource bundle object if success, otherwise null. Error message is passed out through errorMsg property

getResourceBundle

public java.util.ResourceBundle getResourceBundle(java.util.Locale locale)

Parameters:

locale - the locale for which will be retrieved resource bundle

Returns:

resource bundle for specified locale

getResource

public java.util.Map<java.util.Locale,java.util.ResourceBundle> getResource()

Returns:

the map object, which contains locale as key and resources bundle for each locale as value

getAvailablelocales

public java.util.Set<java.util.Locale> getAvailablelocales()

Returns:

the set of locales which are currently supported by OpenMRS