Package org.pac4j.jee.config

Class AbstractConfigFilter

java.lang.Object
org.pac4j.jee.config.AbstractConfigFilter
All Implemented Interfaces:
jakarta.servlet.Filter
Direct Known Subclasses:
Saml2MetadataFilter
public abstract class AbstractConfigFilter extends Object implements jakarta.servlet.Filter
An abstract JEE filter which handles configuration.
Since:
5.0.0
Author:
Jerome Leleu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.slf4j.Logger
    logger
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractConfigFilter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
    protected Boolean
    getBooleanParam(jakarta.servlet.FilterConfig filterConfig, String name, Boolean defaultValue)
    getBooleanParam.
    org.pac4j.core.config.Config
    getSharedConfig()
    getSharedConfig.
    protected String
    getStringParam(jakarta.servlet.FilterConfig filterConfig, String name, String defaultValue)
    getStringParam.
    void
    init(jakarta.servlet.FilterConfig filterConfig)
    protected abstract void
    internalFilter(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
    internalFilter.
    void
    setConfig(org.pac4j.core.config.Config config)
    Setter for the field config.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface jakarta.servlet.Filter

    destroy

  • Field Details

    • logger

      protected final org.slf4j.Logger logger

  • Constructor Details

    • AbstractConfigFilter

      public AbstractConfigFilter()

  • Method Details

    • init

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

    • getStringParam

      protected String getStringParam(jakarta.servlet.FilterConfig filterConfig, String name, String defaultValue)

      getStringParam.

      Parameters:
      filterConfig - a FilterConfig object
      name - a String object
      defaultValue - a String object
      Returns:
      a String object

    • getBooleanParam

      protected Boolean getBooleanParam(jakarta.servlet.FilterConfig filterConfig, String name, Boolean defaultValue)

      getBooleanParam.

      Parameters:
      filterConfig - a FilterConfig object
      name - a String object
      defaultValue - a Boolean object
      Returns:
      a Boolean object

    • doFilter

      public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException
      Specified by:
      doFilter in interface jakarta.servlet.Filter
      Throws:
      IOException
      jakarta.servlet.ServletException

    • internalFilter

      protected abstract void internalFilter(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException

      internalFilter.

      Parameters:
      request - a HttpServletRequest object
      response - a HttpServletResponse object
      chain - a FilterChain object
      Throws:
      IOException - if any.
      jakarta.servlet.ServletException - if any.

    • getSharedConfig

      public org.pac4j.core.config.Config getSharedConfig()

      getSharedConfig.

      Returns:
      a Config object

    • setConfig

      public void setConfig(org.pac4j.core.config.Config config)

      Setter for the field config.

      Parameters:
      config - a Config object