oracle.i18n.servlet
Class ApplicationContext

java.lang.Object
  |
  +--oracle.i18n.servlet.ApplicationContext

public class ApplicationContext

extends Object

The ApplicationContext class is an application context class that controls application scope operations in the framework.

An instance of this object must be created at the startup time of the application either by the ContextListener object or in a custom context listener for Java/JSP server applications and be registered in the servlet context with the key ApplicationContext.OBJECT.

Since:

10.1.0.2

Field Summary

static String	DEFAULT_GDKAPP Default GDK application configuration file name.
static String	OBJECT_KEY Constant for key used to retrieve this object.

Constructor Summary

ApplicationContext(InputStream pathToConfigFile)
Constructs this object based on the application configuration file.

ApplicationContext(InputStream pathToConfigFile, ClassLoader cloader)
Constructs this object based on the application configuration file and the ClassLoader object.

ApplicationContext(String pathToConfigFile)
Constructs this object based on the application configuration file.

ApplicationContext(String pathToConfigFile, ClassLoader cloader)
Constructs this object based on the application configuration file and the ClassLoader object.

Method Summary

Locale	fallbackLocale(Locale locale) Validates if the locale supplied as an argument is supported.
oracle.i18n.servlet.localesource.LocaleSource	getApplicationDefaultLocaleSource() Returns the application default locale source instance.
String	getIANAPageCharacterSet() Returns the default IANA page character set name of the application or returns the string AUTO-CHARSET.
Class[]	getLocaleSources() Returns locale sources examined in this order to determine the current locale.
Map	getMessageBundle() Returns the map of the message bundle object.
String	getParameterName(LocaleSource.Parameter parameter) Returns a String representing the parameter name used to specify locale attributes.
String[]	getSupportedIANACharacterSets() Returns supported IANA character sets.
Locale[]	getSupportedLocales() Returns locales supported in the application.
String[]	getSupportedOraLanguages() Returns supported Oracle languages.
String[]	getSupportedOraLanguages(String oraTerritory) Returns supported Oracle languages for the Oracle territory.
String[]	getSupportedOraTerritories() Returns supported Oracle territories.
String[]	getSupportedOraTerritories(String oraLanguage) Returns supported Oracle territories for the Oracle language.
int	hashCode() Returns the hash value.

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_KEY

public static final String OBJECT_KEY

Constant for key used to retrieve this object. This is used as a key for the ApplicationContext object in the ServletContext object.

See Also:

Constant Field Values

DEFAULT_GDKAPP

public static final String DEFAULT_GDKAPP

Default GDK application configuration file name. This is used to specify the name of GDK configuration file.

See Also:

Constant Field Values

Constructor Detail

ApplicationContext

public ApplicationContext(String pathToConfigFile)
                   throws ClassNotFoundException,
                          RESyntaxException,
                          UnsupportedEncodingException

Constructs this object based on the application configuration file. The ClassLoader object is derived from this object.

Note: Do not use this method for JSP/Java Servlet application.

Parameters:

pathToConfigFile - an absolute file path of the application configuration file

Throws:

ClassNotFoundException - if locale source class is not found

RESyntaxException - if rewriting rule or locale to charset mapping regular expression is invalid

UnsupportedEncodingException - if character set is invalid

ApplicationContext

public ApplicationContext(InputStream pathToConfigFile)
                   throws ClassNotFoundException,
                          RESyntaxException,
                          UnsupportedEncodingException

Constructs this object based on the application configuration file. The ClassLoader object is derived from this object.

Parameters:

pathToConfigFile - an input stream object that references the application configuration file

Throws:

ClassNotFoundException - if locale source class is not found

RESyntaxException - if rewriting rule or locale to charset mapping regular expression is invalid

UnsupportedEncodingException - if character set is invalid

ApplicationContext

public ApplicationContext(String pathToConfigFile,
                          ClassLoader cloader)
                   throws ClassNotFoundException,
                          RESyntaxException,
                          UnsupportedEncodingException

Constructs this object based on the application configuration file and the ClassLoader object. The class loader may be required when a custom LocaleSource object is used in the application configuration file.

Note: Do not use this method for JSP/Java Servlet application.

Parameters:

pathToConfigFile - an absolute file path of the application configuration file

cloader - a class loader class used

Throws:

ClassNotFoundException - if locale source class is not found

