ApplicationFilterRegistration (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.catalina.core.ApplicationFilterRegistration

All Implemented Interfaces:

FilterRegistration, FilterRegistration.Dynamic, Registration, Registration.Dynamic
```
public class ApplicationFilterRegistration
extends Object
implements FilterRegistration.Dynamic
```

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.servlet.FilterRegistration
  FilterRegistration.Dynamic

Constructor Summary

Constructors
Constructor and Description

ApplicationFilterRegistration(FilterDef filterDef, Context context)

Constructors
Constructor and Description
`ApplicationFilterRegistration(FilterDef filterDef, Context context)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames)` Add a mapping for this filter to one or more named Servlets.
`void`	`addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns)` Add a mapping for this filter to one or more URL patterns.
`String`	`getClassName()`
`String`	`getInitParameter(String name)` Get the value of an initialisation parameter.
`Map<String,String>`	`getInitParameters()` Get the names and values of all the initialisation parameters.
`String`	`getName()`
`Collection<String>`	`getServletNameMappings()`
`Collection<String>`	`getUrlPatternMappings()`
`void`	`setAsyncSupported(boolean asyncSupported)` Mark this Servlet/Filter as supported asynchronous processing.
`boolean`	`setInitParameter(String name, String value)` Add an initialisation parameter if not already added.
`Set<String>`	`setInitParameters(Map<String,String> initParameters)` Add multiple initialisation parameters.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApplicationFilterRegistration
```
public ApplicationFilterRegistration(FilterDef filterDef,
                             Context context)
```
- Method Detail
  - addMappingForServletNames
```
public void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes,
                             boolean isMatchAfter,
                             String... servletNames)
```
    Description copied from interface: javax.servlet.FilterRegistration
    
    Add a mapping for this filter to one or more named Servlets.
    
    Specified by:
    
    addMappingForServletNames in 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
  - addMappingForUrlPatterns
```
public void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes,
                            boolean isMatchAfter,
                            String... urlPatterns)
```
    Description copied from interface: javax.servlet.FilterRegistration
    
    Add a mapping for this filter to one or more URL patterns.
    
    Specified by:
    
    addMappingForUrlPatterns in 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
  - getServletNameMappings
```
public Collection<String> getServletNameMappings()
```
    Specified by:
    
    getServletNameMappings in interface FilterRegistration
    
    Returns:
    TODO
  - getUrlPatternMappings
```
public Collection<String> getUrlPatternMappings()
```
    Specified by:
    
    getUrlPatternMappings in interface FilterRegistration
    
    Returns:
    TODO
  - getClassName
```
public String getClassName()
```
    Specified by:
    
    getClassName in interface Registration
  - getInitParameter
```
public String getInitParameter(String name)
```
    Description copied from interface: javax.servlet.Registration
    
    Get the value of an initialisation parameter.
    
    Specified by:
    
    getInitParameter in interface Registration
    
    Parameters:
    name - The initialisation parameter whose value is required
    
    Returns:
    The value of the named initialisation parameter
  - getInitParameters
```
public Map<String,String> getInitParameters()
```
    Description copied from interface: javax.servlet.Registration
    
    Get the names and values of all the initialisation parameters.
    
    Specified by:
    
    getInitParameters in interface Registration
    
    Returns:
    A Map of initialisation parameter names and associated values keyed by name
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Registration
  - setInitParameter
```
public boolean setInitParameter(String name,
                       String value)
```
    Description copied from interface: javax.servlet.Registration
    
    Add an initialisation parameter if not already added.
    
    Specified by:
    
    setInitParameter in interface Registration
    
    Parameters:
    name - Name of initialisation parameter
    value - Value of initialisation parameter
    
    Returns:
    true if the initialisation parameter was set, false if the initialisation parameter was not set because an initialisation parameter of the same name already existed
  - setInitParameters
```
public Set<String> setInitParameters(Map<String,String> initParameters)
```
    Description copied from interface: javax.servlet.Registration
    
    Add multiple initialisation parameters. If any of the supplied initialisation parameter conflicts with an existing initialisation parameter, no updates will be performed.
    
    Specified by:
    
    setInitParameters in 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.
  - setAsyncSupported
```
public void setAsyncSupported(boolean asyncSupported)
```
    Description copied from interface: javax.servlet.Registration.Dynamic
    
    Mark this Servlet/Filter as supported asynchronous processing.
    
    Specified by:
    
    setAsyncSupported in interface Registration.Dynamic
    
    Parameters:
    asyncSupported - Should this Servlet/Filter support asynchronous processing

Class ApplicationFilterRegistration

Nested Class Summary

Nested classes/interfaces inherited from interface javax.servlet.FilterRegistration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApplicationFilterRegistration

Method Detail

addMappingForServletNames

addMappingForUrlPatterns

getServletNameMappings

getUrlPatternMappings

getClassName

getInitParameter

getInitParameters

getName

setInitParameter

setInitParameters

setAsyncSupported