javax.servlet

Interface FilterConfig

public interface FilterConfig

configuration information for filters. Whenever a server wants to pass initialization data to a filter it creates a class which implements this interface.
The server then adds {String,String} pairs to the class, and the servlet can read these using this interface.

Since:

2.3

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFilterName() get the name of the filter.
java.lang.String	getInitParameter(java.lang.String name) get the value of this name's initparameter
java.util.Enumeration	getInitParameterNames() get the names of all the init parameters.
ServletContext	getServletContext() get the context that this filter belongs to.

Method Detail

getFilterName

java.lang.String getFilterName()

get the name of the filter. As specified in a webapp deployment descriptor for example.

Returns:

the name of the filter.

getServletContext

ServletContext getServletContext()

get the context that this filter belongs to.

Returns:

the context of the filter whose config this is

getInitParameter

java.lang.String getInitParameter(java.lang.String name)

get the value of this name's initparameter

Parameters:

name - the name of the Parameter whose value we want

Returns:

value of this parameter associated with the name or null if it doesn't exist

getInitParameterNames

java.util.Enumeration getInitParameterNames()

get the names of all the init parameters.

Returns:

all the init parameter names or an empty empty enumeration when there are no init parameters