Package org.apache.catalina.core
Class ApplicationFilterRegistration
java.lang.Object
org.apache.catalina.core.ApplicationFilterRegistration
- All Implemented Interfaces:
- FilterRegistration,- FilterRegistration.Dynamic,- Registration,- Registration.Dynamic
- 
Nested Class SummaryNested classes/interfaces inherited from interface jakarta.servlet.FilterRegistrationFilterRegistration.DynamicNested classes/interfaces inherited from interface jakarta.servlet.RegistrationRegistration.Dynamic
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames) Add a mapping for this filter to one or more named Servlets.voidaddMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns) Add a mapping for this filter to one or more URL patterns.Obtain the name of the implementation class for the Servlet.getInitParameter(String name) Get the value of an initialisation parameter.Get the names and values of all the initialisation parameters.getName()Obtain the name of the Servlet.Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.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(String name, String value) Add an initialisation parameter if not already added.setInitParameters(Map<String, String> initParameters) Add multiple initialisation parameters.
- 
Constructor Details- 
ApplicationFilterRegistration
 
- 
- 
Method Details- 
addMappingForServletNamespublic void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames) Description copied from interface:jakarta.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(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns) Description copied from interface:jakarta.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
 
- 
getServletNameMappingsDescription copied from interface:jakarta.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
 
- 
getUrlPatternMappingsDescription copied from interface:jakarta.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
 
- 
getClassNameDescription copied from interface:jakarta.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.
 
- 
getInitParameterDescription copied from interface:jakarta.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
 
- 
getInitParametersDescription copied from interface:jakarta.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
 
- 
getNameDescription copied from interface:jakarta.servlet.RegistrationObtain the name of the Servlet.- Specified by:
- getNamein interface- Registration
- Returns:
- the name of the Servlet.
 
- 
setInitParameterDescription copied from interface:jakarta.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
 
- 
setInitParametersDescription copied from interface:jakarta.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:jakarta.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
 
 
-