org.ocpsoft.rewrite.servlet.config
Class Scheme

java.lang.Object
  org.ocpsoft.rewrite.config.DefaultConditionBuilder
      org.ocpsoft.rewrite.servlet.config.HttpCondition
          org.ocpsoft.rewrite.servlet.config.Scheme

All Implemented Interfaces:

Condition, ConditionBuilder, Parameterized

public class Scheme
extends HttpCondition
implements Parameterized

A Condition that inspects the value of ServletRequest.getScheme()

Author:

Lincoln Baxter, III

Method Summary

boolean	evaluateHttp(HttpServletRewrite event, EvaluationContext context)
ParameterizedPatternParser	getExpression() Get the underlying ParameterizedPatternParser for this Scheme
Set<String>	getRequiredParameterNames()
static Scheme	matches(String pattern) Create a Condition to inspect the current request scheme, comparing against the given pattern.
void	setParameterStore(ParameterStore store)
String	toString()

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

evaluate

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

and, andNot, or, orNot

Methods inherited from class java.lang.Object

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

Method Detail

matches

public static Scheme matches(String pattern)

Create a Condition to inspect the current request scheme, comparing against the given pattern.

The given pattern may be parameterized using the following format:

https
mailto
{scheme}
{scheme}-custom
...

Parameters:

pattern - ParameterizedPattern specifying the Scheme of the current Address.

See Also:

ConfigurationRuleParameterBuilder#where(String)}

evaluateHttp

public boolean evaluateHttp(HttpServletRewrite event,
                            EvaluationContext context)

Specified by:

evaluateHttp in class HttpCondition

getExpression

public ParameterizedPatternParser getExpression()

Get the underlying ParameterizedPatternParser for this Scheme

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