Package com.ibm.wsspi.webcontainer.filter

Interface IFilterConfig

All Superinterfaces:
jakarta.servlet.FilterConfig, jakarta.servlet.FilterRegistration, jakarta.servlet.FilterRegistration.Dynamic, IFilterConfig, jakarta.servlet.Registration, jakarta.servlet.Registration.Dynamic
public interface IFilterConfig extends IFilterConfig
A representation of the configuration for a filter

  • 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 inherited from interface com.ibm.websphere.servlet.filter.IFilterConfig

    FILTER_ERROR, FILTER_FORWARD, FILTER_INCLUDE, FILTER_REQUEST

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.servlet.DispatcherType[]
    getDispatchType()
    Get the dispatch type
    jakarta.servlet.Filter
    getFilter()
     
    Class<? extends jakarta.servlet.Filter>
    getFilterClass()
     
    ClassLoader
    getFilterClassLoader()
    Get the classloader where this Filter should be loaded from.
    String
    getFilterClassName()
    Get the filter class name
    boolean
    isInternal()
    Checks if resource should be considered internal.
    void
    setFilter(jakarta.servlet.Filter filter)
     
    void
    setFilterClass(Class<? extends jakarta.servlet.Filter> filterClass)
     
    void
    setFilterClassName(String className)
     
    void
    setInternal(boolean isInternal)
    Set whether resource should be considered internal.
    void
    setIServletContext(IServletContext servletContext)
    Set the ServletContext this Filter should be associated with.
    void
    setLargeIcon(String largeIcon)
    Set the large icon
    void
    setSmallIcon(String smallIcon)
    Set the small icon

    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 com.ibm.websphere.servlet.filter.IFilterConfig

    addInitParameter, isAsyncSupported, setDescription, setDispatchMode, setDisplayName, setFilterClassLoader, setName

    Methods inherited from interface jakarta.servlet.Registration

    getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

    Methods inherited from interface jakarta.servlet.Registration.Dynamic

    setAsyncSupported

  • Method Details

    • setLargeIcon

      void setLargeIcon(String largeIcon)
      Set the large icon
      Parameters:
      largeIcon -

    • setSmallIcon

      void setSmallIcon(String smallIcon)
      Set the small icon
      Parameters:
      smallIcon -

    • getDispatchType

      jakarta.servlet.DispatcherType[] getDispatchType()
      Get the dispatch type
      Returns:

    • getFilterClassLoader

      ClassLoader getFilterClassLoader()
      Get the classloader where this Filter should be loaded from. Default is WebApp's classloader.
      Returns:

    • getFilterClassName

      String getFilterClassName()
      Get the filter class name
      Returns:

    • setIServletContext

      void setIServletContext(IServletContext servletContext)
      Set the ServletContext this Filter should be associated with.
      Parameters:
      ServletContext -

    • setInternal

      void setInternal(boolean isInternal)
      Set whether resource should be considered internal. * @return

    • isInternal

      boolean isInternal()
      Checks if resource should be considered internal.
      Returns:

    • setFilter

      void setFilter(jakarta.servlet.Filter filter)

    • setFilterClass

      void setFilterClass(Class<? extends jakarta.servlet.Filter> filterClass)

    • getFilter

      jakarta.servlet.Filter getFilter()

    • getFilterClass

      Class<? extends jakarta.servlet.Filter> getFilterClass()

    • setFilterClassName

      void setFilterClassName(String className)
      Specified by:
      setFilterClassName in interface IFilterConfig