Package org.apache.catalina.core

Class ApplicationFilterConfig

java.lang.Object

org.apache.catalina.core.ApplicationFilterConfig

All Implemented Interfaces:

FilterConfig, Serializable

public final class ApplicationFilterConfig
extends Object
implements FilterConfig, Serializable

Implementation of a jakarta.servlet.FilterConfig useful in managing the filter instances instantiated when a web application is first started.

Author:

Craig R. McClanahan

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
String	getFilterClass()
Map<String,String>	getFilterInitParameterMap()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getFilterName

public String getFilterName()

Description copied from interface: jakarta.servlet.FilterConfig

Get the name of the filter.

Specified by:

getFilterName in interface FilterConfig

Returns:

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

getFilterClass

public String getFilterClass()

Returns:

The class of the filter we are configuring.

getInitParameter

public String getInitParameter(String name)

Description copied from interface: jakarta.servlet.FilterConfig

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

Specified by:

getInitParameter in interface FilterConfig

Parameters:

name - String specifying the name of the initialization parameter

Returns:

String containing the value of the initialization parameter

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Description copied from interface: jakarta.servlet.FilterConfig

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.

Specified by:

getInitParameterNames in interface FilterConfig

Returns:

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

getServletContext

public ServletContext getServletContext()

Description copied from interface: jakarta.servlet.FilterConfig

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

Specified by:

getServletContext in interface FilterConfig

Returns:

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

See Also:

• ServletContext

toString

public String toString()

Overrides:

toString in class Object

getFilterInitParameterMap

public Map<String,String> getFilterInitParameterMap()