Top Description Methods
jakarta.servlet

public Interface FilterConfig

Known Direct Implementers
jakarta.servlet.GenericFilter, org.apache.catalina.core.ApplicationFilterConfig
Imports
java.util.Enumeration
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 TypeMethod and Description
public String

Returns:

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

Get the name of the filter.

public String

Returns:

String containing the value of the initialization parameter
getInitParameter(String
String specifying the name of the initialization parameter
name)

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

public Enumeration<String>

Returns:

Enumeration of String objects containing the names of the filter's initialization parameters
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.

public ServletContext

Returns:

ServletContext object, used by the caller to interact with its servlet container
getServletContext()

Returns a reference to the ServletContext in which the caller is executing.

Method Detail

getFilterNameback to summary
public String getFilterName()

Get the name of the filter.

Returns:String

The filter-name of this filter as defined in the deployment descriptor.

getInitParameterback to summary
public 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

String specifying the name of the initialization parameter

Returns:String

String containing the value of the initialization parameter

getInitParameterNamesback to summary
public 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<String>

Enumeration of String objects containing the names of the filter's initialization parameters

getServletContextback to summary
public ServletContext getServletContext()

Returns a reference to the ServletContext in which the caller is executing.

Returns:ServletContext

ServletContext object, used by the caller to interact with its servlet container

See Also
ServletContext