Package org.apache.catalina.core
Class ApplicationFilterRegistration
- java.lang.Object
- 
- org.apache.catalina.core.ApplicationFilterRegistration
 
- 
- All Implemented Interfaces:
- FilterRegistration,- FilterRegistration.Dynamic,- Registration,- Registration.Dynamic
 
 public class ApplicationFilterRegistration extends java.lang.Object implements FilterRegistration.Dynamic 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface javax.servlet.FilterRegistrationFilterRegistration.Dynamic
 - 
Nested classes/interfaces inherited from interface javax.servlet.RegistrationRegistration.Dynamic
 
- 
 - 
Constructor SummaryConstructors Constructor Description ApplicationFilterRegistration(FilterDef filterDef, Context context)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddMappingForServletNames(java.util.EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... servletNames)Add a mapping for this filter to one or more named Servlets.voidaddMappingForUrlPatterns(java.util.EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... urlPatterns)Add a mapping for this filter to one or more URL patterns.java.lang.StringgetClassName()Obtain the name of the implementation class for the Servlet.java.lang.StringgetInitParameter(java.lang.String name)Get the value of an initialisation parameter.java.util.Map<java.lang.String,java.lang.String>getInitParameters()Get the names and values of all the initialisation parameters.java.lang.StringgetName()Obtain the name of the Servlet.java.util.Collection<java.lang.String>getServletNameMappings()Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.java.util.Collection<java.lang.String>getUrlPatternMappings()Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.voidsetAsyncSupported(boolean asyncSupported)Mark this Servlet/Filter as supported asynchronous processing.booleansetInitParameter(java.lang.String name, java.lang.String value)Add an initialisation parameter if not already added.java.util.Set<java.lang.String>setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)Add multiple initialisation parameters.
 
- 
- 
- 
Method Detail- 
addMappingForServletNamespublic void addMappingForServletNames(java.util.EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... servletNames) Description copied from interface:javax.servlet.FilterRegistrationAdd a mapping for this filter to one or more named Servlets.- Specified by:
- addMappingForServletNamesin interface- FilterRegistration
- Parameters:
- dispatcherTypes- The dispatch types to which this filter should apply
- isMatchAfter- Should this filter be applied after any mappings defined in the deployment descriptor (- true) or before?
- servletNames- Requests mapped to these servlets will be processed by this filter
 
 - 
addMappingForUrlPatternspublic void addMappingForUrlPatterns(java.util.EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... urlPatterns) Description copied from interface:javax.servlet.FilterRegistrationAdd a mapping for this filter to one or more URL patterns.- Specified by:
- addMappingForUrlPatternsin interface- FilterRegistration
- Parameters:
- dispatcherTypes- The dispatch types to which this filter should apply
- isMatchAfter- Should this filter be applied after any mappings defined in the deployment descriptor (- true) or before?
- urlPatterns- The URL patterns to which this filter should be applied
 
 - 
getServletNameMappingspublic java.util.Collection<java.lang.String> getServletNameMappings() Description copied from interface:javax.servlet.FilterRegistrationGets the currently available servlet name mappings of the Filter represented by this FilterRegistration.- Specified by:
- getServletNameMappingsin interface- FilterRegistration
- Returns:
- a Collection of the Servlet name mappings
 
 - 
getUrlPatternMappingspublic java.util.Collection<java.lang.String> getUrlPatternMappings() Description copied from interface:javax.servlet.FilterRegistrationGets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.- Specified by:
- getUrlPatternMappingsin interface- FilterRegistration
- Returns:
- a Collection of the URL pattern mappings
 
 - 
getClassNamepublic java.lang.String getClassName() Description copied from interface:javax.servlet.RegistrationObtain the name of the implementation class for the Servlet.- Specified by:
- getClassNamein interface- Registration
- Returns:
- the name of the implementation class for the Servlet.
 
 - 
getInitParameterpublic java.lang.String getInitParameter(java.lang.String name) Description copied from interface:javax.servlet.RegistrationGet the value of an initialisation parameter.- Specified by:
- getInitParameterin interface- Registration
- Parameters:
- name- The initialisation parameter whose value is required
- Returns:
- The value of the named initialisation parameter
 
 - 
getInitParameterspublic java.util.Map<java.lang.String,java.lang.String> getInitParameters() Description copied from interface:javax.servlet.RegistrationGet the names and values of all the initialisation parameters.- Specified by:
- getInitParametersin interface- Registration
- Returns:
- A Map of initialisation parameter names and associated values keyed by name
 
 - 
getNamepublic java.lang.String getName() Description copied from interface:javax.servlet.RegistrationObtain the name of the Servlet.- Specified by:
- getNamein interface- Registration
- Returns:
- the name of the Servlet.
 
 - 
setInitParameterpublic boolean setInitParameter(java.lang.String name, java.lang.String value)Description copied from interface:javax.servlet.RegistrationAdd an initialisation parameter if not already added.- Specified by:
- setInitParameterin interface- Registration
- Parameters:
- name- Name of initialisation parameter
- value- Value of initialisation parameter
- Returns:
- trueif the initialisation parameter was set,- falseif the initialisation parameter was not set because an initialisation parameter of the same name already existed
 
 - 
setInitParameterspublic java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters) Description copied from interface:javax.servlet.RegistrationAdd multiple initialisation parameters. If any of the supplied initialisation parameter conflicts with an existing initialisation parameter, no updates will be performed.- Specified by:
- setInitParametersin interface- Registration
- Parameters:
- initParameters- The initialisation parameters to add
- Returns:
- The set of initialisation parameter names that conflicted with existing initialisation parameter. If there are no conflicts, this Set will be empty.
 
 - 
setAsyncSupportedpublic void setAsyncSupported(boolean asyncSupported) Description copied from interface:javax.servlet.Registration.DynamicMark this Servlet/Filter as supported asynchronous processing.- Specified by:
- setAsyncSupportedin interface- Registration.Dynamic
- Parameters:
- asyncSupported- Should this Servlet/Filter support asynchronous processing
 
 
- 
 
-