oracle.cabo.share.config
Class ApplicationConfiguration

java.lang.Object
  |
  +--oracle.cabo.share.config.ApplicationConfiguration

public class ApplicationConfiguration

extends java.lang.Object

An ApplicationConfiguration object represents configuration information at the web application level. Instances of this class can only be created by UIX itself based on a WEB-INF/uix-config.xml file, and must be retrieved with the getInstance() method.

Each WEB-INF/uix-config.xml file defines:

• A default configuration, retrieved with getDefault()
• A set of configurations, each retrievable with getConfiguration(ServletContext, String) and all automatically registered.
• A set of global properties, retrieved with getProperty()

Field Summary

static java.lang.Object	CHECK_IMAGES_MODIFIED Key that reports whether image file modification dates should be checked or ignored.
static java.lang.Object	CHECK_MODIFIED Key that reports whether file modification dates should be checked or ignored.
static java.lang.Object	CHECK_STYLES_MODIFIED Key that reports whether style file modification dates should be checked or ignored.
static java.lang.Object	DEBUG_ANNOTATE_PARSED_XML Key that reports whether the parsing results of uiXML files should be annotated with line and column numbers, providing for improved error reporting at runtime.
static java.lang.Object	DEBUG_FLUSH_ON_END_ELEMENT Key that reports whether output should automatically be flushed every time an element ends.
static java.lang.Object	DEBUG_INDENT_OUTPUT Key that reports whether output should be pretty-printed.
static java.lang.Object	DEBUG_LOG_REQUEST_PARAMETERS Key that reports whether the parameters for each request should be logged.
static java.lang.Object	DEBUG_LOG_REQUEST_TIMING Key that reports whether timing information for each request should be logged.
static java.lang.Object	DEBUG_LOG_TO_CONSOLE Key that reports whether logged information should be sent to the console as well as the standard servlet log.
static java.lang.Object	DEBUG_PARTIAL_RESPONSES Key that reports whether the contents that are generated for each partial page response should be displayed for debugging purposes.
static java.lang.Object	DEFAULT_EXPRESSION_LANGUAGE Key that controls the type of databinding language to use.
static java.lang.Object	DISABLE_INSTALLABLES_VERSIONING Key that controls whether or not installable file versioning is enabled.
static java.lang.Object	DISABLE_NO_CACHE_HEADERS Key that reports whether the UIX Servlet will attempt to generate HTTP headers that disable caching.
static java.lang.Object	DISABLE_UIX_COOKIE Key that controls whether or not UIX will create a cookie on behalf of a developer.
static java.lang.Object	DISPLAY_PARSE_ERRORS Key that reports whether parsing errors should be displayed directly in a page, or just sent to the error log.
static java.lang.Object	LENIENT_DATE_FORMATS Key that reports whether date formatting should be lenient.
static java.lang.Object	LOOK_AND_FEELS Specifies the set of LookAndFeelProvider instances for custom LookAndFeels to be registered with the LookAndFeelManager.
static java.lang.Object	UI_EXTENSIONS Key that identifies an array of UIExtension objects.
static java.lang.Object	UIX_PARSE_FACTORY_CLASS Class for the UIXParseFactory.
static java.lang.Object	UIX_PATH Key that identifies the path to search for uiXML files.
static java.lang.Object	UIX_REQUEST_LISTENERS Key that identifies an array of UIXRequestListener objects.

Method Summary

ConfigurationImpl	createConfiguration(java.lang.String name) Returns a new Configuration based on the default configuration for this ApplicationConfiguration.
Configuration	getConfiguration(java.lang.String name) Returns a named configuration stored on this ApplicationConfiguration.
Configuration	getDefault() Returns the default configuration for this ApplicationConfiguration.
static ApplicationConfiguration	getInstance(javax.servlet.ServletContext context) Returns an instance of an ApplicationConfiguration.
java.lang.Object	getProperty(java.lang.Object key) Returns a global property.
boolean	isDebug() Returns whether the application configuration is in debug mode.

Methods inherited from class java.lang.Object

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

Field Detail

CHECK_IMAGES_MODIFIED

public static final java.lang.Object CHECK_IMAGES_MODIFIED

Key that reports whether image file modification dates should be checked or ignored. Also used to decide whether to check that files in the image cache still exist.

CHECK_STYLES_MODIFIED

public static final java.lang.Object CHECK_STYLES_MODIFIED

Key that reports whether style file modification dates should be checked or ignored. Also used to decide whether to check that files in the style cache still exist.

CHECK_MODIFIED

public static final java.lang.Object CHECK_MODIFIED

Key that reports whether file modification dates should be checked or ignored. This property is currently used only for uiXML files.

DISPLAY_PARSE_ERRORS

public static final java.lang.Object DISPLAY_PARSE_ERRORS

Key that reports whether parsing errors should be displayed directly in a page, or just sent to the error log. This property is currently used only for uiXML files.

LENIENT_DATE_FORMATS

public static final java.lang.Object LENIENT_DATE_FORMATS

