public interface FilterRegistration extends Registration
Filter
may be further configured.Modifier and Type | Interface and Description |
---|---|
static interface |
FilterRegistration.Dynamic
Interface through which a
Filter registered via one of the
addFilter methods on ServletContext may be further
configured. |
Modifier and Type | Method and Description |
---|---|
void |
addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes,
boolean isMatchAfter,
String... servletNames)
Adds a filter mapping with the given servlet names and dispatcher
types for the Filter represented by this FilterRegistration.
|
void |
addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes,
boolean isMatchAfter,
String... urlPatterns)
Adds a filter mapping with the given url patterns and dispatcher
types for the Filter represented by this FilterRegistration.
|
Collection<String> |
getServletNameMappings()
Gets the currently available servlet name mappings
of the Filter represented by this
FilterRegistration . |
Collection<String> |
getUrlPatternMappings()
Gets the currently available URL pattern mappings of the Filter
represented by this
FilterRegistration . |
getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters
void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames)
Filter mappings are matched in the order in which they were added.
Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained.
If this method is called multiple times, each successive call adds to the effects of the former.
dispatcherTypes
- the dispatcher types of the filter mapping,
or null if the default DispatcherType.REQUEST is to be usedisMatchAfter
- true if the given filter mapping should be matched
after any declared filter mappings, and false if it is supposed to
be matched before any declared filter mappings of the ServletContext
from which this FilterRegistration was obtainedservletNames
- the servlet names of the filter mappingIllegalArgumentException
- if servletNames is null or
emptyIllegalStateException
- if the ServletContext from which this
FilterRegistration was obtained has already been initializedCollection<String> getServletNameMappings()
FilterRegistration
.
If permitted, any changes to the returned Collection
must not
affect this FilterRegistration
.
Collection
of the currently
available servlet name mappings of the Filter represented by this
FilterRegistration
void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns)
Filter mappings are matched in the order in which they were added.
Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained.
If this method is called multiple times, each successive call adds to the effects of the former.
dispatcherTypes
- the dispatcher types of the filter mapping,
or null if the default DispatcherType.REQUEST is to be usedisMatchAfter
- true if the given filter mapping should be matched
after any declared filter mappings, and false if it is supposed to
be matched before any declared filter mappings of the ServletContext
from which this FilterRegistration was obtainedurlPatterns
- the url patterns of the filter mappingIllegalArgumentException
- if urlPatterns is null or
emptyIllegalStateException
- if the ServletContext from which this
FilterRegistration was obtained has already been initializedCollection<String> getUrlPatternMappings()
FilterRegistration
.
If permitted, any changes to the returned Collection
must not
affect this FilterRegistration
.
Collection
of the currently
available URL pattern mappings of the Filter represented by this
FilterRegistration
Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.