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, CompositeFilter, ContentTypeFilter, ContextFilter, CosMultipartRequestFilter, DumpHeadersFilter, FilterDecorator, I18nContentSupportFilter, InstallFilter, InterceptFilter, LoginFilter, MultipartRequestFilter, OncePerRequestAbstractMgnlFilter, PerformanceTestFilter, RepositoryMappingFilter, ServletDispatchingFilter, SessionDebugger, UnicodeNormalizationFilter, VirtualUriFilter

public abstract class AbstractMgnlFilter
extends java.lang.Object
implements MgnlFilter

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

Version:

$Id: AbstractMgnlFilter.java 32667 2010-03-13 00:37:06Z gjoseph $

Author:

philipp

Constructor Summary

AbstractMgnlFilter()

Method Summary

protected boolean	acceptsEncoding(javax.servlet.http.HttpServletRequest request, java.lang.String name)
protected boolean	acceptsGzipEncoding(javax.servlet.http.HttpServletRequest request)
protected void	addAndVerifyHeader(javax.servlet.http.HttpServletResponse response, java.lang.String name, java.lang.String value)
void	addBypass(Voter voter)
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()
java.lang.String	getName()
protected boolean	headerContains(javax.servlet.http.HttpServletRequest request, java.lang.String header, java.lang.String value)
void	init(javax.servlet.FilterConfig filterConfig)
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMgnlFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

doFilter

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

Throws:

java.io.IOException

javax.servlet.ServletException

bypasses

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

Specified by:

bypasses in interface MgnlFilter

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

getBypasses

public Voter[] getBypasses()

addBypass

public void addBypass(Voter voter)

getName

public java.lang.String getName()

Specified by:

getName in interface MgnlFilter

setName

public void setName(java.lang.String name)

Specified by:

setName in interface MgnlFilter

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

acceptsGzipEncoding

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

acceptsEncoding

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

headerContains

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

addAndVerifyHeader

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