org.seedstack.seed.web.spi

Class FilterDefinition

java.lang.Object

org.seedstack.seed.web.spi.AbstractDefinition

org.seedstack.seed.web.spi.FilterDefinition

public class FilterDefinition
extends AbstractDefinition

This class holds the full definition of a Servlet filter. It can be returned as a collection element from WebProvider.filters() to define the filters that must be registered by Seed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterDefinition.Mapping This class holds the definition of a filter mapping.

Constructor Summary

Constructors

Constructor and Description
FilterDefinition(String name, Class<? extends javax.servlet.Filter> filterClass) Creates a filter definition with the specified name and class.

Method Summary

Modifier and Type	Method and Description
void	addMappings(FilterDefinition.Mapping... mappings) Adds a mapping to this filter definition.
void	addServletMappings(FilterDefinition.Mapping... servletMappings) Adds a servlet mapping to this filter definition.
Class<? extends javax.servlet.Filter>	getFilterClass()
FilterDefinition.Mapping[]	getMappings()
int	getPriority()
FilterDefinition.Mapping[]	getServletMappings()
void	setPriority(int priority) Sets the registration priority of this filter.

Methods inherited from class org.seedstack.seed.web.spi.AbstractDefinition

addInitParameters, getInitParameters, getName, isAsyncSupported, setAsyncSupported

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterDefinition

public FilterDefinition(String name,
                        Class<? extends javax.servlet.Filter> filterClass)

Creates a filter definition with the specified name and class.

Parameters:

name - the filter name.

filterClass - the filter class.

Method Detail

getFilterClass

public Class<? extends javax.servlet.Filter> getFilterClass()

Returns:

the Servlet filter class.

getPriority

public int getPriority()

Returns:

the registration priority of this filter (SeedFilterPriority.NORMAL by default).

setPriority

public void setPriority(int priority)

Sets the registration priority of this filter. Filters are registered in the order of increasing priority.

Parameters:

priority - the absolute priority of this filter.

getMappings

public FilterDefinition.Mapping[] getMappings()

Returns:

the filter mappings.

addMappings

public void addMappings(FilterDefinition.Mapping... mappings)

Adds a mapping to this filter definition.

Parameters:

mappings - the mapping.

See Also:

FilterRegistration.addMappingForUrlPatterns(EnumSet, boolean, String...)

getServletMappings

public FilterDefinition.Mapping[] getServletMappings()

Returns:

the filter servlet mappings.

addServletMappings

public void addServletMappings(FilterDefinition.Mapping... servletMappings)

Adds a servlet mapping to this filter definition.

Parameters:

servletMappings - the servlet mapping.

See Also:

FilterRegistration.addMappingForServletNames(EnumSet, boolean, String...)