Module cloud.piranha.webapp.impl

Package cloud.piranha.webapp.impl

Class DefaultFilterEnvironment

java.lang.Object

cloud.piranha.webapp.impl.DefaultFilterEnvironment

All Implemented Interfaces:

FilterEnvironment, FilterConfig, FilterRegistration, FilterRegistration.Dynamic, Registration, Registration.Dynamic

public class DefaultFilterEnvironment
extends Object
implements FilterEnvironment

The default FilterEnvironment.

Author:

Manfred Riem ([email protected])

Nested Class Summary

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

FilterRegistration.Dynamic

Nested classes/interfaces inherited from interface jakarta.servlet.Registration

Registration.Dynamic

Field Summary

Fields inherited from interface cloud.piranha.webapp.api.FilterEnvironment

UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
DefaultFilterEnvironment()	Constructor.
DefaultFilterEnvironment(WebApplication webApp, String filterName, Filter filter)	Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultFilterEnvironment

public DefaultFilterEnvironment()

Constructor.

DefaultFilterEnvironment

public DefaultFilterEnvironment(WebApplication webApp,
 String filterName,
 Filter filter)

Constructor.

Parameters:

webApp - the web application.

filterName - the filter name.

filter - the filter.

Method Details

addMappingForServletNames

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

Add the mappings for the servlet names.

Specified by:

addMappingForServletNames in interface FilterRegistration

Parameters:

dispatcherTypes - the dispatcher types.

isMatchAfter - is a matcher after.

servletNames - the servlet names.

addMappingForUrlPatterns

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

Add the mappings.

Specified by:

addMappingForUrlPatterns in interface 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 String getClassName()

Returns the class name.

Specified by:

getClassName in interface Registration

Returns:

the class name

getFilter

public Filter getFilter()

Returns the filter.

Specified by:

getFilter in interface FilterEnvironment

Returns:

the filter

getFilterName

public String getFilterName()

Returns the filter name.

Specified by:

getFilterName in interface FilterConfig

Returns:

the filter name

getInitParameter

public String getInitParameter(String name)

Get the init parameter.

Specified by:

getInitParameter in interface FilterConfig

Specified by:

getInitParameter in interface Registration

Parameters:

name - the name

Returns:

the value.

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Get the init parameter names.

Specified by:

getInitParameterNames in interface FilterConfig

Returns:

the enumeration.

getInitParameters

public Map<String,String> getInitParameters()

Returns the init parameters.

Specified by:

getInitParameters in interface Registration

Returns:

the init parameters

getName

public String getName()

Returns the name.

Specified by:

getName in interface Registration

Returns:

the name

getServletContext

public ServletContext getServletContext()

Returns the servlet context.

Specified by:

getServletContext in interface FilterConfig

Returns:

the servlet context

getServletNameMappings

public Collection<String> getServletNameMappings()

Returns the servlet name mappings.

Specified by:

getServletNameMappings in interface FilterRegistration

Returns:

the servlet name mappings

getUrlPatternMappings

public Collection<String> getUrlPatternMappings()

Returns the URL pattern mappings.

Specified by:

getUrlPatternMappings in interface FilterRegistration

Returns:

the URL pattern mappings

getWebApplication

public WebApplication getWebApplication()

Returns the web application.

Specified by:

getWebApplication in interface FilterEnvironment

Returns:

the web application

initialize

public void initialize()
                throws ServletException

Initialize the filter.

Specified by:

initialize in interface FilterEnvironment

Throws:

ServletException - when a servlet error occurs.

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)

Set async supported.

Specified by:

setAsyncSupported in interface Registration.Dynamic

Parameters:

asyncSupported - the async supported flag.

setClassName

public void setClassName(String className)

Set the class name.

Specified by:

setClassName in interface FilterEnvironment

Parameters:

className - the class name.

setFilterName

public void setFilterName(String filterName)

Set the filter name.

Specified by:

setFilterName in interface FilterEnvironment

Parameters:

filterName - the filter name.

setInitParameter

public boolean setInitParameter(String name,
 String value)

Set the init parameter.

Specified by:

setInitParameter in interface Registration

Parameters:

name - the parameter name.

value - the parameter value.

Returns:

if the init parameter was set.

setInitParameters

public Set<String> setInitParameters(Map<String,String> initParameters)

Set the init parameters.

Specified by:

setInitParameters in interface Registration

Parameters:

initParameters - the init parameters

Returns:

the set of conflicting parameter names.

setStatus

public void setStatus(int status)

Set status.

Specified by:

setStatus in interface FilterEnvironment

Parameters:

status - the status.

setWebApplication

public void setWebApplication(WebApplication webApplication)

Description copied from interface: FilterEnvironment

Set the web application.

Specified by:

setWebApplication in interface FilterEnvironment

Parameters:

webApplication - the web application.

isAsyncSupported

public boolean isAsyncSupported()

Description copied from interface: FilterEnvironment

Is async supported.

Specified by:

isAsyncSupported in interface FilterEnvironment

Returns:

true if it is, false otherwise.

toString

public String toString()

Overrides:

toString in class Object