RESyntaxException - if rewriting rule or locale to charset mapping regular expression is invalid

UnsupportedEncodingException - if character set is invalid

ApplicationContext

public ApplicationContext(InputStream pathToConfigFile,
                          ClassLoader cloader)
                   throws ClassNotFoundException,
                          RESyntaxException,
                          UnsupportedEncodingException

Constructs this object based on the application configuration file and the ClassLoader object. The class loader is required if you use a custom LocaleSource object and specify it in the application configuration file.

Parameters:

pathToConfigFile - an input stream object that references the application configuration file

cloader - a class loader class used

Throws:

ClassNotFoundException - if locale source class is not found

RESyntaxException - if rewriting rule or locale to charset mapping regular expression is invalid

UnsupportedEncodingException - if character set is invalid

Method Detail

getIANAPageCharacterSet

public String getIANAPageCharacterSet()

Returns the default IANA page character set name of the application or returns the string AUTO-CHARSET.

For AUTO-CHARSET, retrieve the actual name of character set using the Localizer.getIANACharacterSet() method.

Returns:

an IANA character set name or AUTO-CHARSET

getParameterName

public String getParameterName(LocaleSource.Parameter parameter)

Returns a String representing the parameter name used to specify locale attributes. For example, if you want to get the locale value, use the LocaleSource.LOCALE object as input. For example:

 ApplicationContext appctx = ServletHelper.getApplicationContextInstance(
   request);
 String plocale = request.getParameter(
   appctx.getParameterName(LocaleSource.LOCALE));
 

Parameters:

parameter - a parameter type

Returns:

a parameter name used in the application

getLocaleSources

public Class[] getLocaleSources()

Returns locale sources examined in this order to determine the current locale.

Returns:

an array of LocaleSource classes

getApplicationDefaultLocaleSource

public oracle.i18n.servlet.localesource.LocaleSource getApplicationDefaultLocaleSource()

Returns the application default locale source instance.

Returns:

a LocaleSource representing the application default locale

getMessageBundle

public Map getMessageBundle()

Returns the map of the message bundle object.

Returns:

the map of the message bundle object where the key is String and the value is the ResourceBundle object

getSupportedLocales

public Locale[] getSupportedLocales()

Returns locales supported in the application.

The supported locale can be specified in the application configration file.

Returns:

an array of Locale representing supported locales in the application

getSupportedOraLanguages

public String[] getSupportedOraLanguages(String oraTerritory)

Returns supported Oracle languages for the Oracle territory.

The supported languages are determined by the supported locale. If the given territory name is null, all supported Oracle languages are returned.

Parameters:

oraTerritory - Oracle territory name

Returns:

an array of String representing the supported languages in the application

getSupportedOraLanguages

public String[] getSupportedOraLanguages()

Returns supported Oracle languages.

The supported languages are determined by the supported locale.

Returns:

an array of String representing the supported languages in the application

getSupportedOraTerritories

public String[] getSupportedOraTerritories(String oraLanguage)

Returns supported Oracle territories for the Oracle language.

The supported territories are determined by the supported locale. If the given language is null, all available territories are returned.

Parameters:

oraLanguage - Oracle language name

Returns:

an array of String representing the supported territories in the application

getSupportedOraTerritories

public String[] getSupportedOraTerritories()

Returns supported Oracle territories.

The supported territories are determined by the supported locale.

Returns:

an array of String representing the supported territories in the application

getSupportedIANACharacterSets

public String[] getSupportedIANACharacterSets()

Returns supported IANA character sets.

Returns:

an array of supported IANA character sets in the application

fallbackLocale

public Locale fallbackLocale(Locale locale)

Validates if the locale supplied as an argument is supported. If the locale is supported, it is returned by the method. Otherwise, the fallback locale is returned.

If you are not sure that the given locale is supported, call this method the custom locale source object.

Note that supported locales in the application are not equivalent to the translation locales that are handled by the ResourceBundle class or the ServletHelper.rewriteURL(String, HttpServletRequest) method. They validate locales by checking the actual translation resources. If the given locale's translation exists, it is returned, otherwise, it returns the fallback locale's translation.

Parameters:

locale - a Locale object to be examined

Returns:

a Locale that is supported by the application

hashCode

public int hashCode()

Returns the hash value.

Overrides:

hashCode in class Object

Returns:

hash value