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

Class AbstractFilter

java.lang.Object
io.vertigo.vega.impl.servlet.filter.AbstractFilter
All Implemented Interfaces:
jakarta.servlet.Filter
Direct Known Subclasses:
AnalyticsFilter, AuthorizationWebFilter, CacheControlFilter, CompressionFilter, ContentSecurityPolicyFilter, HeaderControlFilter, SecurityFilter
public abstract class AbstractFilter extends Object implements jakarta.servlet.Filter
Author:
npiedeloup

  • Field Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • EXCLUDE_PATTERN_PARAM_NAME

      protected static final String EXCLUDE_PATTERN_PARAM_NAME
      Filter parameter name for exclude some url.
      See Also:

  • Constructor Details

    • AbstractFilter

      public AbstractFilter()

  • Method Details

    • init

      public final void init(jakarta.servlet.FilterConfig filterConfig)
      Specified by:
      init in interface jakarta.servlet.Filter

    • doFilter

      public final void doFilter(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse res, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException
      Specified by:
      doFilter in interface jakarta.servlet.Filter
      Throws:
      IOException
      jakarta.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(jakarta.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 jakarta.servlet.FilterConfig getFilterConfig()

    • doInit

      protected abstract void doInit()

    • doMyFilter

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

    • destroy

      public final void destroy()
      Specified by:
      destroy in interface jakarta.servlet.Filter