oracle.cabo.servlet.xml
Class UIXPageBroker

java.lang.Object
  |
  +--oracle.cabo.servlet.AbstractPageBroker
        |
        +--oracle.cabo.servlet.ui.BaseUIPageBroker
              |
              +--oracle.cabo.servlet.xml.UIXPageBroker

All Implemented Interfaces:

PageBroker

Direct Known Subclasses:

JboPageBroker

public class UIXPageBroker

extends BaseUIPageBroker

UIXPageBroker extends BaseUIPageBroker to automatically load UIX files placed in a special directory, registering event handlers and data handlers based on the <handlers> section of the UIX file.

UIXPageBroker will also automatically detect if the UIX file is updated and reload and re-bind the page without programmatic intervention.

UIXPageBroker uses the following servlet configuration parameters:

• oracle.cabo.servlet.xml.XMLProvider: The fully qualified class name of an implementation of the XMLProvider interface. This parameter is optional. If not provided, it uses the Oracle XML parser.

The following parameters are all deprecated, and will be removed in the future. UIXPageBroker also supports a number of deprecated servlet configuration parameters; all of these can be set using WEB-INF/uix-config.xml, and that is the preferred mechanism.

• oracle.cabo.servlet.xml.UIXPath: The full file system path to the directory containing UIX files. This parameter is optional. If not provided, it will look for the UIX files on the web application path (e.g., getRealPath()).
• oracle.cabo.servlet.xml.CheckModified: A boolean parameter used to enable or disable checks for modifications to UIX files while the server is running. Defaults to true.
• oracle.cabo.image.Headless: A boolean parameter which is used to disable dynamic image generation in "headless" environments. Defaults to false, unless the UIX Dynamic Images (Tecate) ServletURL parameter is set.
• oracle.cabo.image.ServletURL: An URL parameter which is used to specify the location of an ImageServlet instance which should be used for any dynamic image generation requests. If not set, generation will be performed in-process.
• oracle.cabo.ui.UIExtensions: a comma-separated list of (full) class names, each of which must implement the UIExtension interface. All of these will be instantiated and registered.
• oracle.cabo.servlet.xml.TemplateLibraries: A comma-separated list of template library files; each will be loaded and automatically registered, so that developers don't need to explicitly specify them.
• oracle.cabo.servlet.xml.DisplayParseErrors: A boolean parameter that determines how errors in parsing UIX files will be handled. If true, errors will result in a nicely formatted error page useful for development. If false, errors will be propagated through the standard UIX Controller exception handling mechanisms. This value defaults to true in UIX debug builds, and false in UIX optimized builds.

The XMLProvider can be retrieved from a BajaContext instance via getService().

Fields inherited from class oracle.cabo.servlet.AbstractPageBroker

EVENT_ERROR_KEY

Constructor Summary

UIXPageBroker()
Creates a UIX PageBroker.

Method Summary

protected ParserManager	getDefaultParserManager() Returns the ParserManager to use when parsing the requested page.
protected PageDescription	getPageDescription(BajaContext context, Page page) Called to retrive a page description.
protected PageDescriptionCache	getPageDescriptionCache(BajaContext context, Page page) Called to retrive the page description cache.
java.lang.Object	getService(BajaContext context, java.lang.Class serviceClass, java.lang.Object serviceSelector) Returns a object that provides some global service.
java.lang.String	getUIXPath() Returns the base path where UIX files will be searched for.
void	init(javax.servlet.Servlet servlet, javax.servlet.ServletConfig config) Initializes the page broker.
void	registerUIExtension(UIExtension extension) Adds a UIExtension to the system.
void	setUIXPath(java.lang.String uixPath) Sets the base path where UIX files will be searched for.

Methods inherited from class oracle.cabo.servlet.ui.BaseUIPageBroker

createDefaultConfiguration, getApplicationConfiguration, getConfiguration, getConfigurationName, getUIExtensions, getUIFactory, handleRequest, setUIFactory

Methods inherited from class oracle.cabo.servlet.AbstractPageBroker

decodeMultipartRequest, destroy, doUploadFile, getDefaultPage, getErrorPage, getErrorPage, getEventError, getEventHandler, getFileUploadManager, getPageFlowEngine, getPageRenderer, getServlet, isCacheable, isEmbedded, registerGlobalEventHandler, registerPageDescription, registerPageDescription, renderError, renderPage, requestEnded, requestStarted, resetGlobalEventHandlers, resetPageDescriptions, setDefaultPage, setEmbedded, setErrorPage, setFileUploadManager, setPageFlowEngine, setResponseHeaders, shouldHandleUploadFile, unregisterGlobalEventHandler, unregisterPageDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

UIXPageBroker

public UIXPageBroker()

Creates a UIX PageBroker.

Method Detail

getUIXPath

public java.lang.String getUIXPath()

Returns the base path where UIX files will be searched for.

setUIXPath

public void setUIXPath(java.lang.String uixPath)

Sets the base path where UIX files will be searched for. By default, UIX files will be looked for with the getRealPath() Servlet API. It will also default to the value of the oracle.cabo.servlet.xml.UIXPath servlet initialization property, if set.

init

public void init(javax.servlet.Servlet servlet,
                 javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Initializes the page broker. Subclasses must call super.init(config) if they override this method.

Overrides:

init in class BaseUIPageBroker

getService

public java.lang.Object getService(BajaContext context,
                                   java.lang.Class serviceClass,
                                   java.lang.Object serviceSelector)

Returns a object that provides some global service. The default implementation of BajaContext.getService() will call this PageBroker method for any services it doesn't serve itself. UIXPageBroker supports:

• XMLProvider: no selector object
• UIFactory: no selector object
• Configuration: selector must be a Page object
• PageDescription: selector must be a Page object

Overrides:

getService in class BaseUIPageBroker

Parameters:

context - the BajaContext

serviceClass - a class object that the returned object must be an instance of

serviceSelector - a selector object, if one is needed

registerUIExtension

public void registerUIExtension(UIExtension extension)

Adds a UIExtension to the system. All Configurations created by this PageBroker will use these extensions.

Overrides:

registerUIExtension in class BaseUIPageBroker

getDefaultParserManager

protected ParserManager getDefaultParserManager()

Returns the ParserManager to use when parsing the requested page. Clients which require custom elements in their UIX documents can override this method, but it is strongly preferred to use the UIExtension mechanism (or template libraries) to add custom elements.

Clients that need different parser managers for different parts of their application must override getPageDescriptionCache, not this method.

Returns:

the method in this class returns null

See Also:

getPageDescriptionCache(oracle.cabo.servlet.BajaContext, oracle.cabo.servlet.Page), BaseUIPageBroker.registerUIExtension(oracle.cabo.ui.UIExtension)

getPageDescriptionCache

protected PageDescriptionCache getPageDescriptionCache(BajaContext context,
                                                       Page page)

Called to retrive the page description cache. The default implementation uses a single cache for all pages.

getPageDescription

protected PageDescription getPageDescription(BajaContext context,
                                             Page page)

Called to retrive a page description.

Overrides:

getPageDescription in class AbstractPageBroker