com.google.inject.servlet

Class AbstractFilterPipeline

java.lang.Object

com.google.inject.servlet.AbstractFilterPipeline

All Implemented Interfaces:

FilterPipeline

public abstract class AbstractFilterPipeline
extends Object
implements FilterPipeline

Skeleton implementation of a central routing/dispatch class which uses a sequence of FilterDefinitions to filter requests before delegating to the servlet pipeline.

Author:

dhanji@gmail.com (Dhanji R. Prasanna)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFilterPipeline(Injector injector, AbstractServletPipeline servletPipeline, Provider<javax.servlet.ServletContext> servletContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroyPipeline() Destroys the pipeline, taking it out of service.
void	dispatch(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain proceedingFilterChain) Dispatches a request against the pipeline.
protected abstract FilterDefinition[]	filterDefinitions()
protected abstract boolean	hasFiltersMapped()
void	initPipeline(javax.servlet.ServletContext servletContext) Initializes the pipeline, putting it into service.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilterPipeline

protected AbstractFilterPipeline(Injector injector,
                      AbstractServletPipeline servletPipeline,
                      Provider<javax.servlet.ServletContext> servletContext)

Method Detail

hasFiltersMapped

protected abstract boolean hasFiltersMapped()

Returns:

true if any filter mappings exist; otherwise false

filterDefinitions

protected abstract FilterDefinition[] filterDefinitions()

Returns:

snapshot of the filter mappings currently defined for this pipeline

initPipeline

public void initPipeline(javax.servlet.ServletContext servletContext)
                  throws javax.servlet.ServletException

Description copied from interface: FilterPipeline

Initializes the pipeline, putting it into service.

Specified by:

initPipeline in interface FilterPipeline

Parameters:

servletContext - of the web application

Throws:

javax.servlet.ServletException

dispatch

public void dispatch(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain proceedingFilterChain)
              throws IOException,
                     javax.servlet.ServletException

Description copied from interface: FilterPipeline

Dispatches a request against the pipeline.

Specified by:

dispatch in interface FilterPipeline

Parameters:

request - to dispatch

response - to populate

proceedingFilterChain - for last resort filtering

Throws:

IOException

javax.servlet.ServletException

destroyPipeline

public void destroyPipeline()

Description copied from interface: FilterPipeline

Destroys the pipeline, taking it out of service.

Specified by:

destroyPipeline in interface FilterPipeline