Module cloud.piranha.core.impl
Package cloud.piranha.core.impl

Class DefaultFilterEnvironment

java.lang.Object
cloud.piranha.core.impl.DefaultFilterEnvironment
All Implemented Interfaces:
FilterEnvironment, jakarta.servlet.FilterConfig, jakarta.servlet.FilterRegistration, jakarta.servlet.FilterRegistration.Dynamic, jakarta.servlet.Registration, jakarta.servlet.Registration.Dynamic
public class DefaultFilterEnvironment extends Object implements FilterEnvironment
The default FilterEnvironment.
Author:
Manfred Riem ([email protected])

  • Constructor Details

    • DefaultFilterEnvironment

      public DefaultFilterEnvironment()
      Constructor.

    • DefaultFilterEnvironment

      public DefaultFilterEnvironment(WebApplication webApp, String filterName, jakarta.servlet.Filter filter)
      Constructor.
      Parameters:
      webApp - the web application.
      filterName - the filter name.
      filter - the filter.

  • Method Details

    • addMappingForServletNames

      public void addMappingForServletNames(EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames)
      Specified by:
      addMappingForServletNames in interface jakarta.servlet.FilterRegistration

    • addMappingForUrlPatterns

      public void addMappingForUrlPatterns(EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns)
      Specified by:
      addMappingForUrlPatterns in interface jakarta.servlet.FilterRegistration

    • getClassName

      public String getClassName()
      Specified by:
      getClassName in interface jakarta.servlet.Registration

    • getFilter

      public jakarta.servlet.Filter getFilter()
      Description copied from interface: FilterEnvironment
      Returns the filter.
      Specified by:
      getFilter in interface FilterEnvironment
      Returns:
      the filter

    • getFilterName

      public String getFilterName()
      Specified by:
      getFilterName in interface jakarta.servlet.FilterConfig

    • getInitParameter

      public String getInitParameter(String name)
      Specified by:
      getInitParameter in interface jakarta.servlet.FilterConfig
      Specified by:
      getInitParameter in interface jakarta.servlet.Registration

    • getInitParameterNames

      public Enumeration<String> getInitParameterNames()
      Specified by:
      getInitParameterNames in interface jakarta.servlet.FilterConfig

    • getInitParameters

      public Map<String,String> getInitParameters()
      Specified by:
      getInitParameters in interface jakarta.servlet.Registration

    • getName

      public String getName()
      Specified by:
      getName in interface jakarta.servlet.Registration

    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()
      Specified by:
      getServletContext in interface jakarta.servlet.FilterConfig

    • getServletNameMappings

      public Collection<String> getServletNameMappings()
      Specified by:
      getServletNameMappings in interface jakarta.servlet.FilterRegistration

    • getStatus

      public int getStatus()
      Get the status.
      Returns:
      the status.

    • getUrlPatternMappings

      public Collection<String> getUrlPatternMappings()
      Specified by:
      getUrlPatternMappings in interface jakarta.servlet.FilterRegistration

    • getWebApplication

      public WebApplication getWebApplication()
      Description copied from interface: FilterEnvironment
      Returns the web application.
      Specified by:
      getWebApplication in interface FilterEnvironment
      Returns:
      the web application

    • initialize

      public void initialize() throws jakarta.servlet.ServletException
      Description copied from interface: FilterEnvironment
      Initialize the filter.
      Specified by:
      initialize in interface FilterEnvironment
      Throws:
      jakarta.servlet.ServletException - when a servlet error occurs.

    • isAsyncSupported

      public boolean isAsyncSupported()
      Description copied from interface: FilterEnvironment
      Is async supported.
      Specified by:
      isAsyncSupported in interface FilterEnvironment
      Returns:
      true if it is, false otherwise.

    • setAsyncSupported

      public void setAsyncSupported(boolean asyncSupported)
      Specified by:
      setAsyncSupported in interface jakarta.servlet.Registration.Dynamic

    • setClassName

      public void setClassName(String className)
      Description copied from interface: FilterEnvironment
      Set the class name.
      Specified by:
      setClassName in interface FilterEnvironment
      Parameters:
      className - the class name.

    • setFilterName

      public void setFilterName(String filterName)
      Description copied from interface: FilterEnvironment
      Set the filter name.
      Specified by:
      setFilterName in interface FilterEnvironment
      Parameters:
      filterName - the filter name.

    • setInitParameter

      public boolean setInitParameter(String name, String value)
      Specified by:
      setInitParameter in interface jakarta.servlet.Registration

    • setInitParameters

      public Set<String> setInitParameters(Map<String,String> initParameters)
      Specified by:
      setInitParameters in interface jakarta.servlet.Registration

    • setStatus

      public void setStatus(int status)
      Description copied from interface: FilterEnvironment
      Set status.
      Specified by:
      setStatus in interface FilterEnvironment
      Parameters:
      status - the status.

    • setWebApplication

      public void setWebApplication(WebApplication webApplication)
      Description copied from interface: FilterEnvironment
      Set the web application.
      Specified by:
      setWebApplication in interface FilterEnvironment
      Parameters:
      webApplication - the web application.

    • toString

      public String toString()
      Overrides:
      toString in class Object