|
Oracle® Globalization Development Kit Java API Reference 10g Release 1(10.1) B10971-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.i18n.servlet.ApplicationContext
ApplicationContext is an application context class that controles application scope operations in the framework.
An instance of this object must be created at the time of start up of the
application either in the ContextListener
object or in a custom
context listener for Java/JSP server side applications. A custom context
listener must be present to use a custom LocaleSource
object to
access either locale information in the database or the
ResourceBundle
object in the user classpath.
The following example shows how to use contextInitialized
and
contextDestroyed
methods. Note that the constructor throws
exceptions.
public void contextInitialized(ServletContextEvent event) { ... try { ServletContext context = event.getServletContext(); context.setAttribute( ApplicationContext.OBJECT_KEY, new ApplicationContext( context.getResourceAsStream(ApplicationContext.DEFAULT_GDKAPP), getClass().getClassLoader())); { catch (except) { // handle exception ... } ... } ... public void contextDestroyed(ServletContextEvent event) { event.getServletContext().removeAttribute(ApplicationContext.OBJECT_KEY); }
Field Summary | |
static String |
DEFAULT_GDKAPP
|
static String |
OBJECT_KEY
|
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 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 the string "AUTO-CHARSET". |
Class[] |
getLocaleSources()
Returns locale sources examined in this order to determine the current locale. |
Map |
getMessageBundle()
Returns the map of 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 The supported languages are determined by the supported locale. |
String[] |
getSupportedOraTerritories()
Returns supported Oracle territories The supported territories are determined by the supported locale. |
String[] |
getSupportedOraTerritories(String oraLanguage)
Returns supported Oracle territories for Oracle language The supported territories are determined by the supported locale. |
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 |
public static final String OBJECT_KEY
public static final String DEFAULT_GDKAPP
Constructor Detail |
public ApplicationContext(String pathToConfigFile) throws ClassNotFoundException, org.apache.regexp.RESyntaxException, UnsupportedEncodingException
ClassLoader
is derived from this object.
pathToConfigFile
- an absolute file path of the application
configuration file.
ClassNotFoundException
- if locale source class is not found
org.apache.regexp.RESyntaxException
- if rewriting rule or locale to charset mapping
regular expression is invalid
UnsupportedEncodingException
- if character set is invalidpublic ApplicationContext(InputStream pathToConfigFile) throws ClassNotFoundException, org.apache.regexp.RESyntaxException, UnsupportedEncodingException
ClassLoader
is derived from this object.
pathToConfigFile
- an input stream object that references
the application configuration file.
ClassNotFoundException
- if locale source class is not found
org.apache.regexp.RESyntaxException
- if rewriting rule or locale to charset mapping
regular expression is invalid
UnsupportedEncodingException
- if character set is invalidpublic ApplicationContext(String pathToConfigFile, ClassLoader cloader) throws ClassNotFoundException, org.apache.regexp.RESyntaxException, UnsupportedEncodingException
ClassLoader
object. The class loader is required if you use
a custom LocaleSource
and specify it in the application
configuration file.
pathToConfigFile
- an absolute file path of the application
configuration file.cloader
- a class loader class used
ClassNotFoundException
- if locale source class is not found
org.apache.regexp.RESyntaxException
- if rewriting rule or locale to charset mapping
regular expression is invalid
UnsupportedEncodingException
- if character set is invalidpublic ApplicationContext(InputStream pathToConfigFile, ClassLoader cloader) throws ClassNotFoundException, org.apache.regexp.RESyntaxException, UnsupportedEncodingException
ClassLoader
object. The class loader is required if you use
a custom LocaleSource
and specify it in the application
configuration file.
pathToConfigFile
- an input stream object that references
the application configuration file.cloader
- a class loader class used
ClassNotFoundException
- if locale source class is not found
org.apache.regexp.RESyntaxException
- if rewriting rule or locale to charset mapping
regular expression is invalid
UnsupportedEncodingException
- if character set is invalidMethod Detail |
public String getIANAPageCharacterSet()
To retrieve the actual name of character set, use Localizer.getIANACharacterSet()
AUTO-CHARSET
public String getParameterName(LocaleSource.Parameter parameter)
String
representing the parameter name used to
specify locale attributes. For example, if you want to get the locale
value, use LocaleSource.LOCALE as an input:
ApplicationContext appctx = ServletHelper.getApplicationContextInstance( request); String plocale = request.getParameter( appctx.getParameterName(LocaleSource.LOCALE));
parameter
- a parameter type.
public Class[] getLocaleSources()
public oracle.i18n.servlet.localesource.LocaleSource getApplicationDefaultLocaleSource()
LocaleSource
representing the application default
locale.public Map getMessageBundle()
public Locale[] getSupportedLocales()
The supported locale can be specified in the application configration file.
Locale
representing supported locales in
the application.public String[] getSupportedOraLanguages(String oraTerritory)
The supported languages are determined by the supported locale.
oraTerritory
- Oracle territory name
String
representing the supported
languages in the application.public String[] getSupportedOraLanguages()
The supported languages are determined by the supported locale.
String
representing the supported
languages in the application.public String[] getSupportedOraTerritories(String oraLanguage)
The supported territories are determined by the supported locale.
oraLanguage
- Oracle language name
String
representing the supported
territories in the application.public String[] getSupportedOraTerritories()
The supported territories are determined by the supported locale. Sorting order is in English.
String
representing the supported
territories in the application.public String[] getSupportedIANACharacterSets()
public Locale fallbackLocale(Locale locale)
If you are not sure that the given locale is supported, call this method.
Note that supported locales in the application are not equivalent to the
translation locales that are handled by ResourceBundle
or
ServletHelper.rewriteURL(String, HttpServletRequest)
. 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 traslation.
locale
- a Locale
object to be examined.
Locale
that is supported by the applicationpublic int hashCode()
hashCode
in class Object
|
Oracle® Globalization Development Kit Java API Reference 10g Release 1(10.1) B10971-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |