org.ocpsoft.rewrite.servlet.config.rule
Class Join

java.lang.Object
  org.ocpsoft.rewrite.servlet.config.rule.Join

All Implemented Interfaces:

Condition, ConfigurationElement, Operation, Rule, Parameterized<IJoin,IJoin.JoinParameter,String>, IJoin

public class Join
extends Object
implements IJoin

Rule that creates a bi-directional rewrite rule between an externally facing URL and an internal server resource URL

Author:

Lincoln Baxter, III

Nested Class Summary

Nested classes/interfaces inherited from interface org.ocpsoft.rewrite.servlet.config.rule.IJoin

IJoin.IJoinParameter, IJoin.JoinParameter

Constructor Summary

protected

Join(String pattern, boolean requestBinding)

Method Summary

boolean	evaluate(Rewrite event, EvaluationContext context)
static Join	getCurrentJoin(javax.servlet.http.HttpServletRequest request) Retrieve the Join that was invoked on the current request; if no Join was invoked, return null.
String	getId()
ParameterizedPatternParser	getPathExpression()
ParameterizedPatternParser	getResourcexpression()
static Join	nonBindingPath(String pattern) The client-facing URL path to which this Join will apply.
static IJoin	path(String pattern) The client-facing URL path to which this Join will apply.
IJoin	perform(Operation operation) Define additional Operation instances to be performed when this rule matches successfully.
void	perform(Rewrite event, EvaluationContext context)
IJoin	to(String resource) The internal server resource (real or virtual) to be served.
String	toString()
IJoin	when(Condition condition) Define additional Condition instances that must be satisfied in order for this rule to match successfully.
IJoin.JoinParameter	where(String parameter)
IJoin.JoinParameter	where(String param, Binding binding)
IJoin	withChaining() Allow the target of this Join to invoke another Join rule.
IJoin	withId(String id) Set the ID of this Join.
IJoin	withInboundCorrection() Redirect inbound requests for the internal resource to the outward facing URL instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

Join

protected Join(String pattern,
               boolean requestBinding)

Method Detail

path

public static IJoin path(String pattern)

The client-facing URL path to which this Join will apply. Parameters of the form "{n}" will be bound by name to the request parameter map via Request.parameter(String), and subsequently used to build the outbound URL by extracting values from the query string "?n=value". To disable request parameter binding and outbound URL rewriting, instead use nonBindingPath(String)

nonBindingPath

public static Join nonBindingPath(String pattern)

The client-facing URL path to which this Join will apply. Parameters will not be bound to the request parameter map. To enable request parameter binding and outbound URL rewriting, instead use path(String).

getCurrentJoin

public static Join getCurrentJoin(javax.servlet.http.HttpServletRequest request)

Retrieve the Join that was invoked on the current request; if no Join was invoked, return null.

to

public IJoin to(String resource)

Description copied from interface: IJoin

The internal server resource (real or virtual) to be served.

Specified by:

to in interface IJoin

withInboundCorrection

public IJoin withInboundCorrection()

Description copied from interface: IJoin

Redirect inbound requests for the internal resource to the outward facing URL instead.

Specified by:

withInboundCorrection in interface IJoin

evaluate

public boolean evaluate(Rewrite event,
                        EvaluationContext context)

Specified by:

evaluate in interface Condition

Specified by:

evaluate in interface Rule

perform

public void perform(Rewrite event,
                    EvaluationContext context)

Specified by:

perform in interface Operation

Specified by:

perform in interface Rule

where

public IJoin.JoinParameter where(String parameter)

Specified by:

where in interface Parameterized<IJoin,IJoin.JoinParameter,String>

where

public IJoin.JoinParameter where(String param,
                                 Binding binding)

Specified by:

where in interface Parameterized<IJoin,IJoin.JoinParameter,String>

getId

public String getId()

Specified by:

getId in interface Rule

when

public IJoin when(Condition condition)

Description copied from interface: IJoin

Define additional Condition instances that must be satisfied in order for this rule to match successfully.

Specified by:

when in interface IJoin

perform

public IJoin perform(Operation operation)

Description copied from interface: IJoin

Define additional Operation instances to be performed when this rule matches successfully.

Specified by:

perform in interface IJoin

withId

public IJoin withId(String id)

Description copied from interface: IJoin

Set the ID of this Join.

Specified by:

withId in interface IJoin

toString

public String toString()

Overrides:

toString in class Object

withChaining

public IJoin withChaining()

Description copied from interface: IJoin

Allow the target of this Join to invoke another Join rule. By default, once a Join has been invoked, no more Join rules will be processed.

Specified by:

withChaining in interface IJoin

getPathExpression

public ParameterizedPatternParser getPathExpression()

Specified by:

getPathExpression in interface IJoin

getResourcexpression

public ParameterizedPatternParser getResourcexpression()

Specified by:

getResourcexpression in interface IJoin