FilterConfig (Servlet 6.1 API Documentation - Apache Tomcat 11.0.24)
Description: declaration: package: jakarta.servlet, interface: FilterConfig

# Interface FilterConfig

All Known Implementing Classes:
  `GenericFilter, HttpFilter`

public interface FilterConfig
A filter configuration object used by a servlet container to pass information to a filter during initialization.

Since:
  Servlet 2.3
See Also:
  - `Filter`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getFilterName()`
  Get the name of the filter.
  `String`
  `getInitParameter(String name)`
  Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
  `Enumeration<String>`
  `getInitParameterNames()`
  Returns the names of the filter's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the filter has no initialization parameters.
  `ServletContext`
  `getServletContext()`
  Returns a reference to the `ServletContext` in which the caller is executing.

- ## Method Details

  - ### getFilterName

    String getFilterName()
    Get the name of the filter.
    Returns:
      The filter-name of this filter as defined in the deployment descriptor.

  - ### getServletContext

    ServletContext getServletContext()
    Returns a reference to the `ServletContext` in which the caller is executing.
    Returns:
      `ServletContext` object, used by the caller to interact with its servlet container
    See Also:
      - `ServletContext`

  - ### getInitParameter

    String getInitParameter(String name)
    Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
    Parameters:
      `name` - `String` specifying the name of the initialization parameter
    Returns:
      `String` containing the value of the initialization parameter

  - ### getInitParameterNames

    Enumeration<String> getInitParameterNames()
    Returns the names of the filter's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the filter has no initialization parameters.
    Returns:
      `Enumeration` of `String` objects containing the names of the filter's initialization parameters