atg.servlet.pipeline
Class ServletPathPipelineServlet

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.TimedOperationService
              atg.servlet.pipeline.PipelineableServletImpl
                  atg.servlet.pipeline.ServletPathPipelineServlet

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, PipelineableServlet, java.util.EventListener, javax.servlet.Servlet

public class ServletPathPipelineServlet
extends PipelineableServletImpl

This pipeline servlet will split a pathInfo into a servletPath/pathInfo combination. The servlet is configured with a list of possible servlet paths. If an incoming pathInfo starts with one of those servlet paths, then the servletPath is set to that servlet path, and the servlet path is removed from the beginning of the pathInfo. The requestURI is not affected.

If the servletPath is already set (is non-null), then all of the above functionality is skipped.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
java.lang.String[]	mServletPaths The list of possible servlet paths

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

ServletPathPipelineServlet()
Constructs a new ServletPathPipelineServlet

Method Summary

boolean	getAccumulateServletPath()
java.lang.String[]	getServletPaths() Returns the list of possible servlet paths
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Services a DynamoHttpServletRequest/Response pair
void	setAccumulateServletPath(boolean pAccumulateServletPath) Sets the property AccumulateServletPath.
void	setServletPaths(java.lang.String[] pServletPaths) Sets the list of possible servlet paths

Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl

createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, passRequest, passRequest, service, service, setNextServlet, setServletInfo, setUsePathInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, doStartService, doStopService, getAbsoluteName, 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

mServletPaths

public java.lang.String[] mServletPaths

The list of possible servlet paths

Constructor Detail

ServletPathPipelineServlet

public ServletPathPipelineServlet()

Constructs a new ServletPathPipelineServlet

Method Detail

getServletPaths

public java.lang.String[] getServletPaths()

Returns the list of possible servlet paths

setServletPaths

public void setServletPaths(java.lang.String[] pServletPaths)

Sets the list of possible servlet paths

setAccumulateServletPath

public void setAccumulateServletPath(boolean pAccumulateServletPath)

Sets the property AccumulateServletPath. If this is false, this servlet just passes the request along if the servlet path is already set. If it is set, this servlet will combine the current servlet path with the new one.

Parameters:

pAccumulateServletPath - new value to set

getAccumulateServletPath

public boolean getAccumulateServletPath()

Returns:

The value of the property AccumulateServletPath.

service

public void service(DynamoHttpServletRequest pRequest,
                    DynamoHttpServletResponse pResponse)
             throws java.io.IOException,
                    javax.servlet.ServletException

Services a DynamoHttpServletRequest/Response pair

Overrides:

service in class PipelineableServletImpl

Throws:

javax.servlet.ServletException - if an error occurred while processing the servlet request

java.io.IOException - if an error occurred while reading or writing the servlet request