Tomcat 10.1.19 · jakarta.servlet.FilterRegistration · APIdia, the JavaDoc alternative

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 dispatch types to which this filter should apply dispatcherTypes, boolean Should this filter be applied after any mappings defined in the deployment descriptor (`true`) or before? isMatchAfter, String... Requests mapped to these servlets will be processed by this filter servletNames) Add a mapping for this filter to one or more named Servlets.
public void	addMappingForUrlPatterns(EnumSet<DispatcherType> The dispatch types to which this filter should apply dispatcherTypes, boolean Should this filter be applied after any mappings defined in the deployment descriptor (`true`) or before? isMatchAfter, String... The URL patterns to which this filter should be applied urlPatterns) Add a mapping for this filter to one or more URL patterns.
public Collection<String>	Returns: a Collection of the Servlet name mappings getServletNameMappings() Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.
public Collection<String>	Returns: a Collection of the URL pattern mappings getUrlPatternMappings() Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.

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

addMappingForServletNames back to summary

addMappingForServletNames	back to summary
public void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames) Add a mapping for this filter to one or more named Servlets. Parameters dispatcherTypes:EnumSet<DispatcherType> The dispatch types to which this filter should apply isMatchAfter:boolean Should this filter be applied after any mappings defined in the deployment descriptor (`true`) or before? servletNames:String[] Requests mapped to these servlets will be processed by this filter Exceptions IllegalArgumentException: if the list of servlet names is empty or null IllegalStateException: if the associated ServletContext has already been initialised

public void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... servletNames)

Add a mapping for this filter to one or more named Servlets.

Parameters

dispatcherTypes:EnumSet<DispatcherType>: The dispatch types to which this filter should apply
isMatchAfter:boolean: Should this filter be applied after any mappings defined in the deployment descriptor (true) or before?
servletNames:String[]: Requests mapped to these servlets will be processed by this filter

Exceptions

IllegalArgumentException:: if the list of servlet names is empty or null
IllegalStateException:: if the associated ServletContext has already been initialised

addMappingForUrlPatterns back to summary

addMappingForUrlPatterns	back to summary
public void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns) Add a mapping for this filter to one or more URL patterns. Parameters dispatcherTypes:EnumSet<DispatcherType> The dispatch types to which this filter should apply isMatchAfter:boolean Should this filter be applied after any mappings defined in the deployment descriptor (`true`) or before? urlPatterns:String[] The URL patterns to which this filter should be applied Exceptions IllegalArgumentException: if the list of URL patterns is empty or null IllegalStateException: if the associated ServletContext has already been initialised

public void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns)

Add a mapping for this filter to one or more URL patterns.

Parameters

dispatcherTypes:EnumSet<DispatcherType>: The dispatch types to which this filter should apply
isMatchAfter:boolean: Should this filter be applied after any mappings defined in the deployment descriptor (true) or before?
urlPatterns:String[]: The URL patterns to which this filter should be applied

Exceptions

IllegalArgumentException:: if the list of URL patterns is empty or null
IllegalStateException:: if the associated ServletContext has already been initialised

getServletNameMappings	back to summary
public Collection<String> getServletNameMappings() Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration. Returns:Collection<String> a Collection of the Servlet name mappings

getServletNameMappings

public Collection<String> getServletNameMappings()

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

getUrlPatternMappings	back to summary
public Collection<String> getUrlPatternMappings() Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration. Returns:Collection<String> a Collection of the URL pattern mappings

getUrlPatternMappings

public Collection<String> getUrlPatternMappings()

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