vodserver.parambuilder

Class AbstractContentRegExParamBuilder

java.lang.Object

vodserver.util.BaseBeanNameAware

vodserver.parambuilder.AbstractParamBuilder

vodserver.parambuilder.AbstractContentRegExParamBuilder

All Implemented Interfaces:

Comparable<ParamBuilder>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.core.Ordered, ParamBuilder

Direct Known Subclasses:

ContentDynamicRegExParamBuilder, ContentRegExParamBuilder

public abstract class AbstractContentRegExParamBuilder
extends AbstractParamBuilder

This is an abstract base class for ParamBuilder implementations that use regular expressions to extract parameters from some content. The content needs to be defined by a ParamBuilder earlier in the chain; it will be retrieved using the parameter name as specified by the contentParam property.

Regular expressions need to contain one or more group names; these group names will be mapped to parameter names. As an example, suppose the regular expression is 'abc(?<myParam>.+?)xyz'. For content containing 'abcMYVALUExyz', this ParamBuilder would add a parameter named 'myParam' with the value 'MYVALUE'.

Subclasses need to return a collection of patterns by implementing the getPatterns(Map, HttpServletRequest) method. They can optionally override the getGroupNames(Pattern) method, for example if they have already determined the group names.

Author:

Ruud Senden

Field Summary

Fields

Modifier and Type	Field and Description
protected String	contentParam

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractContentRegExParamBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addRegExValues(String content, Map<String,String> params, Pattern pattern) Match the given pattern against the given content, and add all matches to the given parameters map.
void	buildParams(Map<String,String> params, javax.servlet.http.HttpServletRequest request) Build the parameters.
String	getContentParam() Get the parameter name from which content will be retrieved.
protected Set<String>	getGroupNames(Pattern pattern) Get the group names for the given pattern.
protected abstract Collection<Pattern>	getPatterns(Map<String,String> params, javax.servlet.http.HttpServletRequest request) Implementing classes must implement this method to return a collection of regular expressions to be used to match against the content.
void	setContentParam(String contentParam) Set the parameter name from which content will be retrieved.

Methods inherited from class vodserver.parambuilder.AbstractParamBuilder

afterPropertiesSet, compareTo, extraAfterPropertiesSet, getOrder, setOrder

Methods inherited from class vodserver.util.BaseBeanNameAware

getBeanName, setBeanName

Methods inherited from class java.lang.Object

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

Field Detail

contentParam

protected String contentParam

Constructor Detail

AbstractContentRegExParamBuilder

public AbstractContentRegExParamBuilder()

Method Detail

buildParams

public void buildParams(Map<String,String> params,
               javax.servlet.http.HttpServletRequest request)

Build the parameters. This will iterate over the patterns returned by the getPatterns(Map, HttpServletRequest) method, match those patterns with the content specified by contentParam, and add all matched groups to the parameters map.

Parameters:

params - The parameters map to which parameters can be added or existing parameters can be retrieved.

request - The original request, useful to retrieve request parameters for example.

getContentParam

public String getContentParam()

Get the parameter name from which content will be retrieved.

Returns:

setContentParam

public void setContentParam(String contentParam)

Set the parameter name from which content will be retrieved.

Parameters:

contentParam -

addRegExValues

protected void addRegExValues(String content,
                  Map<String,String> params,
                  Pattern pattern)

Match the given pattern against the given content, and add all matches to the given parameters map.

Parameters:

content -

params -

pattern -

getGroupNames

protected Set<String> getGroupNames(Pattern pattern)

Get the group names for the given pattern. The default implementation will parse the regular expression to find the group names. For performance reasons, implementations can override this method if they can determine the group names on initialization.

Parameters:

pattern -

Returns:

getPatterns

protected abstract Collection<Pattern> getPatterns(Map<String,String> params,
                              javax.servlet.http.HttpServletRequest request)

Implementing classes must implement this method to return a collection of regular expressions to be used to match against the content. Usually implementations will either return a fixed list of regular expressions (in which case they would also override getGroupNames(Pattern)), or dynamically determine the regular expressions to use based on the given parameter map and/or request.

Parameters:

params -

request -

Returns: