net.sourceforge.scopes.filters
Class ScopesFilter<T extends javax.servlet.ServletRequest>

java.lang.Object
  net.sourceforge.scopes.filters.ScopesFilter<T>

Type Parameters:

T - The request class.

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

ScopesHttpFilter

public class ScopesFilter<T extends javax.servlet.ServletRequest>
extends java.lang.Object
implements javax.servlet.Filter

Servlet filter that intercepts a request and then creates a state, wrapping the request with an object that can contain the state itself.

Field Summary

protected StateBuilder<T>	builder The used state builder.
static java.lang.String	FILTER_CONFIG_PARAM Constant that represents the key to use to get the original FilterConfig object.

Constructor Summary

ScopesFilter()

Method Summary

void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
protected java.util.Map<java.lang.String,java.lang.Object>	filterConfig2map(javax.servlet.FilterConfig filterConfig) Takes all init parameters from the filter configuration and put them in a map.
void	init(javax.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_CONFIG_PARAM

public static final java.lang.String FILTER_CONFIG_PARAM

Constant that represents the key to use to get the original FilterConfig object.

See Also:

Constant Field Values

builder

protected StateBuilder<T extends javax.servlet.ServletRequest> builder

The used state builder.

Constructor Detail

ScopesFilter

public ScopesFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

filterConfig2map

protected java.util.Map<java.lang.String,java.lang.Object> filterConfig2map(javax.servlet.FilterConfig filterConfig)

Takes all init parameters from the filter configuration and put them in a map.

Parameters:

filterConfig - The filter configuration.

Returns:

The resulting map.