atg.servlet
Class ContextRootSwappingService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.servlet.ContextRootSwappingService

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Direct Known Subclasses:

VirtualContextRootService

public abstract class ContextRootSwappingService
extends GenericService

This class serves as a common base class for WebAppLayeringService and VirtualContextRootService.

Nested Class Summary

class

ContextRootSwappingService.ServletContextInfo this class stores information about a context swapping request include the servlet context as well as the servlet path

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

ContextRootSwappingService()
Constructs an instanceof ContextRootSwappingService

Method Summary

boolean	canGetResource(javax.servlet.ServletContext pServletContext, java.lang.String pPath) Whether we can get the specified resource (equivalent to getResource).
boolean	canGetResourceAsStream(javax.servlet.ServletContext pContext, java.lang.String pPath) Return whether the specific path can be gotten as a stream (pContextRoot.getResourceAsStream(pPath) != null).
protected java.lang.String	findWelcomeFile(javax.servlet.ServletContext pContext, java.lang.String pContextRoot, java.lang.String pServletPath) find a valid welcome file for this request
java.lang.String	getDefaultWelcomeFiles() get DefaultWelcomeFiles
atg.servlet.WebAppFileExistenceService	getWebAppFileExistenceService() Returns property WebAppFileExistenceService.
protected java.lang.String[]	getWelcomeFiles(java.lang.String pContextRoot) find the welcome file list for the given context root, also tack on default welcome files if there are any configured
void	setDefaultWelcomeFiles(java.lang.String pDefaultWelcomeFiles) set DefaultWelcomeFiles
void	setWebAppFileExistenceService(atg.servlet.WebAppFileExistenceService pWebAppFileExistenceService) Sets property WebAppFileExistenceService.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ContextRootSwappingService

public ContextRootSwappingService()

Constructs an instanceof ContextRootSwappingService

Method Detail

setDefaultWelcomeFiles

public void setDefaultWelcomeFiles(java.lang.String pDefaultWelcomeFiles)

set DefaultWelcomeFiles

Parameters:

pDefaultWelcomeFiles - the DefaultWelcomeFiles

getDefaultWelcomeFiles

public java.lang.String getDefaultWelcomeFiles()

get DefaultWelcomeFiles

Returns:

the DefaultWelcomeFiles

setWebAppFileExistenceService

public void setWebAppFileExistenceService(atg.servlet.WebAppFileExistenceService pWebAppFileExistenceService)

Sets property WebAppFileExistenceService. The service we use to ask a ServletContext if a web-app exists.

getWebAppFileExistenceService

public atg.servlet.WebAppFileExistenceService getWebAppFileExistenceService()

Returns property WebAppFileExistenceService. The service we use to ask a ServletContext if a web-app exists.

findWelcomeFile

protected java.lang.String findWelcomeFile(javax.servlet.ServletContext pContext,
                                           java.lang.String pContextRoot,
                                           java.lang.String pServletPath)

find a valid welcome file for this request

Parameters:

pContext - the context to use to test for existence of a welcome file

pContextRoot - the context root string we are searching under

pServletPath - the servlet path for the request

Returns:

a String with the welcome file path

getWelcomeFiles

protected java.lang.String[] getWelcomeFiles(java.lang.String pContextRoot)

find the welcome file list for the given context root, also tack on default welcome files if there are any configured

Parameters:

pContextRoot - the context root

Returns:

a String array containing the valid welcome files

canGetResource

public boolean canGetResource(javax.servlet.ServletContext pServletContext,
                              java.lang.String pPath)

Whether we can get the specified resource (equivalent to getResource). Uses caching if isCacheFileExistence() is true. /** Whether we can get the specified resource (equivalent to getResource), returns the equivalent of (pContextRoot.getResource(pPath) != null).

Parameters:

pServletContext - the servlet context to invoke getResourceAsStream() upon.

pPath - the path of the resource to check.

Returns:

true if getResource() returns (or would return) a non-null result, false otherwise.

canGetResourceAsStream

public boolean canGetResourceAsStream(javax.servlet.ServletContext pContext,
                                      java.lang.String pPath)

Return whether the specific path can be gotten as a stream (pContextRoot.getResourceAsStream(pPath) != null). Uses caching if isCacheFileExistence() is true.

Parameters:

pContext - the servlet context to invoke getResourceAsStream() upon.

pPath - the path of the resource to check.

Returns:

true if getResourceAsStream() returns (or would return) a non-null result, false otherwise.