JavaEE API 8.0.1 · javax.servlet.FilterRegistration

Modifier and Type	Class and Description
public static interface	FilterRegistration.Dynamic Interface through which a `Filter` registered via one of the `addFilter` methods on `ServletContext` may be further configured.

Method Summary

Modifier and Type	Method and Description
public void	addMappingForServletNames(EnumSet<DispatcherType> the dispatcher types of the filter mapping, or null if the default `DispatcherType.REQUEST` is to be used dispatcherTypes, boolean 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 obtained isMatchAfter, String... the servlet names of the filter mapping servletNames) Adds a filter mapping with the given servlet names and dispatcher types for the Filter represented by this FilterRegistration.
public void	addMappingForUrlPatterns(EnumSet<DispatcherType> the dispatcher types of the filter mapping, or null if the default `DispatcherType.REQUEST` is to be used dispatcherTypes, boolean 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 obtained isMatchAfter, String... the url patterns of the filter mapping urlPatterns) Adds a filter mapping with the given url patterns and dispatcher types for the Filter represented by this FilterRegistration.
public Collection<String>	Returns: a (possibly empty) `Collection` of the currently available servlet name mappings of the Filter represented by this `FilterRegistration` getServletNameMappings() Gets the currently available servlet name mappings of the Filter represented by this `FilterRegistration`.
public Collection<String>	Returns: a (possibly empty) `Collection` of the currently available URL pattern mappings of the Filter represented by this `FilterRegistration` getUrlPatternMappings() Gets the currently available URL pattern mappings of the Filter represented by this `FilterRegistration`.

Inherited from javax.servlet.Registration:: getClassName getInitParameter getInitParameters getName setInitParameter setInitParameters

Method Detail

addMappingForServletNames back to summary

addMappingForServletNames	back to summary
public 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. 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. Parameters dispatcherTypes:EnumSet<DispatcherType> the dispatcher types of the filter mapping, or null if the default `DispatcherType.REQUEST` is to be used isMatchAfter:boolean 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 obtained servletNames:String[] the servlet names of the filter mapping Exceptions IllegalArgumentException: if `servletNames` is null or empty IllegalStateException: if the ServletContext from which this FilterRegistration was obtained has already been initialized

public 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.

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.

Parameters

dispatcherTypes:EnumSet<DispatcherType>: the dispatcher types of the filter mapping, or null if the default DispatcherType.REQUEST is to be used
isMatchAfter:boolean: 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 obtained
servletNames:String[]: the servlet names of the filter mapping

Exceptions

IllegalArgumentException:: if servletNames is null or empty
IllegalStateException:: if the ServletContext from which this FilterRegistration was obtained has already been initialized

addMappingForUrlPatterns back to summary

addMappingForUrlPatterns	back to summary
public 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. 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. Parameters dispatcherTypes:EnumSet<DispatcherType> the dispatcher types of the filter mapping, or null if the default `DispatcherType.REQUEST` is to be used isMatchAfter:boolean 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 obtained urlPatterns:String[] the url patterns of the filter mapping Exceptions IllegalArgumentException: if `urlPatterns` is null or empty IllegalStateException: if the ServletContext from which this FilterRegistration was obtained has already been initialized

public 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.

Filter mappings are matched in the order in which they were added.

If this method is called multiple times, each successive call adds to the effects of the former.

Parameters

dispatcherTypes:EnumSet<DispatcherType>: the dispatcher types of the filter mapping, or null if the default DispatcherType.REQUEST is to be used
isMatchAfter:boolean: 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 obtained
urlPatterns:String[]: the url patterns of the filter mapping

Exceptions

IllegalArgumentException:: if urlPatterns is null or empty
IllegalStateException:: if the ServletContext from which this FilterRegistration was obtained has already been initialized

getServletNameMappings back to summary

getServletNameMappings	back to summary
public Collection<String> getServletNameMappings() Gets the currently available servlet name mappings of the Filter represented by this `FilterRegistration`. If permitted, any changes to the returned `Collection` must not affect this `FilterRegistration`. Returns:Collection<String> a (possibly empty) `Collection` of the currently available servlet name mappings of the Filter represented by this `FilterRegistration`

public Collection<String> getServletNameMappings()

Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.

If permitted, any changes to the returned Collection must not affect this FilterRegistration.

Returns:Collection<String>: a (possibly empty) Collection of the currently available servlet name mappings of the Filter represented by this FilterRegistration

getUrlPatternMappings back to summary

getUrlPatternMappings	back to summary
public Collection<String> getUrlPatternMappings() Gets the currently available URL pattern mappings of the Filter represented by this `FilterRegistration`. If permitted, any changes to the returned `Collection` must not affect this `FilterRegistration`. Returns:Collection<String> a (possibly empty) `Collection` of the currently available URL pattern mappings of the Filter represented by this `FilterRegistration`

public Collection<String> getUrlPatternMappings()

Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.

If permitted, any changes to the returned Collection must not affect this FilterRegistration.

Returns:Collection<String>: a (possibly empty) Collection of the currently available URL pattern mappings of the Filter represented by this FilterRegistration

public Interface FilterRegistration

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface FilterRegistration.Dynamic

Method Summary