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

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

All Implemented Interfaces:

Rule, Parameterized<Join.JoinParameterBuilder,java.lang.String>

public class Join
extends java.lang.Object
implements Rule, Parameterized<Join.JoinParameterBuilder,java.lang.String>

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

class

Join.JoinParameterBuilder Builder for Join specific Parameter

Constructor Summary

protected

Join(java.lang.String pattern)

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.
java.lang.String	getId()
static Join	path(java.lang.String pattern) The outward facing URL path to which this Join will apply.
Join	perform(Operation operation)
void	perform(Rewrite event, EvaluationContext context)
Join	to(java.lang.String resource) The internal server resource (real or virtual) to be served.
java.lang.String	toString()
Join	when(Condition condition)
Join.JoinParameterBuilder	where(java.lang.String parameter)
Join.JoinParameterBuilder	where(java.lang.String param, Binding binding)
Join.JoinParameterBuilder	where(java.lang.String param, java.lang.String pattern)
Join.JoinParameterBuilder	where(java.lang.String param, java.lang.String pattern, Binding binding)
Join	withId(java.lang.String id) Set the ID of this Join.
Join	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(java.lang.String pattern)

Method Detail

path

public static Join path(java.lang.String pattern)

The outward facing URL path to which this Join will apply.

to

public Join to(java.lang.String resource)

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

withInboundCorrection

public Join withInboundCorrection()

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

evaluate

public boolean evaluate(Rewrite event,
                        EvaluationContext context)

Specified by:

evaluate in interface Rule

perform

public void perform(Rewrite event,
                    EvaluationContext context)

Specified by:

perform in interface Rule

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.

where

public Join.JoinParameterBuilder where(java.lang.String parameter)

Specified by:

where in interface Parameterized<Join.JoinParameterBuilder,java.lang.String>

where

public Join.JoinParameterBuilder where(java.lang.String param,
                                       java.lang.String pattern)

Specified by:

where in interface Parameterized<Join.JoinParameterBuilder,java.lang.String>

where

public Join.JoinParameterBuilder where(java.lang.String param,
                                       java.lang.String pattern,
                                       Binding binding)

Specified by:

where in interface Parameterized<Join.JoinParameterBuilder,java.lang.String>

where

public Join.JoinParameterBuilder where(java.lang.String param,
                                       Binding binding)

Specified by:

where in interface Parameterized<Join.JoinParameterBuilder,java.lang.String>

getId

public java.lang.String getId()

Specified by:

getId in interface Rule

when

public Join when(Condition condition)

perform

public Join perform(Operation operation)

withId

public Join withId(java.lang.String id)

Set the ID of this Join.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object