Key that reports whether date formatting should be lenient. This can also be directly set using MutableDateFormatContext.setLenient(boolean). When leniency is activated, date fields will allow some formats that do not exactly match the requested server-side format (but have an unambiguous interpretation). While client-side code will attempt to fix up fields, server-side code should never rely on this, and must accept the same set of formats. Consequently, this feature defaults off at this time. (Note that this definition of leniency does not match the java.text.DateFormat definition, which allows out-of-range days of the month.)

See Also:

MutableDateFormatContext.isLenient(), DateFormatContext.isLenient()

DEBUG_FLUSH_ON_END_ELEMENT

public static final java.lang.Object DEBUG_FLUSH_ON_END_ELEMENT

Key that reports whether output should automatically be flushed every time an element ends. This can make debugging easier, as exceptions can be more obviously associated with the location of the problem, but slows performance.

DEBUG_INDENT_OUTPUT

public static final java.lang.Object DEBUG_INDENT_OUTPUT

Key that reports whether output should be pretty-printed. This is only used in debug mode, when it defaults to true.

DEBUG_LOG_TO_CONSOLE

public static final java.lang.Object DEBUG_LOG_TO_CONSOLE

Key that reports whether logged information should be sent to the console as well as the standard servlet log. This is only used in debug mode, when it defaults to true.

DEBUG_LOG_REQUEST_TIMING

public static final java.lang.Object DEBUG_LOG_REQUEST_TIMING

Key that reports whether timing information for each request should be logged. This is only used in debug mode, when it defaults to false.

DEBUG_LOG_REQUEST_PARAMETERS

public static final java.lang.Object DEBUG_LOG_REQUEST_PARAMETERS

Key that reports whether the parameters for each request should be logged. This is only used in debug mode, when it defaults to true.

DEBUG_ANNOTATE_PARSED_XML

public static final java.lang.Object DEBUG_ANNOTATE_PARSED_XML

Key that reports whether the parsing results of uiXML files should be annotated with line and column numbers, providing for improved error reporting at runtime. This is only used in debug mode, when it defaults to true.

DEBUG_PARTIAL_RESPONSES

public static final java.lang.Object DEBUG_PARTIAL_RESPONSES

Key that reports whether the contents that are generated for each partial page response should be displayed for debugging purposes. When set to true, the iframe which is used to send partial page requests is displayed at the top of the page. The default value is false, in which case the iframe is not visible. The DEBUG_PARTIAL_RESPONSES property is only honored in debug mode.

UI_EXTENSIONS

public static final java.lang.Object UI_EXTENSIONS

Key that identifies an array of UIExtension objects.

UIX_PATH

public static final java.lang.Object UIX_PATH

Key that identifies the path to search for uiXML files.

DISABLE_INSTALLABLES_VERSIONING

public static final java.lang.Object DISABLE_INSTALLABLES_VERSIONING

Key that controls whether or not installable file versioning is enabled.

DISABLE_UIX_COOKIE

public static final java.lang.Object DISABLE_UIX_COOKIE

Key that controls whether or not UIX will create a cookie on behalf of a developer.

DEFAULT_EXPRESSION_LANGUAGE

public static final java.lang.Object DEFAULT_EXPRESSION_LANGUAGE

Key that controls the type of databinding language to use. Eg: "el" for EL binding, and "data" for traditional databinding syntax.

UIX_PARSE_FACTORY_CLASS

public static final java.lang.Object UIX_PARSE_FACTORY_CLASS

Class for the UIXParseFactory.

LOOK_AND_FEELS

public static final java.lang.Object LOOK_AND_FEELS

Specifies the set of LookAndFeelProvider instances for custom LookAndFeels to be registered with the LookAndFeelManager. The type of this property is LookAndFeelProvider[].

UIX_REQUEST_LISTENERS

public static final java.lang.Object UIX_REQUEST_LISTENERS

Key that identifies an array of UIXRequestListener objects.

DISABLE_NO_CACHE_HEADERS

public static final java.lang.Object DISABLE_NO_CACHE_HEADERS

Key that reports whether the UIX Servlet will attempt to generate HTTP headers that disable caching. When set to false (the default), page requests that include events or generated errors will not be cached. When set to true, clients must override AbstractPageBroker.isCacheable() if caching needs to be disabled for a page.

See Also:

AbstractPageBroker.isCacheable(oracle.cabo.servlet.BajaContext, oracle.cabo.servlet.Page, java.lang.Throwable, oracle.cabo.servlet.event.PageEvent)

Method Detail

getInstance

public static ApplicationConfiguration getInstance(javax.servlet.ServletContext context)

Returns an instance of an ApplicationConfiguration.

Parameters:

context - the current ServletContext

isDebug

public boolean isDebug()

Returns whether the application configuration is in debug mode.

getDefault

public Configuration getDefault()

Returns the default configuration for this ApplicationConfiguration.

getConfiguration

public Configuration getConfiguration(java.lang.String name)

Returns a named configuration stored on this ApplicationConfiguration.

createConfiguration

public ConfigurationImpl createConfiguration(java.lang.String name)

Returns a new Configuration based on the default configuration for this ApplicationConfiguration.

Parameters:

name - the name of this configuration.

getProperty

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

Returns a global property.