DomApplication (domui :: domui-core 1.1 API)

java.lang.Object
- to.etc.domui.server.DomApplication

public abstract class DomApplication
extends Object

Author:: Frits Jalvingh Created on May 22, 2008

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DomApplication.ExceptionEntry
An entry in the exception table.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DomApplication.ExceptionEntry` An entry in the exception table.

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger LOG

Fields
Modifier and Type	Field and Description
`static org.slf4j.Logger`	`LOG`

Constructor Summary

Constructors
Constructor and Description

DomApplication()
The only constructor.

Constructors
Constructor and Description
`DomApplication()` The only constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> void`	`addAsyncListener(IAsyncListener<T> l)` Add a new listener for asynchronous job events.
`void`	`addDefaultErrorComponent(NodeContainer page)` When a page has no error handling components (no component has registered an error listener) then errors will not be visible.
`void`	`addExceptionListener(Class<? extends Exception> xclass, IExceptionListener l)` Adds an exception handler for a given exception type.
`void`	`addHeaderContributor(HeaderContributor hc, int order)` Call from within the onHeaderContributor call on a node to register any header contributors needed by a node.
`void`	`addInterceptor(IRequestInterceptor r)`
`void`	`addLoginListener(ILoginListener l)`
`void`	`addNewPageInstantiatedListener(INewPageInstantiated l)`
`void`	`addRenderFactory(IHtmlRenderFactory f)`
`void`	`addRequestHandler(IFilterRequestHandler fh, int priority)` Add a toplevel request handler to the chain.
`void`	`addSessionListener(IAppSessionListener l)`
`void`	`addUIStateListener(IDomUIStateListener sl)` Register a listener for internal DomUI events.
`void`	`augmentThemeMap(IScriptScope ss)` This method can be overridden to add extra stuff to the theme map, after it has been loaded from properties or whatnot.
`int`	`calculatePollInterval(boolean pollCallbackRequired)`
`void`	`clearListCache(ICachedListMaker<?> maker)`
`void`	`clearListCaches()` Discard all cached stuff in the list cache.
`IResourceRef`	`createClasspathReference(String name)` Create a resource ref to a class based resource.
`<T> T`	`createInstance(Class<T> clz, Object... args)` FIXME Needs a proper, injected implementation instead of a quicky.
`AppSession`	`createSession()` Can be overridden to create your own instance of a session.
`protected void`	`destroy()` Override to destroy resources when the application terminates.
`IExceptionListener`	`findExceptionListenerFor(Exception x)` This locates the handler for the specfied exception type, if it has been registered.
`String`	`findLocalizedResourceName(String basename, String suffix, Locale loc)` This returns the name of an existing resource for the given name/suffix and locale.
`HtmlFullRenderer`	`findRendererFor(BrowserVersion bv, IBrowserOutput o)` Creates the appropriate full renderer for the specified browser version.
`IFilterRequestHandler`	`findRequestHandler(IRequestContext ctx)` Find a request handler by locating the highest-scoring request handler in the chain.
`IResourceFactory`	`findResourceFactory(String name)` Get the best factory to resolve the specified resource name.
`String`	`findRightsDescription(String right)` Translates a right name to a description from the registered bundle, if registered.
`HtmlTagRenderer`	`findTagRendererFor(BrowserVersion bv, IBrowserOutput o)`
`static DomApplication`	`get()` Returns the single DomApplication instance in use for the webapp.
`<T extends UrlPage> Class<T>`	`getAccessDeniedPageClass()` Returns the class for UrlPage that is Access Denied page handler.
`File`	`getAppFile(String path)` Return a file from the webapp's root directory.
`IResourceRef`	`getAppFileOrResource(String name)` Primitive to return either a File-based resource from the web content files or a classpath resource (below /resources/) for the same path.
`List<IAsyncListener<?>>`	`getAsyncListenerList()`
`int`	`getAutoRefreshPollInterval()` When `#isAutoRefreshPage()` is enabled (T), this defines the poll interval that a client uses to check for server-side changes.
`IBindingHandler`	`getBindingHandler(NodeBase node)`
`IBindingHandlerFactory`	`getBindingHandlerFactory()`
`<T> List<T>`	`getCachedList(IListMaker<T> maker)`
`ControlBuilder`	`getControlBuilder()` Return the component that knows everything you ever wanted to know about controls - but were afraid to ask...
`ControlCreatorRegistry`	`getControlCreatorRegistry()` DOMUI2 Experimental
`String`	`getCurrentTheme()` Gets the current theme string.
`int`	`getDefaultExpiryTime()` Returns the default browser cache resource expiry time in seconds.
`BasePageTitleBar`	`getDefaultPageTitleBar(String title)` Deprecated.
`int`	`getDefaultPollInterval()` The default poll interval time for pages containing Async objects (see `DelayedActivitiesManager`), defaulting to 2500 (2.5 seconds).
`List<HeaderContributorEntry>`	`getHeaderContributorList()`
`IPageInjector`	`getInjector()` Get the page injector.
`List<IRequestInterceptor>`	`getInterceptorList()`
`List<String>`	`getJQueryScripts()`
`String`	`getJQueryVersion()`
`int`	`getKeepAliveInterval()`
`ILoginAuthenticator`	`getLoginAuthenticator()`
`ILoginDialogFactory`	`getLoginDialogFactory()`
`List<ILoginListener>`	`getLoginListenerList()`
`List<INewPageInstantiated>`	`getNewPageInstantiatedListeners()`
`PartRequestHandler`	`getPartRequestHandler()`
`static int`	`getPlatformVarcharByteLimit()` When > 0, automatically created TextArea's will have their maxByteLength property set to this value.
`String`	`getProblemFromAddress()`
`String`	`getProblemMailAddress()`
`String`	`getProblemMailSubject()`
`List<String>`	`getRegisteredRights()` Return a list of all currently registered right names.
`Locale`	`getRequestLocale(javax.servlet.http.HttpServletRequest request)` This returns the locale to use for the request passed.
`IResourceRef`	`getResource(String name, IResourceDependencyList rdl)` Get an application resource.
`List<IResourceFactory>`	`getResourceFactories()`
`ResourceInfoCache`	`getResourceInfoCache()` Get the cache that keeps things like icon sizes for themes.
`String`	`getRightsDescription(String right)` Translates a right name to a description from the registered bundle, if registered.
`abstract Class<? extends UrlPage>`	`getRootPage()` Must return the "root" class of the application; the class rendered when the application's root URL is entered without a class name.
`String`	`getScriptVersion()`
`ITheme`	`getTheme()` Return the current theme itself.
`ITheme`	`getTheme(String themeName, IResourceDependencyList rdl)` Get the theme store representing the specified theme name.
`String`	`getThemeProperty(String name)`
`String`	`getThemeReplacedString(IResourceDependencyList rdl, String rurl)` EXPENSIVE CALL - ONLY USE TO CREATE CACHED RESOURCES This loads a theme resource as an utf-8 encoded template, then does expansion using the current theme's variable map.
`String`	`getThemeReplacedString(IResourceDependencyList rdl, String rurl, BrowserVersion bv)` EXPENSIVE CALL - ONLY USE TO CREATE CACHED RESOURCES This loads a theme resource as an utf-8 encoded template, then does expansion using the current theme's variable map.
`String`	`getUrlExtension()` Returns the defined extension for DomUI pages.
`WebActionRegistry`	`getWebActionRegistry()` Get the action registry for `NodeBase.componentHandleWebAction(RequestContextImpl, String)` requests.
`File`	`getWebAppFileRoot()` Returns the root of the webapp's installation directory on the local file system.
`int`	`getWindowSessionTimeout()` The #of minutes that a WindowSession remains valid; defaults to 15 minutes.
`String`	`handleNotLoggedInException(RequestContextImpl ci, Page page, NotLoggedInException x)` Responsible for redirecting to the appropriate login page.
`boolean`	`hasApplicationResource(String name)` Quickly determines if a given resource exists.
`boolean`	`inDevelopmentMode()` Returns T when running in development mode; this is defined as a mode where web.xml contains reloadable classes.
`protected void`	`initHeaderContributors()`
`protected void`	`initialize(ConfigParameters pp)` Override to initialize the application, called as soon as the webabb starts by the filter's initialization code.
`protected void`	`initializeWebActions()` Register all default web actions for `NodeBase.componentHandleWebAction(RequestContextImpl, String)` requests.
`void`	`internalCallConversationCreated(ConversationContext ws)`
`void`	`internalCallConversationDestroyed(ConversationContext ws)`
`void`	`internalCallPageAction(RequestContextImpl ctx, Page ws)`
`void`	`internalCallPageComplete(IRequestContext ctx, Page ws)`
`void`	`internalCallPageFullRender(RequestContextImpl ctx, Page ws)`
`void`	`internalCallWindowSessionCreated(WindowSession ws)`
`void`	`internalCallWindowSessionDestroyed(WindowSession ws)`
`ThemeManager`	`internalGetThemeManager()`
`void`	`internalInitialize(ConfigParameters pp, boolean development)`
`static int`	`internalNextPageTag()`
`boolean`	`isShowProblemTemplate()`
`boolean`	`isUiTestMode()`
`Class<? extends UrlPage>`	`loadPageClass(String name)`
`boolean`	`logOutput()`
`void`	`register(ILookupControlFactory f)` Register a new LookupControl factory.
`protected void`	`registerControlFactories()`
`void`	`registerControlFactory(PropertyControlFactory cf)` Add a new control factory to the registry.
`protected void`	`registerPartFactories()`
`void`	`registerResourceFactory(IResourceFactory f)`
`void`	`registerRight(BundleRef bundle, String... rights)` Registers a set of possible rights and their names/translation bundle.
`void`	`registerRights(BundleRef bundle, Class<?> constantsclass)` Takes a class (or interface) and scans all static public final String fields therein.
`void`	`registerUrlPart(IUrlPart factory)` Add a part that reacts on some part of the input URL instead of [classname].part, with a priority of 10.
`void`	`registerUrlPart(IUrlPart factory, int priority)` Add a part that reacts on some part of the input URL instead of [classname].part.
`<T> void`	`removeAsyncListener(IAsyncListener<T> l)`
`void`	`removeNewPageInstantiatedListener(INewPageInstantiated l)`
`void`	`removeSessionListener(IAppSessionListener l)`
`void`	`removeUIStateListener(IDomUIStateListener sl)` Remove a registered UI state listener.
`void`	`setAutoRefreshPollInterval(int autoRefreshPollInterval)`
`void`	`setBindingHandlerFactory(IBindingHandlerFactory bindingHandlerFactory)`
`void`	`setCurrentTheme(String currentTheme)` Sets the current theme string.
`void`	`setDefaultExpiryTime(int defaultExpiryTime)` Set the static resource browser cache expiry time, in seconds.
`void`	`setDefaultPollInterval(int defaultPollInterval)`
`void`	`setInjector(IPageInjector injector)`
`void`	`setKeepAliveInterval(int keepAliveInterval)` Set the keep-alive interval for DomUI screens, in milliseconds.
`void`	`setLoginAuthenticator(ILoginAuthenticator loginAuthenticator)`
`void`	`setLoginDialogFactory(ILoginDialogFactory loginDialogFactory)`
`static void`	`setPlatformVarcharByteLimit(int platformVarcharByteLimit)`
`void`	`setProblemMail(String toAddress, String fromAddress, String subject)`
`void`	`setShowProblemTemplate(boolean showProblemTemplate)`
`void`	`setThemeFactory(IThemeFactory themer)` Set the factory for handling the theme.
`void`	`setThemeProperty(String name, String value)` Set a property for all themes.
`void`	`setUiTestMode()`
`void`	`setWindowSessionTimeout(int windowSessionTimeout)` Sets the windowSession timeout, in minutes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
public static final org.slf4j.Logger LOG
```
- Constructor Detail
  - DomApplication
```
public DomApplication()
```
    The only constructor.
- Method Detail
  - getRootPage
```
@Nullable
public abstract Class<? extends UrlPage> getRootPage()
```
    Must return the "root" class of the application; the class rendered when the application's root URL is entered without a class name.
    
    Returns:
  - registerControlFactories
```
protected void registerControlFactories()
```
  - registerPartFactories
```
protected void registerPartFactories()
```
  - get
```
@Nonnull
public static DomApplication get()
```
    Returns the single DomApplication instance in use for the webapp.
    
    Returns:
  - addSessionListener
```
public void addSessionListener(IAppSessionListener l)
```
  - removeSessionListener
```
public void removeSessionListener(IAppSessionListener l)
```
  - getUrlExtension
```
@Nonnull
public String getUrlExtension()
```
    Returns the defined extension for DomUI pages. This returns the extension without the dot, i.e. "ui" for [classname].ui pages.
    
    Returns:
  - addRequestHandler
```
public void addRequestHandler(@Nonnull
                              IFilterRequestHandler fh,
                              int priority)
