org.atmosphere.util

Class AtmosphereFilterChain

java.lang.Object

org.atmosphere.util.AtmosphereFilterChain

All Implemented Interfaces:

jakarta.servlet.FilterChain

public final class AtmosphereFilterChain
extends java.lang.Object
implements jakarta.servlet.FilterChain

Implementation of jakarta.servlet.FilterChain used to manage the execution of a set of filters for a particular request. When the set of defined filters has all been executed, the next call to doFilter() will execute the servlet's service() method itself.

Author:

Craig R. McClanahan

Field Summary

Fields

Modifier and Type	Field and Description
static int	INCREMENT

Constructor Summary

Constructors

Constructor and Description
AtmosphereFilterChain()

Method Summary

Modifier and Type	Method and Description
void	addFilter(FilterConfigImpl filterConfig) Add a filter to the set of filters that will be executed in this chain.
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response) Invoke the next filter in this chain, passing the specified request and response.
FilterConfigImpl	getFilter(int i)
jakarta.servlet.Servlet	getServlet()
jakarta.servlet.ServletConfig	getServletConfig()
void	init() Initialize the Filter
void	invokeFilterChain(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
void	setServlet(jakarta.servlet.ServletConfig configImpl, jakarta.servlet.Servlet servlet) Set the servlet that will be executed at the end of this chain.

Methods inherited from class java.lang.Object

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

Field Detail

INCREMENT

public static final int INCREMENT

See Also:

Constant Field Values

Constructor Detail

AtmosphereFilterChain

public AtmosphereFilterChain()

Method Detail

init

public void init()
          throws jakarta.servlet.ServletException

Initialize the Filter

Throws:

jakarta.servlet.ServletException

invokeFilterChain

public void invokeFilterChain(jakarta.servlet.ServletRequest request,
                              jakarta.servlet.ServletResponse response)
                       throws java.io.IOException,
                              jakarta.servlet.ServletException

Throws:

java.io.IOException

jakarta.servlet.ServletException

doFilter

public void doFilter(jakarta.servlet.ServletRequest request,
                     jakarta.servlet.ServletResponse response)
              throws java.io.IOException,
                     jakarta.servlet.ServletException

Invoke the next filter in this chain, passing the specified request and response. If there are no more filters in this chain, invoke the service() method of the servlet itself.

Specified by:

doFilter in interface jakarta.servlet.FilterChain

Parameters:

request - The servlet request we are processing

response - The servlet response we are creating

Throws:

java.io.IOException - if an input/output error occurs

jakarta.servlet.ServletException - if a servlet exception occurs

addFilter

public void addFilter(FilterConfigImpl filterConfig)

Add a filter to the set of filters that will be executed in this chain.

Parameters:

filterConfig - The FilterConfig for the servlet to be executed

setServlet

public void setServlet(jakarta.servlet.ServletConfig configImpl,
                       jakarta.servlet.Servlet servlet)

Set the servlet that will be executed at the end of this chain. Set by the mapper filter

getFilter

public FilterConfigImpl getFilter(int i)

getServlet

public jakarta.servlet.Servlet getServlet()

getServletConfig

public jakarta.servlet.ServletConfig getServletConfig()

destroy

public void destroy()