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:
-
Method Summary
Modifier and TypeMethodDescriptionGet the name of the filter.getInitParameter(String name) Returns aStringcontaining the value of the named initialization parameter, ornullif the parameter does not exist.Returns the names of the filter's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the filter has no initialization parameters.Returns a reference to theServletContextin 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 theServletContextin which the caller is executing.- Returns:
ServletContextobject, used by the caller to interact with its servlet container- See Also:
-
getInitParameter
Returns aStringcontaining the value of the named initialization parameter, ornullif the parameter does not exist.- Parameters:
name-Stringspecifying the name of the initialization parameter- Returns:
Stringcontaining the value of the initialization parameter
-
getInitParameterNames
Enumeration<String> getInitParameterNames()Returns the names of the filter's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the filter has no initialization parameters.- Returns:
EnumerationofStringobjects containing the names of the filter's initialization parameters
-