```
    Add a toplevel request handler to the chain.
    
    Parameters:
    
    fh -
  - findRequestHandler
```
@Nullable
public IFilterRequestHandler findRequestHandler(@Nonnull
                                                          IRequestContext ctx)
                                                   throws Exception
```
    Find a request handler by locating the highest-scoring request handler in the chain.
    
    Parameters:
    
    ctx -
    
    Returns:
    
    Throws:
    
    Exception
  - registerUrlPart
```
public void registerUrlPart(@Nonnull
                            IUrlPart factory,
                            int priority)
```
    Add a part that reacts on some part of the input URL instead of [classname].part.
    
    Parameters:
    
    factory -
    
    priority - The priority of handling. Keep it low for little-used factories.
  - registerUrlPart
```
public void registerUrlPart(@Nonnull
                            IUrlPart factory)
```
    Add a part that reacts on some part of the input URL instead of [classname].part, with a priority of 10.
    
    Parameters:
    
    factory -
  - getPartRequestHandler
```
@Nonnull
public PartRequestHandler getPartRequestHandler()
```
  - createSession
```
@Nonnull
public AppSession createSession()
```
    Can be overridden to create your own instance of a session.
    
    Returns:
  - destroy
```
protected void destroy()
```
    Override to destroy resources when the application terminates.
  - initialize
```
protected void initialize(@Nonnull
                          ConfigParameters pp)
                   throws Exception
