atg.servlet.pipeline
Interface PipelineableServlet

All Superinterfaces:
javax.servlet.Servlet
All Known Subinterfaces:
DispatcherPipelineableServlet, InsertableServlet
All Known Implementing Classes:
AccessControlServlet, BasicAuthenticationPipelineServlet, CheckSessionExpiration, CommerceCommandServlet, CommerceProfileRequestServlet, CookiePipelineServlet, DispatcherPipelineServletImpl, DropletEventServlet, DynamoPipelineServlet, FileFinderPipelineServlet, FormLoginPipelineServlet, HeadPipelineServlet, InsertableServletImpl, MimeTypeDispatcherPipelineServlet, MimeTyperPipelineServlet, PipelineableServletImpl, ProfileRequestServlet, PromotionServlet, SecurityDomainServlet, ServletPathDispatcherPipelineServlet, ServletPathPipelineServlet, SessionEventTrigger, SessionPipelineServlet, SetCurrentLocation, ThreadUserBinderServlet, URLArgumentPipelineServlet, WACheckSessionExpiration, WASetCurrentLocation

public interface PipelineableServlet
extends javax.servlet.Servlet

A PipelineableServlet is a Servlet that knows how to operate in a PipelineServlet. When a PipelineableServlet is added to a PipelineServlet, the PipelineableServlet will be informed of the next Servlet in the Pipeline. The PipelineableServlet should pass requests on to that next Servlet.

See Also:
PipelineableServletImpl

Field Summary
static java.lang.String CLASS_VERSION
           
 
Method Summary
 javax.servlet.Servlet getNextServlet()
          Returns the next Servlet in the pipeline, null if this is the end of the pipeline.
 void passRequest(javax.servlet.ServletRequest pRequest, javax.servlet.ServletResponse pResponse)
          Passes the specified request on to the next servlet in the pipeline
 void setNextServlet(javax.servlet.Servlet pNextServlet)
          Sets the next Servlet in the pipeline, null if this is the end of the pipeline.
 
Methods inherited from interface javax.servlet.Servlet
destroy, getServletConfig, getServletInfo, init, service
 

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION
See Also:
Constant Field Values
Method Detail

setNextServlet

void setNextServlet(javax.servlet.Servlet pNextServlet)
Sets the next Servlet in the pipeline, null if this is the end of the pipeline.


getNextServlet

javax.servlet.Servlet getNextServlet()
Returns the next Servlet in the pipeline, null if this is the end of the pipeline.


passRequest

void passRequest(javax.servlet.ServletRequest pRequest,
                 javax.servlet.ServletResponse pResponse)
                 throws java.io.IOException,
                        javax.servlet.ServletException
Passes the specified request on to the next servlet in the pipeline

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