FilterRegistration (Piranha - Project 20.6.0 API)

All Superinterfaces:

Registration

All Known Subinterfaces:

FilterRegistration.Dynamic

All Known Implementing Classes:

DefaultFilterEnvironment
```
public interface FilterRegistration
extends Registration
```
The FilterRegistration API.

Author:

Manfred Riem ([email protected])

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface FilterRegistration.Dynamic
The FilterRegistration.Dynamic API.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames)`	Add a mapping for servlet names.
`void`	`addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns)`	Add a mapping for URL patterns.
`Collection<String>`	`getServletNameMappings()`	Get the servlet name mappings.
`Collection<String>`	`getUrlPatternMappings()`	Get the URL pattern mappings.

Methods inherited from interface javax.servlet.Registration
getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

- Method Detail
  - addMappingForServletNames
```
void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes,
                               boolean isMatchAfter,
                               String... servletNames)
```
    Add a mapping for servlet names.
    
    Parameters:
    
    dispatcherTypes - the dispatcher types.
    
    isMatchAfter - true if it should be matched after declared filters.
    
    servletNames - the servlet names.
  - addMappingForUrlPatterns
```
void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes,
                              boolean isMatchAfter,
                              String... urlPatterns)
```
    Add a mapping for URL patterns.
    
    Parameters:
    
    dispatcherTypes - the dispatcher types.
    
    isMatchAfter - true if it should be matched after declared filters.
    
    urlPatterns - the URL patterns.
  - getServletNameMappings
```
Collection<String> getServletNameMappings()
```
    Get the servlet name mappings.
    
    Returns:
    
    the servlet name mappings.
  - getUrlPatternMappings
```
Collection<String> getUrlPatternMappings()
```
    Get the URL pattern mappings.
    
    Returns:
    
    the URL pattern mappings.