```
    Override to initialize the application, called as soon as the webabb starts by the filter's initialization code.
    
    Parameters:
    
    pp -
    
    Throws:
    
    Exception
  - internalInitialize
```
public final void internalInitialize(@Nonnull
                                     ConfigParameters pp,
                                     boolean development)
                              throws Exception
```
    Throws:
    
    Exception
  - internalNextPageTag
```
public static final int internalNextPageTag()
```
  - loadPageClass
```
@Nonnull
public Class<? extends UrlPage> loadPageClass(@Nonnull
                                                       String name)
```
  - getScriptVersion
```
@Nonnull
public String getScriptVersion()
```
  - getJQueryScripts
```
@Nonnull
public List<String> getJQueryScripts()
```
  - getJQueryVersion
```
public String getJQueryVersion()
```
  - getWebActionRegistry
```
@Nonnull
public WebActionRegistry getWebActionRegistry()
```
    Get the action registry for NodeBase.componentHandleWebAction(RequestContextImpl, String) requests.
    
    Returns:
  - initializeWebActions
```
protected void initializeWebActions()
```
    Register all default web actions for NodeBase.componentHandleWebAction(RequestContextImpl, String) requests.
  - findRendererFor
```
public HtmlFullRenderer findRendererFor(BrowserVersion bv,
                                        IBrowserOutput o)
