rewrite-config-servlet 2.0.0.Alpha6

org.ocpsoft.rewrite.servlet.config
Class Forward

java.lang.Object
  extended by org.ocpsoft.rewrite.config.DefaultOperationBuilder
      extended by org.ocpsoft.rewrite.servlet.config.HttpOperation
          extended by org.ocpsoft.rewrite.servlet.config.Forward
All Implemented Interfaces:
ConfigurationElement, Operation, OperationBuilder, Parameterized

public class Forward
extends HttpOperation
implements Parameterized

An Operation that performs forwards via InboundServletRewrite.forward(String)

Author:
Lincoln Baxter, III

Nested Class Summary
 
Nested classes/interfaces inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder
DefaultOperationBuilder.NoOp
 
Method Summary
 Set<String> getRequiredParameterNames()
           
 ParameterizedPatternBuilder getTargetExpression()
           
 void performHttp(HttpServletRewrite event, EvaluationContext context)
           
 void setParameterStore(ParameterStore store)
           
static Forward to(String location)
          Forward the current request to the given location within the servlet container.
 String toString()
           
 
Methods inherited from class org.ocpsoft.rewrite.servlet.config.HttpOperation
perform
 
Methods inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder
and, create, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

to

public static Forward to(String location)
Forward the current request to the given location within the servlet container. This does not change the browser URL, all processing is handled within the current HttpServletRequest.

The given location may be parameterized using the following format:

/example/{param}
/example/{value}/sub/{value2}
... and so on

Parameters may be bound. By default, matching parameter values are extracted from bindings in the EvaluationContext.

See also #where(String)


performHttp

public void performHttp(HttpServletRewrite event,
                        EvaluationContext context)
Specified by:
performHttp in class HttpOperation

toString

public String toString()
Overrides:
toString in class Object

getTargetExpression

public ParameterizedPatternBuilder getTargetExpression()

getRequiredParameterNames

public Set<String> getRequiredParameterNames()
Specified by:
getRequiredParameterNames in interface Parameterized

setParameterStore

public void setParameterStore(ParameterStore store)
Specified by:
setParameterStore in interface Parameterized

rewrite-config-servlet 2.0.0.Alpha6

Copyright © 2013 OCPsoft. All Rights Reserved.