Package cloud.piranha

Class DefaultFilterEnvironment

java.lang.Object

cloud.piranha.DefaultFilterEnvironment

All Implemented Interfaces:

javax.servlet.FilterConfig, javax.servlet.FilterRegistration, javax.servlet.FilterRegistration.Dynamic, javax.servlet.Registration, javax.servlet.Registration.Dynamic

public class DefaultFilterEnvironment
extends java.lang.Object
implements javax.servlet.FilterRegistration.Dynamic, javax.servlet.FilterConfig

The default FilterEnvironment.

Author:

Manfred Riem ([email protected])

Nested Class Summary

Nested classes/interfaces inherited from interface javax.servlet.FilterRegistration

javax.servlet.FilterRegistration.Dynamic

Field Summary

Fields

Modifier and Type	Field	Description
static int	UNAVAILABLE	Defines the UNAVAILABLE constant.

Constructor Summary

Constructors

Constructor	Description
DefaultFilterEnvironment()	Constructor.
DefaultFilterEnvironment(cloud.piranha.api.WebApplication webApp, java.lang.String filterName, javax.servlet.Filter filter)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addMappingForServletNames(java.util.EnumSet<javax.servlet.DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... servletNames)	Add the mappings for the servlet names.
void	addMappingForUrlPatterns(java.util.EnumSet<javax.servlet.DispatcherType> dispatcherTypes, boolean isMatchAfter, java.lang.String... urlPatterns)	Add the mappings.
java.lang.String	getClassName()	Get the class name.
javax.servlet.Filter	getFilter()	Get the filter.
java.lang.String	getFilterName()	Get the filter name.
java.lang.String	getInitParameter(java.lang.String name)	Get the init parameter.
java.util.Enumeration<java.lang.String>	getInitParameterNames()	Get the init parameter names.
java.util.Map<java.lang.String,java.lang.String>	getInitParameters()	Get the init parameters.
java.lang.String	getName()	Get the name.
javax.servlet.ServletContext	getServletContext()	Get the servlet context.
java.util.Collection<java.lang.String>	getServletNameMappings()	Get the servlet name mappings.
java.util.Collection<java.lang.String>	getUrlPatternMappings()	Get the URL pattern mappings.
cloud.piranha.api.WebApplication	getWebApplication()	Get the web application.
void	initialize()	Initialize the filter.
void	setAsyncSupported(boolean asyncSupported)	Set async supported.
void	setClassName(java.lang.String className)	Set the class name.
void	setFilterName(java.lang.String filterName)	Set the filter name.
boolean	setInitParameter(java.lang.String name, java.lang.String value)	Set the init parameter.
java.util.Set<java.lang.String>	setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)	Set the init parameters.
void	setStatus(int status)	Set status.
void	setWebApplication(DefaultWebApplication webApplication)	Set the web application.

Methods inherited from class java.lang.Object

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

Field Detail

UNAVAILABLE

public static final int UNAVAILABLE

Defines the UNAVAILABLE constant.

See Also:

Constant Field Values

Constructor Detail

DefaultFilterEnvironment

public DefaultFilterEnvironment()

Constructor.

DefaultFilterEnvironment

public DefaultFilterEnvironment(cloud.piranha.api.WebApplication webApp,
                                java.lang.String filterName,
                                javax.servlet.Filter filter)

Constructor.

Parameters:

webApp - the web application.

filterName - the filter name.

filter - the filter.

Method Detail

addMappingForServletNames

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

Add the mappings for the servlet names.

Specified by:

addMappingForServletNames in interface javax.servlet.FilterRegistration

Parameters:

dispatcherTypes - the dispatcher types.

isMatchAfter - is a matcher after.

servletNames - the servlet names.

addMappingForUrlPatterns

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

Add the mappings.

Specified by:

addMappingForUrlPatterns in interface javax.servlet.FilterRegistration

Parameters:

dispatcherTypes - the dispatcher types.

isMatchAfter - true to call the filter this mapping applies to after declared ones, false to call it before declared ones.

urlPatterns - the url patterns.

getClassName

public java.lang.String getClassName()

Get the class name.

Specified by:

getClassName in interface javax.servlet.Registration

Returns:

the class name.

getFilter

public javax.servlet.Filter getFilter()

Get the filter.

Returns:

the filter.

getFilterName

public java.lang.String getFilterName()

Get the filter name.

Specified by:

getFilterName in interface javax.servlet.FilterConfig

Returns:

the filter name.

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

Get the init parameter.

Specified by:

getInitParameter in interface javax.servlet.FilterConfig

Specified by:

getInitParameter in interface javax.servlet.Registration

Parameters:

name - the name

Returns:

the value.

getInitParameterNames

public java.util.Enumeration<java.lang.String> getInitParameterNames()

Get the init parameter names.

Specified by:

getInitParameterNames in interface javax.servlet.FilterConfig

Returns:

the enumeration.

getInitParameters

public java.util.Map<java.lang.String,java.lang.String> getInitParameters()

Get the init parameters.

Specified by:

getInitParameters in interface javax.servlet.Registration

Returns:

the init parameters.

getName

public java.lang.String getName()

Get the name.

Specified by:

getName in interface javax.servlet.Registration

Returns:

the name.

getServletContext

public javax.servlet.ServletContext getServletContext()

Get the servlet context.

Specified by:

getServletContext in interface javax.servlet.FilterConfig

Returns:

the servlet context.

getServletNameMappings

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

Get the servlet name mappings.

Specified by:

getServletNameMappings in interface javax.servlet.FilterRegistration

Returns:

the servlet name mappings.

getUrlPatternMappings

public java.util.Collection<java.lang.String> getUrlPatternMappings()

Get the URL pattern mappings.

Specified by:

getUrlPatternMappings in interface javax.servlet.FilterRegistration

Returns:

the URL pattern mappings.

getWebApplication

public cloud.piranha.api.WebApplication getWebApplication()

Get the web application.

Returns:

the web application.

initialize

public void initialize()
                throws javax.servlet.ServletException

Initialize the filter.

Throws:

javax.servlet.ServletException - when a servlet error occurs.

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)

Set async supported.

Specified by:

setAsyncSupported in interface javax.servlet.Registration.Dynamic

Parameters:

asyncSupported - the async supported flag.

setClassName

public void setClassName(java.lang.String className)

Set the class name.

Parameters:

className - the class name.

setFilterName

public void setFilterName(java.lang.String filterName)

Set the filter name.

Parameters:

filterName - the filter name.

setInitParameter

public boolean setInitParameter(java.lang.String name,
                                java.lang.String value)

Set the init parameter.

Specified by:

setInitParameter in interface javax.servlet.Registration

Parameters:

name - the parameter name.

value - the parameter value.

Returns:

if the init parameter was set.

setInitParameters

public java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)

Set the init parameters.

Specified by:

setInitParameters in interface javax.servlet.Registration

Parameters:

initParameters - the init parameters

Returns:

the set of conflicting parameter names.

setStatus

public void setStatus(int status)

Set status.

Parameters:

status - the status.

setWebApplication

public void setWebApplication(DefaultWebApplication webApplication)

Set the web application.

Parameters:

webApplication - the web application.