```
    Creates the appropriate full renderer for the specified browser version.
    
    Parameters:
    
    bv -
    
    o -
    
    Returns:
  - findTagRendererFor
```
public HtmlTagRenderer findTagRendererFor(BrowserVersion bv,
                                          IBrowserOutput o)
```
  - addRenderFactory
```
public void addRenderFactory(IHtmlRenderFactory f)
```
  - inDevelopmentMode
```
public boolean inDevelopmentMode()
```
    Returns T when running in development mode; this is defined as a mode where web.xml contains reloadable classes.
    
    Returns:
  - isUiTestMode
```
public boolean isUiTestMode()
```
  - setAutoRefreshPollInterval
```
public void setAutoRefreshPollInterval(int autoRefreshPollInterval)
```
  - getAutoRefreshPollInterval
```
public int getAutoRefreshPollInterval()
```
    When #isAutoRefreshPage() is enabled (T), this defines the poll interval that a client uses to check for server-side changes. It defaults to 2.5 seconds (in domui.js), and can be set to a faster update value to have the update check faster for development. If the interval is not set this contains 0, else it contains the refresh time in milliseconds.
    
    Returns:
  - getDefaultPollInterval
```
public int getDefaultPollInterval()
```
    The default poll interval time for pages containing Async objects (see DelayedActivitiesManager), defaulting to 2500 (2.5 seconds).
  - setDefaultPollInterval
```
public void setDefaultPollInterval(int defaultPollInterval)
```
  - calculatePollInterval
```
public int calculatePollInterval(boolean pollCallbackRequired)
```
  - getWindowSessionTimeout
```
public int getWindowSessionTimeout()
```
    The #of minutes that a WindowSession remains valid; defaults to 15 minutes.
    
    Returns:
  - setWindowSessionTimeout
```
public void setWindowSessionTimeout(int windowSessionTimeout)
```
    Sets the windowSession timeout, in minutes.
    
    Parameters:
    
    windowSessionTimeout -
  - getDefaultExpiryTime
```
public int getDefaultExpiryTime()
```
    Returns the default browser cache resource expiry time in seconds. When running in production mode all "static" resources are sent to the browser with an "Expiry" header. This causes the browser to cache the resources until the expiry time has been reached. This is important for performance.
    
    Returns:
  - setDefaultExpiryTime
```
public void setDefaultExpiryTime(int defaultExpiryTime)
```
    Set the static resource browser cache expiry time, in seconds.
    
    Parameters:
    
    defaultExpiryTime -
  - getRequestLocale
```
@Nonnull
public Locale getRequestLocale(javax.servlet.http.HttpServletRequest request)
```
    This returns the locale to use for the request passed. It defaults to the locale in the request itself, as returned by ServletRequest.getLocale(). You can override this method to define the locale by yourself.
    
    Parameters:
    
    request -
    
    Returns:
  - getProblemMailAddress
```
@Nullable
public String getProblemMailAddress()
```
  - setProblemMail
```
public void setProblemMail(@Nonnull
                           String toAddress,
                           @Nonnull
                           String fromAddress,
                           @Nonnull
                           String subject)
