org.ocpsoft.rewrite.servlet.config

Class RequestParameter

java.lang.Object

org.ocpsoft.rewrite.config.DefaultConditionBuilder

org.ocpsoft.rewrite.servlet.config.HttpCondition

org.ocpsoft.rewrite.servlet.config.RequestParameter

All Implemented Interfaces:

Condition, ConditionBuilder, ConfigurationElement, Parameterized

Direct Known Subclasses:

RequestParameter.AllRequestParameters

public class RequestParameter
extends HttpCondition
implements Parameterized

A Condition that inspects values returned by ServletRequest.getParameterMap()

Author:

Lincoln Baxter, III

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestParameter.AllRequestParameters

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluateHttp(HttpServletRewrite event, EvaluationContext context)
static RequestParameter	exists(String name) Return a Header condition that matches only against the existence of a header with a name matching the given pattern.
ParameterizedPatternParser	getNameExpression()
Set<String>	getRequiredParameterNames()
ParameterizedPatternParser	getValueExpression()
static RequestParameter	matches(String name, String value) Return a Header condition that matches against both header name and values.
static RequestParameter	matchesAll(String name, String value)
void	setParameterStore(ParameterStore store)
String	toString()
static RequestParameter	valueExists(String value) Return a Header condition that matches only against the existence of a header with value matching the given pattern.

Methods inherited from class org.ocpsoft.rewrite.servlet.config.HttpCondition

evaluate

Methods inherited from class org.ocpsoft.rewrite.config.DefaultConditionBuilder

and, andNot, create, or, orNot, wrap

Methods inherited from class java.lang.Object

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

Method Detail

matches

public static RequestParameter matches(String name,
                       String value)

Return a Header condition that matches against both header name and values.

See also: HttpServletRequest.getHeader(String)

Parameters:

name - Regular expression matching the header name

value - Regular expression matching the header value

matchesAll

public static RequestParameter matchesAll(String name,
                          String value)

exists

public static RequestParameter exists(String name)

Return a Header condition that matches only against the existence of a header with a name matching the given pattern. The header value is ignored.

See also: HttpServletRequest.getHeader(String)

Parameters:

name - Regular expression matching the header name

valueExists

public static RequestParameter valueExists(String value)

Return a Header condition that matches only against the existence of a header with value matching the given pattern. The header name is ignored.

Parameters:

value - Regular expression matching the header value

evaluateHttp

public boolean evaluateHttp(HttpServletRewrite event,
                   EvaluationContext context)

Specified by:

evaluateHttp in class HttpCondition

getNameExpression

public ParameterizedPatternParser getNameExpression()

getValueExpression

public ParameterizedPatternParser getValueExpression()

toString

public String toString()

Overrides:

toString in class Object

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Specified by:

getRequiredParameterNames in interface Parameterized

setParameterStore

public void setParameterStore(ParameterStore store)

Specified by:

setParameterStore in interface Parameterized