org.hippoecm.hst.core.container
Interface Pipeline

All Known Implementing Classes:

HstSitePipeline

public interface Pipeline

Pipeline interface. HstRequestProcessor will invoke the proper Pipeline instance to serve the request.

Version:

$Id: Pipeline.java 29808 2011-08-23 21:30:48Z aschrijvers $

Method Summary

void	afterInvoke(HstContainerConfig requestContainerConfig, HstRequestContext requestContext, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Deprecated. use cleanup(HstContainerConfig, HstRequestContext, HttpServletRequest, HttpServletResponse) instead
void	beforeInvoke(HstContainerConfig requestContainerConfig, HstRequestContext requestContext, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Deprecated. Not use any more. The invoke(HstContainerConfig, HstRequestContext, HttpServletRequest, HttpServletResponse) combines beforeInvoke as well
void	cleanup(HstContainerConfig requestContainerConfig, HstRequestContext requestContext, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Does post-processing step for the request processing.
void	destroy() Destroys the pipeline.
void	initialize() Initializes the pipeline
void	invoke(HstContainerConfig requestContainerConfig, HstRequestContext requestContext, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Invokes the request processing, aka the initialization and rendering valves

Method Detail

initialize

void initialize()
                throws ContainerException

Initializes the pipeline

Throws:

ContainerException

beforeInvoke

@Deprecated
void beforeInvoke(HstContainerConfig requestContainerConfig,
                             HstRequestContext requestContext,
                             javax.servlet.http.HttpServletRequest servletRequest,
                             javax.servlet.http.HttpServletResponse servletResponse)
                  throws ContainerException

Deprecated. Not use any more. The invoke(HstContainerConfig, HstRequestContext, HttpServletRequest, HttpServletResponse) combines beforeInvoke as well

Does pre-processing step for the request processing.

Parameters:

requestContainerConfig - the HstComponent container configuration

requestContext -

servletRequest -

servletResponse -

Throws:

ContainerException

invoke

void invoke(HstContainerConfig requestContainerConfig,
            HstRequestContext requestContext,
            javax.servlet.http.HttpServletRequest servletRequest,
            javax.servlet.http.HttpServletResponse servletResponse)
            throws ContainerException

Invokes the request processing, aka the initialization and rendering valves

Parameters:

requestContainerConfig - the HstComponent container configuration

requestContext -

servletRequest -

servletResponse -

Throws:

ContainerException

afterInvoke

@Deprecated
void afterInvoke(HstContainerConfig requestContainerConfig,
                            HstRequestContext requestContext,
                            javax.servlet.http.HttpServletRequest servletRequest,
                            javax.servlet.http.HttpServletResponse servletResponse)
                 throws ContainerException

Deprecated. use cleanup(HstContainerConfig, HstRequestContext, HttpServletRequest, HttpServletResponse) instead

Does post-processing step for the request processing.

Parameters:

requestContainerConfig - the HstComponent container configuration

requestContext -

servletRequest -

servletResponse -

Throws:

ContainerException

cleanup

void cleanup(HstContainerConfig requestContainerConfig,
             HstRequestContext requestContext,
             javax.servlet.http.HttpServletRequest servletRequest,
             javax.servlet.http.HttpServletResponse servletResponse)
             throws ContainerException

Does post-processing step for the request processing.

Parameters:

requestContainerConfig - the HstComponent container configuration

requestContext -

servletRequest -

servletResponse -

Throws:

ContainerException

destroy

void destroy()
             throws ContainerException

Destroys the pipeline.

Throws:

ContainerException