```
  - getProblemFromAddress
```
@Nullable
public String getProblemFromAddress()
```
  - getProblemMailSubject
```
@Nullable
public String getProblemMailSubject()
```
  - isShowProblemTemplate
```
public boolean isShowProblemTemplate()
```
  - setShowProblemTemplate
```
public void setShowProblemTemplate(boolean showProblemTemplate)
```
  - getBindingHandlerFactory
```
@Nonnull
public IBindingHandlerFactory getBindingHandlerFactory()
```
  - setBindingHandlerFactory
```
public void setBindingHandlerFactory(@Nonnull
                                     IBindingHandlerFactory bindingHandlerFactory)
```
  - getBindingHandler
```
@Nonnull
public IBindingHandler getBindingHandler(@Nonnull
                                                  NodeBase node)
```
  - initHeaderContributors
```
protected void initHeaderContributors()
```
  - addHeaderContributor
```
public final void addHeaderContributor(HeaderContributor hc,
                                       int order)
```
    Call from within the onHeaderContributor call on a node to register any header contributors needed by a node. The order value determines the order for contributors which is mostly important for Javascript ones; higher order items are written later than lower order items. All DomUI required Javascript code has orders < 0; user code should start at 0 and go up.
    
    Parameters:
    
    hc -
    
    order -
  - getHeaderContributorList
```
public List<HeaderContributorEntry> getHeaderContributorList()
```
  - addDefaultErrorComponent
```
public void addDefaultErrorComponent(NodeContainer page)
```
    When a page has no error handling components (no component has registered an error listener) then errors will not be visible. If such a page encounters an error it will call this method; the default implementation will add an ErrorPanel as the first component in the Body; this panel will then accept and render the errors.
    
    Parameters:
    
    page -
  - getDefaultPageTitleBar
```
@Deprecated
public BasePageTitleBar getDefaultPageTitleBar(String title)
```
    Deprecated.
    
    FIXME This code requires an absolute title which is not needed for the DomUI framework. It's also only needed for the "BasicPage" and has no meaning for any other part of the framework. It should move to some BasicPage factory. This returns default page title component. AppPageTitleBar is default one used by framework. To set some custom page title component override this method in your application specific class.
    
    Parameters:
    
    title -
    
    Returns:
  - getControlBuilder
```
@Nonnull
public final ControlBuilder getControlBuilder()
```
    Return the component that knows everything you ever wanted to know about controls - but were afraid to ask...
  - getControlCreatorRegistry
```
@Nonnull
public ControlCreatorRegistry getControlCreatorRegistry()
```
    DOMUI2 Experimental
    
    Returns:
  - registerControlFactory
```
public final void registerControlFactory(PropertyControlFactory cf)
```
    Add a new control factory to the registry.
    
    Parameters:
    
    cf - The new factory
  - register
```
public void register(ILookupControlFactory f)
```
    Register a new LookupControl factory.
    
    Parameters:
    
    f -
  - createInstance
```
public <T> T createInstance(Class<T> clz,
                            Object... args)
```
    FIXME Needs a proper, injected implementation instead of a quicky.
  - getAppFile
```
@Nonnull
public File getAppFile(String path)
```
    Return a file from the webapp's root directory. Example: passing WEB-INF/web.xml would return the file for the web.xml.
    
    Parameters:
    
    path -
    
    Returns:
  - getAppFileOrResource
```
@Nonnull
public IResourceRef getAppFileOrResource(String name)
```
    Primitive to return either a File-based resource from the web content files or a classpath resource (below /resources/) for the same path. The result will implement IModifyableResource. This will not use any kind of resource factory.
    
    Parameters:
    
    name -
    
    Returns:
  - registerResourceFactory
```
public void registerResourceFactory(@Nonnull
                                    IResourceFactory f)
