org.apache.catalina.core

Class ApplicationFilterConfig

java.lang.Object

org.apache.catalina.core.ApplicationFilterConfig

All Implemented Interfaces:

Serializable, javax.servlet.FilterConfig

public final class ApplicationFilterConfig
extends Object
implements javax.servlet.FilterConfig, Serializable

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

Version:

$Revision: 1673 $ $Date: 2011-03-12 18:58:07 +0100 (Sat, 12 Mar 2011) $

Author:

Craig R. McClanahan, Remy Maucherat

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dynamic Dynamic flag.
protected ApplicationFilterConfigFacade	facade The facade associated with this wrapper.

Constructor Summary

Constructors

Constructor and Description
ApplicationFilterConfig(Context context, FilterDef filterDef) Construct a new ApplicationFilterConfig for the specified filter definition.

Method Summary

Modifier and Type	Method and Description
boolean	addMappingForServletNames(EnumSet<javax.servlet.DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames)
boolean	addMappingForUrlPatterns(EnumSet<javax.servlet.DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns)
javax.servlet.FilterRegistration	getFacade() Get the facade FilterRegistration.
String	getFilterClass() Return the class of the filter we are configuring.
FilterDef	getFilterDef() Return the filter definition we are configured for.
javax.servlet.Filter	getFilterInstance() Return the filter instance.
String	getFilterName() Return the name of the filter we are configuring.
String	getInitParameter(String name) Return a String containing the value of the named initialization parameter, or null if the parameter does not exist.
Enumeration<String>	getInitParameterNames() Return an Enumeration of the names of the initialization parameters for this Filter.
Map<String,String>	getInitParameters()
javax.servlet.ServletContext	getServletContext() Return the ServletContext of our associated web application.
Collection<String>	getServletNameMappings()
Collection<String>	getUrlPatternMappings()
boolean	isDynamic()
void	setAsyncSupported(boolean asyncSupported)
void	setDescription(String description)
void	setDynamic(boolean dynamic)
void	setFilter(javax.servlet.Filter filter) Set the filter instance programmatically.
boolean	setInitParameter(String name, String value)
Set<String>	setInitParameters(Map<String,String> initParameters)
String	toString() Return a String representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

facade

protected ApplicationFilterConfigFacade facade

The facade associated with this wrapper.

dynamic

protected boolean dynamic

Dynamic flag.

Constructor Detail

ApplicationFilterConfig

public ApplicationFilterConfig(Context context,
                               FilterDef filterDef)

Construct a new ApplicationFilterConfig for the specified filter definition.

Parameters:

context - The context with which we are associated

filterDef - Filter definition for which a FilterConfig is to be constructed

Method Detail

getFilterName

public String getFilterName()

Return the name of the filter we are configuring.

Specified by:

getFilterName in interface javax.servlet.FilterConfig

getFilterClass

public String getFilterClass()

Return the class of the filter we are configuring.

getInitParameter

public String getInitParameter(String name)

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

Specified by:

getInitParameter in interface javax.servlet.FilterConfig

Parameters:

name - Name of the requested initialization parameter

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Return an Enumeration of the names of the initialization parameters for this Filter.

Specified by:

getInitParameterNames in interface javax.servlet.FilterConfig

getServletContext

public javax.servlet.ServletContext getServletContext()

Return the ServletContext of our associated web application.

Specified by:

getServletContext in interface javax.servlet.FilterConfig

getFacade

public javax.servlet.FilterRegistration getFacade()

Get the facade FilterRegistration.

isDynamic

public boolean isDynamic()

setDynamic

public void setDynamic(boolean dynamic)

toString

public String toString()

Return a String representation of this object.

Overrides:

toString in class Object

addMappingForServletNames

public boolean addMappingForServletNames(EnumSet<javax.servlet.DispatcherType> dispatcherTypes,
                                         boolean isMatchAfter,
                                         String... servletNames)

addMappingForUrlPatterns

public boolean addMappingForUrlPatterns(EnumSet<javax.servlet.DispatcherType> dispatcherTypes,
                                        boolean isMatchAfter,
                                        String... urlPatterns)

getServletNameMappings

public Collection<String> getServletNameMappings()

getUrlPatternMappings

public Collection<String> getUrlPatternMappings()

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)

setDescription

public void setDescription(String description)

setInitParameter

public boolean setInitParameter(String name,
                                String value)

setInitParameters

public Set<String> setInitParameters(Map<String,String> initParameters)

getInitParameters

public Map<String,String> getInitParameters()

setFilter

public void setFilter(javax.servlet.Filter filter)

Set the filter instance programmatically.

getFilterInstance

public javax.servlet.Filter getFilterInstance()

Return the filter instance.

getFilterDef

public FilterDef getFilterDef()

Return the filter definition we are configured for.