oracle.cabo.share.config
Class ConfigurationImpl

java.lang.Object
  |
  +--oracle.cabo.share.config.Configuration
        |
        +--oracle.cabo.share.config.ConfigurationImpl

public class ConfigurationImpl

extends Configuration

ConfigurationImpl is the default implementation of Configuration. See that interface's documentation for information on the configuration architecture.

Fields inherited from class oracle.cabo.share.config.Configuration

ACCESSIBILITY_MODE, BASE_DIRECTORY, DISABLE_CONTENT_COMPRESSION, DISABLE_PARTIAL_RENDERING, HEADLESS, HELP_PROVIDER, IMAGE_SERVLET_URL, IMAGE_TYPE_MANAGER, IMAGES_CACHE_DIRECTORY, IMAGES_DIRECTORY, JSLIBS_DIRECTORY, JSPS_DIRECTORY, LOOK_AND_FEEL, LOOK_AND_FEEL_MANAGER, RENDERER_MANAGER, STYLE_SHEET_NAME, STYLES_CACHE_DIRECTORY, STYLES_DIRECTORY, TECATE_SERVLET_URL, TRANSLATION_LOCALE_MAPPER, USER_STYLE_SHEET, XML_PROVIDER

Constructor Summary

ConfigurationImpl(java.lang.String name)
Creates a default ConfigurationImpl.

ConfigurationImpl(java.lang.String name, ConfigurationImpl base)
Creates a default ConfigurationImpl.

Method Summary

java.lang.String	getPath(java.lang.Object key, java.lang.String contextPath) Return a path for a UIX directory.
java.lang.Object	getProperty(java.lang.Object key) Return a registered property.
java.lang.String	getURI(java.lang.Object key, java.lang.String contextURI) Return a URI for a UIX directory.
boolean	isDebug() Returns whether the configuration is in debug mode.
void	putFullURIAndPath(java.lang.Object key, java.lang.String uri, java.lang.String path) Register a full URI and path.
void	putProperty(java.lang.Object key, java.lang.Object value) Register a propery.
void	putRelativeURI(java.lang.Object key, java.lang.String uri) Register a context-relative URI .
void	setDebug(boolean debug) Returns whether the configuration is in debug mode.
static Configuration	sharedInstance() Deprecated. since 2.1.6, developers should use ApplicationConfiguration to retrieve the default configuration.

Methods inherited from class oracle.cabo.share.config.Configuration

getConfiguration, getConfiguration, getName, register, register, unregister, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationImpl

public ConfigurationImpl(java.lang.String name)

Creates a default ConfigurationImpl. The configuration must be registered (with register()) before being used.

ConfigurationImpl

public ConfigurationImpl(java.lang.String name,
                         ConfigurationImpl base)

Creates a default ConfigurationImpl. The configuration must be registered (with register()) before being used.

Method Detail

sharedInstance

public static Configuration sharedInstance()

Deprecated. since 2.1.6, developers should use ApplicationConfiguration to retrieve the default configuration.

Returns a default, shared Configuration object. This object should not be cast and mutated.

isDebug

public boolean isDebug()

Returns whether the configuration is in debug mode.

Overrides:

isDebug in class Configuration

setDebug

public void setDebug(boolean debug)

Returns whether the configuration is in debug mode.

getURI

public java.lang.String getURI(java.lang.Object key,
                               java.lang.String contextURI)

Return a URI for a UIX directory.

Overrides:

getURI in class Configuration

Parameters:

key - the key used to identify the directory

contextURI - the current contextURI; this will be preprended to the returned URI if this directory is registered as (or defaulting to) context-relative. This path must not be terminated with a separator ("/").

Returns:

a URI, which will always be terminated with a separator

Throws:

DirectoryUnavailableException - if the directory is unavailable

getPath

public java.lang.String getPath(java.lang.Object key,
                                java.lang.String contextPath)

Return a path for a UIX directory.

Overrides:

getPath in class Configuration

Parameters:

key - the key used to identify the directory

contextPath - the current context path; this will be preprended to the returned path if this directory is registered as (or defaulting to) context-relative.

Returns:

a full file system path, which will always be terminated with the appropriate separator for the file system

Throws:

DirectoryUnavailableException - if the directory is unavailable

getProperty

public java.lang.Object getProperty(java.lang.Object key)

Return a registered property.

Overrides:

getProperty in class Configuration

Parameters:

key - the key used to identify the property

Returns:

the registered object, or null if no object was registered.

putFullURIAndPath

public void putFullURIAndPath(java.lang.Object key,
                              java.lang.String uri,
                              java.lang.String path)

Register a full URI and path.

Parameters:

key - the key used to identify the directory

uri - the full URI pointing to the desired location

path - the full path corresponding to the given URI on the webserver.

putRelativeURI

public void putRelativeURI(java.lang.Object key,
                           java.lang.String uri)

Register a context-relative URI .

Parameters:

key - the key used to identify the directory

uri - a URI pointing to the desired location, relative to the root of a web application

putProperty

public void putProperty(java.lang.Object key,
                        java.lang.Object value)

Register a propery. DO NOT use this method to set up paths for UIX resources. Paths must be set using putRelativeURI() and putFullURIAndPath()

Parameters:

key - the key used to identify the directory

value - the registered value

See Also:

putRelativeURI(java.lang.Object, java.lang.String), putFullURIAndPath(java.lang.Object, java.lang.String, java.lang.String)