```
  - getResourceFactories
```
@Nonnull
public List<IResourceFactory> getResourceFactories()
```
  - findResourceFactory
```
@Nullable
public IResourceFactory findResourceFactory(String name)
```
    Get the best factory to resolve the specified resource name.
    
    Parameters:
    
    name -
    
    Returns:
  - getWebAppFileRoot
```
@Nonnull
public final File getWebAppFileRoot()
```
    Returns the root of the webapp's installation directory on the local file system.
    
    Returns:
  - createClasspathReference
```
@Nonnull
public IResourceRef createClasspathReference(String name)
```
    Create a resource ref to a class based resource. If we are running in DEBUG mode this will generate something which knows the source of the resource, so it can handle changes to that source while developing.
    
    Parameters:
    
    name -
    
    Returns:
  - getResource
```
@Nonnull
public IResourceRef getResource(@Nonnull
                                         String name,
                                         @Nonnull
                                         IResourceDependencyList rdl)
                                  throws Exception
```
    Get an application resource. This usually means either a web file with the specified name or a class resource with this name below /resources/. But IResourceFactory instances registered with DomApplication can provide other means to locate resources.
    
    Parameters:
    
    name -
    
    rdl - The dependency list. Pass ResourceDependencyList.NULL if you do not need the dependencies.
    
    Returns:
    
    Throws:
    
    Exception
  - hasApplicationResource
```
public boolean hasApplicationResource(String name)
                               throws Exception
```
    Quickly determines if a given resource exists. Enter with the full resource path, like $js/xxx, THEME/xxx and the like; it mirrors the logic of getAppFileOrResource(String).
    
    Parameters:
    
    name -
    
    Returns:
    
    Throws:
    
    Exception
  - findLocalizedResourceName
```
public String findLocalizedResourceName(String basename,
                                        String suffix,
                                        Locale loc)
                                 throws Exception
```
    This returns the name of an existing resource for the given name/suffix and locale. It uses the default DomUI/webapp.core resource resolution pattern.
    
    Parameters:
    
    basename - The base name: the part before the locale info
    
    suffix - The suffix: the part after the locale info. This usually includes a ., like .js
    
    loc - The locale to get the resource for.
    
    Returns:
    
    Throws:
    
    Exception
    
    See Also:
    
    BundleRef.loadBundleList(Locale)
  - getCachedList
```
@Nonnull
public <T> List<T> getCachedList(IListMaker<T> maker)
                                   throws Exception
```
    Type Parameters:
    
    T -
    
    Parameters:
    
    key -
    
    maker -
    
    Returns:
    
    Throws:
    
    Exception
  - clearListCaches
```
public void clearListCaches()
```
    Discard all cached stuff in the list cache.
  - clearListCache
```
public void clearListCache(ICachedListMaker<?> maker)
```
  - logOutput
```
public boolean logOutput()
```
  - addInterceptor
```
public void addInterceptor(IRequestInterceptor r)
```
  - getInterceptorList
```
public List<IRequestInterceptor> getInterceptorList()
```
  - addExceptionListener
```
public void addExceptionListener(Class<? extends Exception> xclass,
                                 IExceptionListener l)
```
    Adds an exception handler for a given exception type. The handler is inserted ordered, exceptions that are a superclass of other exceptions in the list are sorted AFTER their subclass (this prevents the handler for the superclass from being called all the time). Any given exception type may occur in this list only once or an exception occurs.
    
    Parameters:
    
    l -
  - findExceptionListenerFor
```
public IExceptionListener findExceptionListenerFor(Exception x)
```
    This locates the handler for the specfied exception type, if it has been registered. It currently uses a loop to locate the appropriate handler.
    
    Parameters:
    
    x -
    
    Returns:
    
    null if the handler was not registered.
  - addNewPageInstantiatedListener
```
public void addNewPageInstantiatedListener(INewPageInstantiated l)
```
  - removeNewPageInstantiatedListener
```
public void removeNewPageInstantiatedListener(INewPageInstantiated l)
```
  - getNewPageInstantiatedListeners
```
public List<INewPageInstantiated> getNewPageInstantiatedListeners()
```
  - getLoginAuthenticator
```
public ILoginAuthenticator getLoginAuthenticator()
```
  - setLoginAuthenticator
```
public void setLoginAuthenticator(ILoginAuthenticator loginAuthenticator)
```
  - getLoginDialogFactory
```
public ILoginDialogFactory getLoginDialogFactory()
```
  - setLoginDialogFactory
```
public void setLoginDialogFactory(ILoginDialogFactory loginDialogFactory)
```
  - addLoginListener
```
public void addLoginListener(ILoginListener l)
```
  - getLoginListenerList
```
public List<ILoginListener> getLoginListenerList()
```
  - addAsyncListener
```
public <T> void addAsyncListener(@Nonnull
                                 IAsyncListener<T> l)
```
    Add a new listener for asynchronous job events.
    
    Parameters:
    
    l -
  - removeAsyncListener
```
public <T> void removeAsyncListener(@Nonnull
                                    IAsyncListener<T> l)
