atg.servlet.pipeline
Class InsertableServletImpl

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.nucleus.TimedOperationService
              extended by atg.servlet.pipeline.PipelineableServletImpl
                  extended by atg.servlet.pipeline.InsertableServletImpl
All Implemented Interfaces:
NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, InsertableServlet, PipelineableServlet, java.util.EventListener, javax.servlet.Servlet
Direct Known Subclasses:
CheckSessionExpiration, CommerceCommandServlet, JumpServlet, ProfilePropertyServlet, ProfileRequestServlet, PromotionServlet, SearchClickThroughServlet, SecurityDomainServlet, SessionEventTrigger, SetCurrentLocation

public class InsertableServletImpl
extends PipelineableServletImpl
implements InsertableServlet

An InsertableServletImpl is an implementation of an InsertableServlet that splices itself into a servlet pipeline in doStartService.

Subclasses of InsertableServletImpl that need to add their own logic to doStartService should be sure to call super.doStartService() at some point.

See Also:
InsertableServlet, PipelineableServletImpl

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
InsertableServletImpl()
           
 
Method Summary
 void doStartService()
          Splices this servlet or servlet chain into a servlet pipeline, immediately after the insertAfterServlet.
 PipelineableServlet getInsertAfterServlet()
          Returns the Servlet in the pipeline after which this servlet should appear.
 void setInsertAfterServlet(PipelineableServlet pInsertAfterServlet)
          Sets the Servlet after which this servlet should appear in the pipeline.
 
Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl
createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, passRequest, passRequest, service, 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, doStopService, getAbsoluteName, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
 
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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
 
Methods inherited from interface atg.servlet.pipeline.PipelineableServlet
getNextServlet, passRequest, setNextServlet
 
Methods inherited from interface javax.servlet.Servlet
destroy, getServletConfig, getServletInfo, init, service
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

InsertableServletImpl

public InsertableServletImpl()
Method Detail

setInsertAfterServlet

public void setInsertAfterServlet(PipelineableServlet pInsertAfterServlet)
Sets the Servlet after which this servlet should appear in the pipeline.

Specified by:
setInsertAfterServlet in interface InsertableServlet

getInsertAfterServlet

public PipelineableServlet getInsertAfterServlet()
Returns the Servlet in the pipeline after which this servlet should appear.

Specified by:
getInsertAfterServlet in interface InsertableServlet

doStartService

public void doStartService()
                    throws ServiceException
Splices this servlet or servlet chain into a servlet pipeline, immediately after the insertAfterServlet.

Overrides:
doStartService in class GenericService
Throws:
ServiceException - if the Service had a problem starting up