Skip navigation links

Oracle® Fusion Middleware Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)

E17273-01


oracle.stellent.wcm.server
Class ServerContext

java.lang.Object
  extended by oracle.stellent.wcm.server.ServerContext


public class ServerContext
extends java.lang.Object

Represents the main application in the OpenWCM world. Has references to all the available APIs in the system. Should be instatiated once per application and shared across threads.


Constructor Summary
ServerContext(Configuration config)
          Create an application with the given server configuration
ServerContext(Configuration config, java.io.File tempDirectory)
          Create an application with the given server configuration
ServerContext(java.net.URL configFile)
          Initialize the server application by reading the configuration file.
ServerContext(java.net.URL configFile, java.io.File tempDirectory)
          Initialize the server application by reading the configuration file.

 

Method Summary
 Configuration getConfig()
           
 ContentFactory getContentFactory()
           
 EventProcessor getEventProcessor()
           
 FSCacheMaintenance getFsCacheMaintainer()
           
 IdcClientFactory getIdcClientFactory()
           
 IdcServerPoller getIdcPoller()
           
protected  java.lang.String getProjectFileBannerState(SiteConfiguration siteConfig)
          Return state for startup banner of the project file
 ProjectManager getProjectService()
           
 Provider getProvider()
           
 RequestProcessor getRequestProcessor()
           
protected  java.io.File getTempDirectory(java.io.File rootDir)
          Retrieve a temporary directory
protected  void initialize(Configuration configuration)
          Initialize the server application with this server configuration.
protected  void outputInitBanner(ILog.Level level)
          Output the initialization banner
protected  void postInitialization()
          Called after sites have been initialized
 void shutdown()
          Called to shutdown the server application and release any resources.
protected  void validateConfiguration()
          Called prior to initialization; validate the configuration

 

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

 

Constructor Detail

ServerContext

public ServerContext(java.net.URL configFile)
Initialize the server application by reading the configuration file.
Parameters:
configFile - the url of the configuration file

ServerContext

public ServerContext(java.net.URL configFile,
                     java.io.File tempDirectory)
Initialize the server application by reading the configuration file.
Parameters:
configFile - the url of the configuration file
tempDirectory - the temporary directory to use to hold content if no staging directory is set

ServerContext

public ServerContext(Configuration config)
Create an application with the given server configuration
Parameters:
config - the system config

ServerContext

public ServerContext(Configuration config,
                     java.io.File tempDirectory)
Create an application with the given server configuration
Parameters:
config - the system config
tempDirectory - the temporary directory to use to hold content if no staging directory is set

Method Detail

getProvider

public Provider getProvider()
Returns:
the SPI Provider using the mode that is defined in the system config

getProjectService

public ProjectManager getProjectService()
Returns:
the project service

getConfig

public Configuration getConfig()
Returns:
the system configuration

getContentFactory

public ContentFactory getContentFactory()
Returns:
the object used to locate content items in the web environment

getRequestProcessor

public RequestProcessor getRequestProcessor()
Returns:
the request processor instance

getEventProcessor

public EventProcessor getEventProcessor()
Returns:
the processor for handling of server events

getIdcClientFactory

public IdcClientFactory getIdcClientFactory()
Returns:
the idc client factory

getIdcPoller

public IdcServerPoller getIdcPoller()
Returns:
the poller object used to query content server

getFsCacheMaintainer

public FSCacheMaintenance getFsCacheMaintainer()
Returns:
the poller object used to query content server

shutdown

public void shutdown()
Called to shutdown the server application and release any resources.

getTempDirectory

protected java.io.File getTempDirectory(java.io.File rootDir)
                                 throws java.io.IOException
Retrieve a temporary directory
Parameters:
rootDir - the root directory
Returns:
the temporary directory
Throws:
java.io.IOException

initialize

protected void initialize(Configuration configuration)
                   throws ServerException
Initialize the server application with this server configuration.
Parameters:
configuration - the system configuration
Throws:
ServerException

validateConfiguration

protected void validateConfiguration()
                              throws ServerException
Called prior to initialization; validate the configuration
Throws:
ServerException - the configuration is invalid

postInitialization

protected void postInitialization()
Called after sites have been initialized

getProjectFileBannerState

protected java.lang.String getProjectFileBannerState(SiteConfiguration siteConfig)
Return state for startup banner of the project file
Parameters:
siteConfig - the site config
Returns:
Empty string if all is OK, otherwise a message indicating first problem found.

outputInitBanner

protected void outputInitBanner(ILog.Level level)
Output the initialization banner
Parameters:
level - the output level for the message

Skip navigation links

Oracle® Fusion Middleware Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)

E17273-01


Copyright © 2010, Oracle and/or its affiliates. All rights reserved.