```
  - getAsyncListenerList
```
@Nonnull
public List<IAsyncListener<?>> getAsyncListenerList()
```
  - handleNotLoggedInException
```
public String handleNotLoggedInException(RequestContextImpl ci,
                                         Page page,
                                         NotLoggedInException x)
```
    Responsible for redirecting to the appropriate login page. This default implementation checks to see if there is an authenticator registered and uses it's result to redirect. If no authenticator is registered this returns null, asking the caller to do normal exception handling.
    
    Parameters:
    
    ci -
    
    page -
  - getInjector
```
public IPageInjector getInjector()
```
    Get the page injector.
    
    Returns:
  - setInjector
```
public void setInjector(IPageInjector injector)
```
  - registerRight
```
public void registerRight(BundleRef bundle,
                          String... rights)
```
    Registers a set of possible rights and their names/translation bundle.
    
    Parameters:
    
    bundle -
    
    rights -
  - registerRights
```
public void registerRights(BundleRef bundle,
                           Class<?> constantsclass)
```
    Takes a class (or interface) and scans all static public final String fields therein. For each field it's literal string value is used as a rights name and associated with the bundle. If a right already exists it is skipped, meaning the first ever definition of a right wins.
    
    Parameters:
    
    bundle -
    
    constantsclass -
  - getRegisteredRights
```
public List<String> getRegisteredRights()
```
    Return a list of all currently registered right names.
    
    Returns:
  - findRightsDescription
```
public String findRightsDescription(String right)
```
    Translates a right name to a description from the registered bundle, if registered.
    
    Parameters:
    
    right -
    
    Returns:
  - getRightsDescription
```
public String getRightsDescription(String right)
```
    Translates a right name to a description from the registered bundle, if registered. Returns the right name if no bundle or description is found.
    
    Parameters:
    
    right -
    
    Returns:
  - getPlatformVarcharByteLimit
```
public static int getPlatformVarcharByteLimit()
```
    When > 0, automatically created TextArea's will have their maxByteLength property set to this value. Used to work around Oracle <=11 4000 varchar2 limit.
    
    Returns:
  - setPlatformVarcharByteLimit
```
public static void setPlatformVarcharByteLimit(int platformVarcharByteLimit)
```
  - augmentThemeMap
```
@OverridingMethodsMustInvokeSuper
public void augmentThemeMap(@Nonnull
                                                              IScriptScope ss)
                                                       throws Exception
```
    This method can be overridden to add extra stuff to the theme map, after it has been loaded from properties or whatnot.
    
    Throws:
    
    Exception
  - setCurrentTheme
```
public final void setCurrentTheme(@Nonnull
                                  String currentTheme)
```
    Sets the current theme string. This will become part of all themed resource URLs and is interpreted by the theme factory to resolve resources. The string is used as a "parameter" for the theme factory which will use it to decide on the "real" theme to use.
    
    Parameters:
    
    currentTheme - The theme name, valid for the current theme engine. Cannot be null nor the empty string.
  - getCurrentTheme
```
@Nonnull
public final String getCurrentTheme()
```
    Gets the current theme string. This will become part of all themed resource URLs and is interpreted by the theme factory to resolve resources.
    
    Returns:
  - setThemeProperty
```
public final void setThemeProperty(@Nonnull
                                   String name,
                                   @Nullable
                                   String value)
```
    Set a property for all themes.
    
    Parameters:
    
    name -
    
    value -
  - getThemeProperty
```
@Nullable
public final String getThemeProperty(@Nonnull
                                               String name)
```
  - getTheme
```
@Nonnull
public final ITheme getTheme()
```
    Return the current theme itself.
    
    Returns:
  - internalGetThemeManager
```
@Nonnull
public ThemeManager internalGetThemeManager()
```
  - setThemeFactory
```
public final void setThemeFactory(@Nonnull
                                  IThemeFactory themer)
```
    Set the factory for handling the theme.
    
    Parameters:
    
    themer -
  - getTheme
```
public final ITheme getTheme(@Nonnull
                             String themeName,
                             @Nullable
                             IResourceDependencyList rdl)
                      throws Exception
```
    Get the theme store representing the specified theme name. This is the name as obtained from the resource name which is the part between $THEME/ and the actual filename.
    
    Parameters:
    
    rdl -
    
    Returns:
    
    Throws:
    
    Exception
  - getThemeReplacedString
```
public final String getThemeReplacedString(IResourceDependencyList rdl,
                                           String rurl)
                                    throws Exception
