org.ocpsoft.rewrite.servlet.config

Class Substitute

java.lang.Object

org.ocpsoft.rewrite.config.DefaultOperationBuilder

org.ocpsoft.rewrite.servlet.config.HttpOperation

org.ocpsoft.rewrite.servlet.config.Substitute

All Implemented Interfaces:

Operation, OperationBuilder, Parameterized

public abstract class Substitute
extends HttpOperation
implements Parameterized

An Operation responsible for substituting an inbound or outbound Address with a replacement. For InboundRewrite events, this calls InboundServletRewrite.forward(String), and for OutboundRewrite events, this calls HttpOutboundServletRewrite#setOutboundAddress(String)

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
ParameterizedPatternParser	getExpression() Get the underlying ParameterizedPatternParser for this Substitute.
Set<String>	getRequiredParameterNames()
void	performHttp(HttpServletRewrite event, EvaluationContext context)
void	setParameterStore(ParameterStore store)
static Substitute	with(String location) Substitute the current Address with the given location.

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

perform

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

and

Methods inherited from class java.lang.Object

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

Method Detail

with

public static Substitute with(String location)

Substitute the current Address with the given location.

The given location may be parameterized:

INBOUND:
/example/{param}.html
/css/{value}.css
...

OUTBOUND:
www.example.com/path/file.html
www.example.com/path/{resource}.html
...

Parameters:

location - ParameterizedPattern specifying the new Address.

See Also:

ConfigurationRuleParameterBuilder#where(String)}

performHttp

public void performHttp(HttpServletRewrite event,
                        EvaluationContext context)

Specified by:

performHttp in class HttpOperation

getExpression

public ParameterizedPatternParser getExpression()

Get the underlying ParameterizedPatternParser for this Substitute.

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Specified by:

getRequiredParameterNames in interface Parameterized

setParameterStore

public void setParameterStore(ParameterStore store)

Specified by:

setParameterStore in interface Parameterized