Skip navigation links

com.stellent.cis.web.servlets
Class SCSInitializeServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
com.stellent.cis.web.servlets.SCSInitializeServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SCSInitializeServlet

extends javax.servlet.http.HttpServlet

Servlet that initializes the SCS CIS framework. Places the initialized CISApplication class as an attribute in the ServletContext under the name "CISApplication." This servlet should be set to be a LOAD_ON_STARTUP servlet.
The CISApplication instance can be accessed from any other servlet by calling ServletContext.getAttribute(String) with a value "CISApplication." The CISApplication instance can also be accessed via "application" scope from any JSP page or via JSTL with the expression ${CISApplication}.

  Available parameters (the following parameters are legacy parameters; the servlet now uses the CISApplication#initialize(java.util.Properties) method
   so all properties described in CISApplication should be used; the updated parameter names are listed next
   to the deprecated parameters):
      isClient (deprecated, use {@link CISApplication#PROPERTY_CONFIG_TYPE)) - if true initialize as client (default false)
      clientUrl (deprecated, use {@link CISApplication#PROPERTY_CONFIG_CLIENT_URL))  - URL to the CIS server, empty string to attempt JNDI/RMI initialization
      adapterConfig (deprecated, use {@link CISApplication#PROPERTY_CONFIG_SERVER_ADAPTER_CONFIG)) - the adapter configuration location (can be relative to web or full file url; if not specified, looks
                      in /WEB-INF/adapterconfig.xml and then looks in classpath for /adapterconfig.xml)
      temporaryDirectory (deprecated, use {@link CISApplication#PROPERTY_CONFIG_SERVER_TEMP_DIRECTORY)) - the temporary file directory to use (null for default)
      serverType (deprecated, use {@link CISApplication#PROPERTY_CONFIG_SERVER_TYPE)) - the server type to initialize as, null to let servlet attempt to discover type (weblogic, websphere, tomcat, sunone, standalone)

      asynchronously - only applies to client initializations, will attempt to asynchronously make the connection in a
                       seperate thread.  This is useful when connecting to the CIS EAR file which might get initialized
                       after this servlet
      retryCount - the number of ties to retry the connection; defaults to 120; there is a 1 second sleep interval before each
                   try so the retryCount is effectively the number of seconds to continue to attempt to connect to the
                   CIS server

 

See Also:

Serialized Form

Field Summary

protected org.apache.commons.logging.Log	m_log
static java.lang.String	PARAM_CIS_PROPERTIES_FILE

Constructor Summary

SCSInitializeServlet()

Method Summary

protected void	addLegacyParameters(java.util.Properties initializationProperties, javax.servlet.ServletConfig servletConfig) Add legacy parameters to the initialization properties
protected java.net.URL	getAdapterConfig(java.lang.String adapterConfig) Resolve the adapter configuration URL from the given adapter config string
protected void	getCisPropertiesFromConfig(javax.servlet.ServletConfig servletConfig, java.util.Properties propertiesMap) Load the standard CIS properties specified in the servlet configuration.
protected void	getJNDIPropertiesFromConfig(javax.servlet.ServletConfig servletConfig, java.util.Map propertiesMap, java.lang.String prefix) Load the JNDI properties specified in the servlet configuration.
void	init(javax.servlet.ServletConfig servletConfig)
protected void	initializeClientAsynchronously(java.util.Properties initializationProperties, int retryCount)
protected void	registerCISApplication(ICISApplication cisApplication) Register the CISApplication instance in the servlet config
protected java.net.URL	resolveUrl(java.lang.String url) Resolve the given string into an URL object

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_CIS_PROPERTIES_FILE

public static final java.lang.String PARAM_CIS_PROPERTIES_FILE

See Also:

Constant Field Values

m_log

protected org.apache.commons.logging.Log m_log

Constructor Detail

SCSInitializeServlet

public SCSInitializeServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

addLegacyParameters

protected void addLegacyParameters(java.util.Properties initializationProperties,
                                   javax.servlet.ServletConfig servletConfig)
                            throws java.io.IOException

Add legacy parameters to the initialization properties

Parameters:

initializationProperties -

servletConfig -

Throws:

java.io.IOException

initializeClientAsynchronously

protected void initializeClientAsynchronously(java.util.Properties initializationProperties,
                                              int retryCount)

Parameters:

initializationProperties -

retryCount -

registerCISApplication

protected void registerCISApplication(ICISApplication cisApplication)

Register the CISApplication instance in the servlet config

Parameters:

cisApplication -

getJNDIPropertiesFromConfig

protected void getJNDIPropertiesFromConfig(javax.servlet.ServletConfig servletConfig,
                                           java.util.Map propertiesMap,
                                           java.lang.String prefix)

Load the JNDI properties specified in the servlet configuration. These are all properties beginning with "jndi." Add them to the given propertiesMap with the given prefix.

Parameters:

servletConfig - the current servlet config

getCisPropertiesFromConfig

protected void getCisPropertiesFromConfig(javax.servlet.ServletConfig servletConfig,
                                          java.util.Properties propertiesMap)
                                   throws java.io.IOException

Load the standard CIS properties specified in the servlet configuration. These are all properties beginning with "cis.config." Add them to the given propertiesMap

Parameters:

servletConfig - the current servlet config

Throws:

java.io.IOException

getAdapterConfig

protected java.net.URL getAdapterConfig(java.lang.String adapterConfig)
                                 throws java.io.IOException

Resolve the adapter configuration URL from the given adapter config string

Parameters:

adapterConfig - the adapter config string specified as a servlet parameter

Returns:

the URL to the config or null if the URL cannot be resolved

Throws:

java.io.IOException

resolveUrl

protected java.net.URL resolveUrl(java.lang.String url)
                           throws java.io.IOException

Resolve the given string into an URL object

Parameters:

url - the string url

Returns:

a valid URL object

Throws:

java.io.IOException

Skip navigation links