```
    EXPENSIVE CALL - ONLY USE TO CREATE CACHED RESOURCES This loads a theme resource as an utf-8 encoded template, then does expansion using the current theme's variable map. This map is either a "style.properties" file inside the theme's folder, or can be configured dynamically using a IThemeMapFactory. The result is returned as a string.
    
    Parameters:
    
    rdl -
    
    rurl -
    
    Returns:
    
    Throws:
    
    Exception
  - getThemeReplacedString
```
public final String getThemeReplacedString(IResourceDependencyList rdl,
                                           String rurl,
                                           BrowserVersion bv)
                                    throws Exception
```
    EXPENSIVE CALL - ONLY USE TO CREATE CACHED RESOURCES This loads a theme resource as an utf-8 encoded template, then does expansion using the current theme's variable map. This map is either a "style.properties" file inside the theme's folder, or can be configured dynamically using a IThemeMapFactory. The result is returned as a string.
    
    Parameters:
    
    rdl -
    
    key -
    
    Returns:
    
    Throws:
    
    Exception
  - getResourceInfoCache
```
@Nonnull
public ResourceInfoCache getResourceInfoCache()
```
    Get the cache that keeps things like icon sizes for themes.
    
    Returns:
  - getKeepAliveInterval
```
public int getKeepAliveInterval()
```
  - setKeepAliveInterval
```
public void setKeepAliveInterval(int keepAliveInterval)
```
    Set the keep-alive interval for DomUI screens, in milliseconds.
    
    Parameters:
    
    keepAliveInterval -
  - addUIStateListener
```
public void addUIStateListener(IDomUIStateListener sl)
```
    Register a listener for internal DomUI events.
    
    Parameters:
    
    sl -
  - removeUIStateListener
```
public void removeUIStateListener(IDomUIStateListener sl)
```
    Remove a registered UI state listener.
    
    Parameters:
    
    sl -
  - internalCallWindowSessionCreated
```
public final void internalCallWindowSessionCreated(WindowSession ws)
```
  - internalCallWindowSessionDestroyed
```
public final void internalCallWindowSessionDestroyed(WindowSession ws)
```
  - internalCallConversationCreated
```
public final void internalCallConversationCreated(ConversationContext ws)
```
  - internalCallConversationDestroyed
```
public final void internalCallConversationDestroyed(ConversationContext ws)
```
  - internalCallPageFullRender
```
public final void internalCallPageFullRender(RequestContextImpl ctx,
                                             Page ws)
```
  - internalCallPageAction
```
public final void internalCallPageAction(RequestContextImpl ctx,
                                         Page ws)
```
  - internalCallPageComplete
```
public final void internalCallPageComplete(IRequestContext ctx,
                                           Page ws)
```
  - setUiTestMode
```
public void setUiTestMode()
```
  - getAccessDeniedPageClass
```
@Nonnull
public <T extends UrlPage> Class<T> getAccessDeniedPageClass()
```
    Returns the class for UrlPage that is Access Denied page handler. Page itself is filled by default parameters, for specifics please look at default AccessDeniedPage.
    
    Returns:

Class DomApplication

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

Constructor Detail

DomApplication

Method Detail

getRootPage

registerControlFactories

registerPartFactories

get

addSessionListener

removeSessionListener

getUrlExtension

addRequestHandler

findRequestHandler

registerUrlPart

registerUrlPart

getPartRequestHandler

createSession

destroy

initialize

internalInitialize

internalNextPageTag

loadPageClass

getScriptVersion

getJQueryScripts

getJQueryVersion

getWebActionRegistry

initializeWebActions

findRendererFor

findTagRendererFor

addRenderFactory

inDevelopmentMode

isUiTestMode

setAutoRefreshPollInterval

getAutoRefreshPollInterval

getDefaultPollInterval

setDefaultPollInterval

calculatePollInterval

getWindowSessionTimeout

setWindowSessionTimeout

getDefaultExpiryTime

setDefaultExpiryTime

getRequestLocale

getProblemMailAddress

setProblemMail

getProblemFromAddress

getProblemMailSubject

isShowProblemTemplate

setShowProblemTemplate

getBindingHandlerFactory

setBindingHandlerFactory

getBindingHandler

initHeaderContributors

addHeaderContributor

getHeaderContributorList

addDefaultErrorComponent

getDefaultPageTitleBar

getControlBuilder

getControlCreatorRegistry

registerControlFactory

register

createInstance

getAppFile

getAppFileOrResource

registerResourceFactory

getResourceFactories

findResourceFactory

getWebAppFileRoot

createClasspathReference

getResource

hasApplicationResource

findLocalizedResourceName

getCachedList

clearListCaches