org.openmrs.module.web.filter

Class ModuleFilterMapping

java.lang.Object

org.openmrs.module.web.filter.ModuleFilterMapping

All Implemented Interfaces:

Serializable

public class ModuleFilterMapping
extends Object
implements Serializable

This class represents the mapping of a Filter to a collection of Servlets and URLs

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addServletName(String servletName) Adds a Servlet name to the List of those mapped to this filter
void	addUrlPattern(String urlPattern) Adds a Url pattern to the List of those mapped to this filter
static boolean	filterMappingPasses(ModuleFilterMapping filterMapping, String requestPath) Return true if the passed Filter passes one or more filter mappings otherwise, return false.
String	getFilterName()
Module	getModule()
List<String>	getServletNames()
List<String>	getUrlPatterns()
static Deque<ModuleFilterMapping>	retrieveFilterMappings(Module module) Static method to parse through a Module's configuration file and return a List of ModuleFilterMapping objects for which there are configuration elements.
static boolean	servletNameMatches(String patternToCheck, String servletName) Return true if the specified servlet name matches the filterMapping otherwise return false.
void	setFilterName(String filterName)
void	setModule(Module module)
void	setServletNames(List<String> servletNames)
void	setUrlPatterns(List<String> urlPatterns)
static boolean	urlPatternMatches(String patternToCheck, String requestPath) Return true if the context-relative request path matches the patternToCheck otherwise, return false.

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

ModuleFilterMapping

public ModuleFilterMapping(Module module)

Default constructor, requires a Module

Parameters:

module - - the module to use to construct this ModuleFilterMapping

Method Detail

getModule

public Module getModule()

Returns:

- the Module that registered this FilterDefinition

setModule

public void setModule(Module module)

Parameters:

module - the Module

getFilterName

public String getFilterName()

Returns:

the name of the Filter

setFilterName

public void setFilterName(String filterName)

Parameters:

filterName - the name of the Filter

getServletNames

public List<String> getServletNames()

Returns:

a List of all Servlet Names mapped to this Filter

setServletNames

public void setServletNames(List<String> servletNames)

Parameters:

servletNames - a List of all Servlet Names mapped to this filter

addServletName

public void addServletName(String servletName)

Adds a Servlet name to the List of those mapped to this filter

Parameters:

servletName - - The servlet name to add

getUrlPatterns

public List<String> getUrlPatterns()

Returns:

- a List of all Url Patterns mapped to this filter

setUrlPatterns

public void setUrlPatterns(List<String> urlPatterns)

Parameters:

urlPatterns - a List of all Url Patterns mapped to this filter

addUrlPattern

public void addUrlPattern(String urlPattern)

Adds a Url pattern to the List of those mapped to this filter

Parameters:

urlPattern - - The urlPattern to add

filterMappingPasses

public static boolean filterMappingPasses(ModuleFilterMapping filterMapping,
                                          String requestPath)

Return true if the passed Filter passes one or more filter mappings otherwise, return false.

Parameters:

filterMapping - - The ModuleFilterMapping to check for matching servlets and url patterns

requestPath - - The URI of the request to check against the ModuleFilterMapping, with the context path already removed (since module filter mappings are relative to the context path).

Returns:

- true if the given ModuleFilterMapping matches the passed requestPath For example: Passing a ModuleFilterMapping containing a urlPattern of "*" would return true for any requestPath Passing a ModuleFilterMapping containing a urlPattern of "*.jsp" would return true for any requestPath ending in ".jsp" Should return false if the requestPath is null Should return true if the ModuleFilterMapping contains any matching urlPatterns for this requestPath Should return true if the ModuleFilterMapping contains any matching servletNames for this requestPath Should return false if no matches are found for this requestPath

urlPatternMatches

public static boolean urlPatternMatches(String patternToCheck,
                                        String requestPath)

Return true if the context-relative request path matches the patternToCheck otherwise, return false.

Parameters:

patternToCheck - String pattern to check

requestPath - to check Should return false if the patternToCheck is null Should return true if the pattern is * Should return true if the pattern is /* Should return true if the pattern matches the requestPath exactly Should return true if the pattern matches everything up to a suffix of /* Should return true if the pattern matches by extension Should return false if no pattern matches

servletNameMatches

public static boolean servletNameMatches(String patternToCheck,
                                         String servletName)

Return true if the specified servlet name matches the filterMapping otherwise return false.

Parameters:

patternToCheck - String pattern to check

servletName - Servlet Name to check Should return false if the patternToCheck is null Should return true if the pattern is * Should return true if the pattern matches the servlet name exactly Should return false if no pattern matches

retrieveFilterMappings

public static Deque<ModuleFilterMapping> retrieveFilterMappings(Module module)

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

        <filter-mapping>
                <filter-name>MyFilterName</filter-name>
                <url-pattern>The pattern of URLs to match</filter-class>
        </filter-mapping>
 or
        <filter-mapping>
                <filter-name>MyFilterName</filter-name>
                <servlet-name>The servlet name to match</servlet-name>
        </filter-mapping>
 

Parameters:

module - - The Module for which you want to retrieve the defined ModuleFilterMappings

Returns:

- a Deque of ModuleFilterMappings that are defined for the passed Module