Package io.vertigo.vega.impl.servlet.filter

Class AbstractFilter

java.lang.Object

io.vertigo.vega.impl.servlet.filter.AbstractFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

AnalyticsFilter, AuthorizationWebFilter, CacheControlFilter, CompressionFilter, ContentSecurityPolicyFilter, HeaderControlFilter, LegacySecurityFilter, SecurityFilter

public abstract class AbstractFilter
extends Object
implements javax.servlet.Filter

Author:

npiedeloup

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	EXCLUDE_PATTERN_PARAM_NAME	Filter parameter name for exclude some url.

Constructor Summary

Constructors

Constructor	Description
AbstractFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain)
protected abstract void	doInit()
protected abstract void	doMyFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain)
protected javax.servlet.FilterConfig	getFilterConfig()
void	init(javax.servlet.FilterConfig filterConfig)
protected static boolean	isUrlMatch(String context, String requestUri, Pattern pattern)	Test si l'url (hors domain et context) correspond au pattern.
protected static boolean	isUrlMatch(javax.servlet.ServletRequest req, Optional<Pattern> pattern)	Test si l'url correspond au pattern.
protected static Optional<Pattern>	parsePattern(String urlExcludePattern)

Methods inherited from class java.lang.Object

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

Field Detail

EXCLUDE_PATTERN_PARAM_NAME

protected static final String EXCLUDE_PATTERN_PARAM_NAME

Filter parameter name for exclude some url.

See Also:

Constant Field Values

Constructor Detail

AbstractFilter

public AbstractFilter()

Method Detail

init

public final void init(javax.servlet.FilterConfig filterConfig)

Specified by:

init in interface javax.servlet.Filter

doFilter

public final void doFilter(javax.servlet.ServletRequest req,
                           javax.servlet.ServletResponse res,
                           javax.servlet.FilterChain chain)
                    throws IOException,
                           javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

parsePattern

protected static final Optional<Pattern> parsePattern(String urlExcludePattern)

Parameters:

urlExcludePattern - Chaine d'exclusion du filtre à traduire en regExp.

Returns:

Pattern compilé

isUrlMatch

protected static final boolean isUrlMatch(javax.servlet.ServletRequest req,
                                          Optional<Pattern> pattern)

Test si l'url correspond au pattern.

Parameters:

req - Request

pattern - Pattern de test

Returns:

si l'url match le pattern, ou false si pas de pattern ou si pas httprequest.

isUrlMatch

protected static final boolean isUrlMatch(String context,
                                          String requestUri,
                                          Pattern pattern)

Test si l'url (hors domain et context) correspond au pattern.

Parameters:

context - Context de la webapp

requestUri - uri complete de la request

pattern - Pattern de test

Returns:

si l'url match le pattern, ou false si pas de pattern ou si pas httprequest.

getFilterConfig

protected final javax.servlet.FilterConfig getFilterConfig()

doInit

protected abstract void doInit()

doMyFilter

protected abstract void doMyFilter(javax.servlet.ServletRequest req,
                                   javax.servlet.ServletResponse res,
                                   javax.servlet.FilterChain chain)
                            throws IOException,
                                   javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

destroy

public final void destroy()

Specified by:

destroy in interface javax.servlet.Filter