org.ocpsoft.rewrite.servlet.config.rule
Class IJoin.JoinParameter

java.lang.Object
  org.ocpsoft.rewrite.bind.DefaultBindable<PARAMTYPE>
      org.ocpsoft.rewrite.param.ParameterBuilder<IJoin.JoinParameter,String>
          org.ocpsoft.rewrite.servlet.config.rule.IJoin.JoinParameter

All Implemented Interfaces:

Bindable<IJoin.JoinParameter>, Converter<Object>, HasConverter<IJoin.JoinParameter>, HasValidator<IJoin.JoinParameter>, Validator<Object>, Condition, ConfigurationElement, Operation, Rule, Constrainable<IJoin.JoinParameter,String>, Parameter<IJoin.JoinParameter,String>, Parameterized<IJoin,IJoin.JoinParameter,String>, Transformable<IJoin.JoinParameter,String>, IJoin, IJoin.IJoinParameter

Enclosing interface:

IJoin

public static class IJoin.JoinParameter
extends ParameterBuilder<IJoin.JoinParameter,String>
implements IJoin.IJoinParameter

Nested Class Summary

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

IJoin.IJoinParameter, IJoin.JoinParameter

Constructor Summary

IJoin.JoinParameter(IJoin join, IPath.PathParameter... captures)

Method Summary

boolean	evaluate(Rewrite event, EvaluationContext context)
String	getId()
String	getName()
ParameterizedPatternParser	getPathExpression()
ParameterizedPatternParser	getResourcexpression()
IJoin.IJoinParameter	matches(String string) Specify the pattern to which this Parameter must match.
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.
IJoin	when(Condition condition) Define additional Condition instances that must be satisfied in order for this rule to match successfully.
IJoin.JoinParameter	where(String param)
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 org.ocpsoft.rewrite.param.ParameterBuilder

bindsTo, constrainedBy, convert, convertedBy, convertedBy, getConstraints, getConverter, getTransforms, getValidator, toString, transformedBy, validate, validatedBy, validatedBy

Methods inherited from class org.ocpsoft.rewrite.bind.DefaultBindable

getBindings

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ocpsoft.rewrite.bind.Bindable

bindsTo, getBindings

Methods inherited from interface org.ocpsoft.rewrite.param.Constrainable

constrainedBy, getConstraints

Methods inherited from interface org.ocpsoft.rewrite.param.Transformable

getTransforms, transformedBy

Methods inherited from interface org.ocpsoft.rewrite.bind.Converter

convert

Methods inherited from interface org.ocpsoft.rewrite.bind.Validator

validate

Methods inherited from interface org.ocpsoft.rewrite.bind.HasValidator

getValidator, validatedBy, validatedBy

Methods inherited from interface org.ocpsoft.rewrite.bind.HasConverter

convertedBy, convertedBy, getConverter

Constructor Detail

IJoin.JoinParameter

public IJoin.JoinParameter(IJoin join,
                           IPath.PathParameter... captures)

Method Detail

matches

public IJoin.IJoinParameter matches(String string)

Description copied from interface: IJoin.IJoinParameter

Specify the pattern to which this Parameter must match.

Specified by:

matches in interface IJoin.IJoinParameter

getName

public String getName()

Specified by:

getName in interface Parameter<IJoin.JoinParameter,String>

where

public IJoin.JoinParameter where(String param)

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>

evaluate

public boolean evaluate(Rewrite event,
                        EvaluationContext context)

Specified by:

evaluate in interface Condition

Specified by:

evaluate in interface Rule

getPathExpression

public ParameterizedPatternParser getPathExpression()

Specified by:

getPathExpression in interface IJoin

getResourcexpression

public ParameterizedPatternParser getResourcexpression()

Specified by:

getResourcexpression in interface IJoin

getId

public String getId()

Specified by:

getId in interface Rule

perform

public void perform(Rewrite event,
                    EvaluationContext context)

Specified by:

perform in interface Operation

Specified by:

perform in interface Rule

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

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

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

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

withId

public IJoin withId(String id)

Description copied from interface: IJoin

Set the ID of this Join.

Specified by:

withId in interface IJoin

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