Module jakarta.servlet

Package jakarta.servlet

Interface FilterRegistration

All Superinterfaces:

Registration

All Known Subinterfaces:

FilterEnvironment, 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

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

Methods inherited from interface jakarta.servlet.Registration

getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

Method Details

addMappingForServletNames

void addMappingForServletNames(java.util.EnumSet<DispatcherType> dispatcherTypes,
boolean isMatchAfter,
java.lang.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(java.util.EnumSet<DispatcherType> dispatcherTypes,
boolean isMatchAfter,
java.lang.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

java.util.Collection<java.lang.String> getServletNameMappings()

Get the servlet name mappings.

Returns:

the servlet name mappings.

getUrlPatternMappings

java.util.Collection<java.lang.String> getUrlPatternMappings()

Get the URL pattern mappings.

Returns:

the URL pattern mappings.