org.openmrs.module.web.filter

Class ModuleFilterDefinition

java.lang.Object

org.openmrs.module.web.filter.ModuleFilterDefinition

All Implemented Interfaces:

Serializable

public class ModuleFilterDefinition
extends Object
implements Serializable

This class captures all of the information needed to create and initialize a Filter included in a Module. This object is initialized from an xml element that has the following syntax. Expected XML Format:

        <filter>
                <filter-name>MyFilterName</filter-name>
                <filter-class>Fully qualified classname of the Filter class</filter-class>
                <init-param>
                        <param-name>filterParameterName1</param-name>
                        <param-value>filterParameterValue1</param-value>
                </init-param>
        </filter>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ModuleFilterDefinition(Module module) Default constructor, requires a Module

Method Summary

Modifier and Type	Method and Description
void	addInitParameter(String parameterName, String parameterValue) Adds a Parameter that should be passed in to initialize this Filter
String	getFilterClass()
String	getFilterName()
Map<String,String>	getInitParameters()
Module	getModule()
static List<ModuleFilterDefinition>	retrieveFilterDefinitions(Module module) Static method to parse through a Module's configuration file and return a List of ModuleFilterDefinition objects for which there are configuration elements.
void	setFilterClass(String filterClass)
void	setFilterName(String filterName)
void	setInitParameters(Map<String,String> initParameters) #param - A map of parameters to use to initialize the filter
void	setModule(Module module)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ModuleFilterDefinition

public ModuleFilterDefinition(Module module)

Default constructor, requires a Module

Parameters:

module - - The Module to use to construct this ModuleFilterDefinition

Method Detail

getModule

public Module getModule()

Returns:

- The Module that registered this FilterDefinition

setModule

public void setModule(Module module)

Parameters:

the - Module to set

getFilterName

public String getFilterName()

Returns:

- the name of the Filter

setFilterName

public void setFilterName(String filterName)

Parameters:

- - the name of the filter

getFilterClass

public String getFilterClass()

setFilterClass

public void setFilterClass(String filterClass)

Parameters:

- - the class name of the filter

getInitParameters

public Map<String,String> getInitParameters()

Returns:

- A map of parameters to use to initialize the filter

setInitParameters

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

#param - A map of parameters to use to initialize the filter

addInitParameter

public void addInitParameter(String parameterName,
                             String parameterValue)

Adds a Parameter that should be passed in to initialize this Filter

Parameters:

parameterName - - The name of the parameter

parameterValue - - The value of the parameter

retrieveFilterDefinitions

public static List<ModuleFilterDefinition> retrieveFilterDefinitions(Module module)
                                                              throws ModuleException

Static method to parse through a Module's configuration file and return a List of ModuleFilterDefinition objects for which there are configuration elements. Expected XML Format:

        <filter>
                <filter-name>MyFilterName</filter-name>
                <filter-class>Fully qualified classname of the Filter class</filter-class>
                <init-param>
                        <param-name>filterParameterName1</param-name>
                        <param-value>filterParameterValue1</param-value>
                </init-param>
        </filter>
 

Parameters:

module - - The Module for which to retrieve filter the defined ModuleFilterDefinitions

Returns:

List of ModuleFilterDefinitions that have been defined for the passed Module

Throws:

ModuleException