org.openmrs.module.web.filter

Class ModuleFilterConfig

java.lang.Object

org.openmrs.module.web.filter.ModuleFilterConfig

All Implemented Interfaces:

javax.servlet.FilterConfig

public class ModuleFilterConfig
extends Object
implements javax.servlet.FilterConfig

This class is an implementation of FilterConfig for use in instantiating Filters from Modules

Method Summary

Modifier and Type	Method and Description
ModuleFilterDefinition	getFilterDefinition()
String	getFilterName()
String	getInitParameter(String paramName)
Enumeration<String>	getInitParameterNames()
static ModuleFilterConfig	getInstance(ModuleFilterDefinition filterDefinition, javax.servlet.ServletContext servletContext) Factory method to construct and return a ModuleFilterConfig
javax.servlet.ServletContext	getServletContext()
void	setFilterDefinition(ModuleFilterDefinition filterDefinition)
void	setServletContext(javax.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ModuleFilterConfig getInstance(ModuleFilterDefinition filterDefinition,
                                             javax.servlet.ServletContext servletContext)

Factory method to construct and return a ModuleFilterConfig

Parameters:

filterDefinition - The ModuleFilterDefinition to store in this ModuleFilterConfig

servletContext - The ServletContext to store in this ModuleFilterConfig

Returns:

The ModuleFilterConfig that is fully initialized with the passed parameters

getFilterName

public String getFilterName()

Specified by:

getFilterName in interface javax.servlet.FilterConfig

See Also:

FilterConfig.getFilterName()

getInitParameter

public String getInitParameter(String paramName)

Specified by:

getInitParameter in interface javax.servlet.FilterConfig

See Also:

FilterConfig.getInitParameter(java.lang.String)

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.FilterConfig

See Also:

FilterConfig.getInitParameterNames()

getFilterDefinition

public ModuleFilterDefinition getFilterDefinition()

setFilterDefinition

public void setFilterDefinition(ModuleFilterDefinition filterDefinition)

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.FilterConfig

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)