Skip navigation links

oracle.stellent.wcm.client
Class ClientApplication

java.lang.Object
oracle.stellent.wcm.client.ClientApplication

Direct Known Subclasses:

ScriptableClientApplication, WCMServletApplication

public abstract class ClientApplication

extends java.lang.Object

Represents an instance of the WCM framework object used to provide access to the WCM server APIs in a J2ee Application.

Nested Class Summary

static interface

ClientApplication.ConfigurationLoader Abstraction for loading the configuration

Field Summary

static java.lang.String	CONTEXT_BEAN
static java.lang.String	WCM_IDENTITY

Constructor Summary

ClientApplication()

Method Summary

protected abstract ClientApplication.ConfigurationLoader	createConfigLoader() Create the configuration file loader object
protected ServerContext	createServerContext() Create the server context
SiteContext	createSiteContext(RequestContext request) Create the SiteContext for this request
SiteContext	createSiteContext(RequestContext request, boolean initPathFromRequest) Create the SiteContext for this request
protected SitePathBuilder	createSitePathBuilder()
ClientApplication.ConfigurationLoader	getConfigLoader()
FilterManager	getFilterManager()
InvokerFactory	getInvokerFactory()
RequestProcessor	getServer()
ServerContext	getServerContext()
SitePathBuilder	getSitePathBuilder()
SimplePatternMatcher	getSitePathMatcher()
SystemConfiguration	getSystemConfig()
protected java.io.File	getTempDirectory() Returns System.getProperty ("java.io.tmpdir") by default.
TemplatePathResolver	getTemplatePathResolver() Object used to resolve a template path
protected void	initialize() Initialize the system
protected void	initSiteContext(RequestContext request, SiteContext siteContext, boolean initPathFromRequest) Initialize the SiteContext object
void	setFilterManager(FilterManager filterManager) Set a filter manager to handle routing filter
void	setInvokerFactory(InvokerFactory invokerFactory) Set the invoker factory
void	setSitePathBuilder(SitePathBuilder pathBuilder) Set the pattern builder for creating site paths
void	setSitePathMatcher(SimplePatternMatcher pathMatcher) Set the matcher object used to map site path to site ID
void	setTemplatePathResolver(TemplatePathResolver pathResolver) Set the template path resolver

Methods inherited from class java.lang.Object

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

Field Detail

WCM_IDENTITY

public static final java.lang.String WCM_IDENTITY

See Also:

Constant Field Values

CONTEXT_BEAN

public static final java.lang.String CONTEXT_BEAN

See Also:

Constant Field Values

Constructor Detail

ClientApplication

public ClientApplication()

Method Detail

getServerContext

public ServerContext getServerContext()

Returns:

the OpenWCM server context

getServer

public RequestProcessor getServer()

Returns:

the WCM server

getSystemConfig

public SystemConfiguration getSystemConfig()

Returns:

the WCM system configuration

getSitePathMatcher

public SimplePatternMatcher getSitePathMatcher()

Returns:

the pattern matcher used to match site urls to site IDs

setSitePathMatcher

public void setSitePathMatcher(SimplePatternMatcher pathMatcher)

Set the matcher object used to map site path to site ID

Parameters:

pathMatcher - the matcher object

getSitePathBuilder

public SitePathBuilder getSitePathBuilder()

Returns:

the object used to build site patterns

setSitePathBuilder

public void setSitePathBuilder(SitePathBuilder pathBuilder)

Set the pattern builder for creating site paths

Parameters:

pathBuilder - the path builder

getTemplatePathResolver

public TemplatePathResolver getTemplatePathResolver()

Object used to resolve a template path

Returns:

the template path resolver

setTemplatePathResolver

public void setTemplatePathResolver(TemplatePathResolver pathResolver)

Set the template path resolver

Parameters:

pathResolver - the template path resolver

getInvokerFactory

public InvokerFactory getInvokerFactory()

Returns:

the factory used for creating request invokers

setInvokerFactory

public void setInvokerFactory(InvokerFactory invokerFactory)

Set the invoker factory

Parameters:

invokerFactory - the invoker factory

getFilterManager

public FilterManager getFilterManager()

Returns:

the filter manager

setFilterManager

public void setFilterManager(FilterManager filterManager)

Set a filter manager to handle routing filter

Parameters:

filterManager - the filter manager

createSiteContext

public SiteContext createSiteContext(RequestContext request)

Create the SiteContext for this request

Parameters:

request - the request

Returns:

the site context

createSiteContext

public SiteContext createSiteContext(RequestContext request,
                                     boolean initPathFromRequest)

Create the SiteContext for this request

Parameters:

request - the request

initPathFromRequest - true to initialize the path from the current request

Returns:

the site context

getConfigLoader

public ClientApplication.ConfigurationLoader getConfigLoader()

Returns:

the configuration loader

createConfigLoader

protected abstract ClientApplication.ConfigurationLoader createConfigLoader()

Create the configuration file loader object

Returns:

the config loader

getTempDirectory

protected java.io.File getTempDirectory()

Returns System.getProperty ("java.io.tmpdir") by default.

Returns:

the temporary file directory for the server context

initialize

protected void initialize()
                   throws ApplicationException

Initialize the system

Throws:

ApplicationException

createServerContext

protected ServerContext createServerContext()
                                     throws ApplicationException

Create the server context

Returns:

the initialized server context

Throws:

ApplicationException

createSitePathBuilder

protected SitePathBuilder createSitePathBuilder()

Returns:

a new instance of the SitePatternBuilder

initSiteContext

protected void initSiteContext(RequestContext request,
                               SiteContext siteContext,
                               boolean initPathFromRequest)

Initialize the SiteContext object

Parameters:

request - the request

siteContext - the site context

initPathFromRequest - true to initialize the path from the request

Skip navigation links