javax.servlet

Interface FilterRegistration

All Superinterfaces:

Registration

All Known Subinterfaces:

FilterRegistration.Dynamic

public interface FilterRegistration
extends Registration

Interface for configuring filters.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilterRegistration.Dynamic Dynamic registration support.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMappingForServletNames(java.util.EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... servletNames) Add a filter mapping with the given servlet names and dispatcher types.
void	addMappingForUrlPatterns(java.util.EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... urlPatterns) Add a filter mapping with the given url patterns and dispatcher types.
java.util.Collection<java.lang.String>	getServletNameMappings() Returns the servlet name mappings of the associated filter.
java.util.Collection	getUrlPatternMappings() Returns the url pattern mappings of the associated filter.

Methods inherited from interface javax.servlet.Registration

getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

Method Detail

addMappingForServletNames

void addMappingForServletNames(java.util.EnumSet<DispatcherType> dispatcherTypes,
                             boolean isMatchAfter,
                             java.lang.String... servletNames)

Add a filter mapping with the given servlet names and dispatcher types.

Parameters:

dispatcherTypes - filter mapping dispatcher types, or null to use DispatcherType.REQUEST

isMatchAfter - true to match this filter mapping after declared ones in the servlet context, false to match it before

servletNames - the servlet names in the mapping

Throws:

java.lang.IllegalArgumentException - if servletNames is null or empty

java.lang.IllegalStateException - if the context is already initialized

getServletNameMappings

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

Returns the servlet name mappings of the associated filter.

addMappingForUrlPatterns

void addMappingForUrlPatterns(java.util.EnumSet<DispatcherType> dispatcherTypes,
                            boolean isMatchAfter,
                            java.lang.String... urlPatterns)

Add a filter mapping with the given url patterns and dispatcher types.

Parameters:

dispatcherTypes - filter mapping dispatcher types, or null to use DispatcherType.REQUEST

isMatchAfter - true to match this filter mapping after declared ones in the servlet context, false to match it before

urlPatterns - the url patterns in the mapping

Throws:

java.lang.IllegalArgumentException - if urlPatterns is null or empty

java.lang.IllegalStateException - if the context is already initialized

getUrlPatternMappings

java.util.Collection getUrlPatternMappings()

Returns the url pattern mappings of the associated filter.