info.magnolia.cms.filters
Class AbstractMgnlFilter

java.lang.Object
  info.magnolia.cms.filters.AbstractMgnlFilter

All Implemented Interfaces:

MgnlFilter, javax.servlet.Filter

Direct Known Subclasses:

AggregatorFilter, BaseSecurityFilter, CacheHeadersFilter, CompositeFilter, ContentTypeFilter, ContextFilter, DumpHeadersFilter, FilterDecorator, I18nContentSupportFilter, InstallFilter, InterceptFilter, LoginFilter, OncePerRequestAbstractMgnlFilter, PerformanceTestFilter, ReceiveFilter, RenderingFilter, RepositoryMappingFilter, SampleFilter, ServletDispatchingFilter, SessionDebugger, UnicodeNormalizationFilter, VirtualUriFilter

public abstract class AbstractMgnlFilter
extends Object
implements MgnlFilter

A magnolia filter configured in the config repository. This filter is bypassable.

Version:

$Id: AbstractMgnlFilter.java 41230 2011-01-12 14:27:42Z pbaerfuss $

Author:

philipp

Constructor Summary

protected

AbstractMgnlFilter()

Method Summary

protected boolean	acceptsEncoding(javax.servlet.http.HttpServletRequest request, String name)
protected boolean	acceptsGzipEncoding(javax.servlet.http.HttpServletRequest request)
protected void	addAndVerifyHeader(javax.servlet.http.HttpServletResponse response, String name, String value)
void	addBypass(Voter voter)
void	addMapping(String mapping)
protected boolean	bypasses(javax.servlet.http.HttpServletRequest request)
void	destroy()
abstract void	doFilter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
Voter[]	getBypasses()
DispatchRules	getDispatching()
protected Mapping	getMapping()
Collection<String>	getMappings()
String	getName()
protected boolean	headerContains(javax.servlet.http.HttpServletRequest request, String header, String value)
void	init(javax.servlet.FilterConfig filterConfig)
boolean	isEnabled()
protected boolean	mapsTo(javax.servlet.http.HttpServletRequest request)
boolean	matches(javax.servlet.http.HttpServletRequest request)
protected boolean	matchesDispatching(javax.servlet.http.HttpServletRequest request)
void	setDispatching(DispatchRules dispatching)
void	setEnabled(boolean enabled)
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMgnlFilter

protected AbstractMgnlFilter()

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 IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

doFilter

public abstract void doFilter(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              javax.servlet.FilterChain chain)
                       throws IOException,
                              javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

matches

public boolean matches(javax.servlet.http.HttpServletRequest request)

Specified by:

matches in interface MgnlFilter

mapsTo

protected boolean mapsTo(javax.servlet.http.HttpServletRequest request)

matchesDispatching

protected boolean matchesDispatching(javax.servlet.http.HttpServletRequest request)

bypasses

protected boolean bypasses(javax.servlet.http.HttpServletRequest request)

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

getBypasses

public Voter[] getBypasses()

addBypass

public void addBypass(Voter voter)

getName

public String getName()

Specified by:

getName in interface MgnlFilter

setName

public void setName(String name)

Specified by:

setName in interface MgnlFilter

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getDispatching

public DispatchRules getDispatching()

setDispatching

public void setDispatching(DispatchRules dispatching)

getMappings

public Collection<String> getMappings()

getMapping

protected Mapping getMapping()

addMapping

public void addMapping(String mapping)

acceptsGzipEncoding

protected boolean acceptsGzipEncoding(javax.servlet.http.HttpServletRequest request)

acceptsEncoding

protected boolean acceptsEncoding(javax.servlet.http.HttpServletRequest request,
                                  String name)

headerContains

protected boolean headerContains(javax.servlet.http.HttpServletRequest request,
                                 String header,
                                 String value)

addAndVerifyHeader

protected void addAndVerifyHeader(javax.servlet.http.HttpServletResponse response,
                                  String name,
                                  String value)