Module cloud.piranha.core.api
Package cloud.piranha.core.api

Interface FilterEnvironment

All Superinterfaces:
jakarta.servlet.FilterConfig, jakarta.servlet.FilterRegistration, jakarta.servlet.FilterRegistration.Dynamic, jakarta.servlet.Registration, jakarta.servlet.Registration.Dynamic
All Known Implementing Classes:
DefaultFilterEnvironment
public interface FilterEnvironment extends jakarta.servlet.FilterRegistration.Dynamic, jakarta.servlet.FilterConfig
The environment of a Filter.
Author:
Manfred Riem ([email protected]), Arjan Tijms

  • Nested Class Summary

    Nested classes/interfaces inherited from interface jakarta.servlet.FilterRegistration

    jakarta.servlet.FilterRegistration.Dynamic

    Nested classes/interfaces inherited from interface jakarta.servlet.Registration

    jakarta.servlet.Registration.Dynamic

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    UNAVAILABLE
    Defines the UNAVAILABLE constant.

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.servlet.Filter
    getFilter()
    Returns the filter.
    WebApplication
    getWebApplication()
    Returns the web application.
    void
    initialize()
    Initialize the filter.
    boolean
    isAsyncSupported()
    Is async supported.
    void
    setClassName(String className)
    Set the class name.
    void
    setFilterName(String filterName)
    Set the filter name.
    void
    setStatus(int status)
    Set status.
    void
    setWebApplication(WebApplication webApplication)
    Set the web application.

    Methods inherited from interface jakarta.servlet.FilterConfig

    getFilterName, getInitParameter, getInitParameterNames, getServletContext

    Methods inherited from interface jakarta.servlet.FilterRegistration

    addMappingForServletNames, addMappingForUrlPatterns, getServletNameMappings, getUrlPatternMappings

    Methods inherited from interface jakarta.servlet.Registration

    getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

    Methods inherited from interface jakarta.servlet.Registration.Dynamic

    setAsyncSupported

  • Field Details

    • UNAVAILABLE

      static final int UNAVAILABLE
      Defines the UNAVAILABLE constant.
      See Also:

  • Method Details

    • getFilter

      jakarta.servlet.Filter getFilter()
      Returns the filter.
      Returns:
      the filter

    • initialize

      void initialize() throws jakarta.servlet.ServletException
      Initialize the filter.
      Throws:
      jakarta.servlet.ServletException - when a servlet error occurs.

    • setClassName

      void setClassName(String className)
      Set the class name.
      Parameters:
      className - the class name.

    • setFilterName

      void setFilterName(String filterName)
      Set the filter name.
      Parameters:
      filterName - the filter name.

    • setStatus

      void setStatus(int status)
      Set status.
      Parameters:
      status - the status.

    • getWebApplication

      WebApplication getWebApplication()
      Returns the web application.
      Returns:
      the web application

    • setWebApplication

      void setWebApplication(WebApplication webApplication)
      Set the web application.
      Parameters:
      webApplication - the web application.

    • isAsyncSupported

      boolean isAsyncSupported()
      Is async supported.
      Returns:
      true if it is, false otherwise.