org.ocpsoft.rewrite.servlet.config
Class Redirect

java.lang.Object
  org.ocpsoft.rewrite.config.DefaultOperationBuilder
      org.ocpsoft.rewrite.servlet.config.HttpOperation
          org.ocpsoft.rewrite.servlet.config.Redirect

All Implemented Interfaces:

ConfigurationElement, Operation, OperationBuilder, Parameterized<IRedirect,IRedirect.RedirectParameter,String>, IRedirect

public class Redirect
extends HttpOperation
implements IRedirect

An Operation that performs redirects via HttpInboundServletRewrite.redirectPermanent(String) and HttpInboundServletRewrite.redirectTemporary(String)

Author:

Lincoln Baxter, III

Nested Class Summary

Nested classes/interfaces inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder

DefaultOperationBuilder.NoOp

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

IRedirect.IRedirectParameter, IRedirect.RedirectParameter

Method Summary

RegexParameterizedPatternBuilder	getTargetExpression()
void	performHttp(HttpServletRewrite event, EvaluationContext context)
static Redirect	permanent(String location) Issue a permanent redirect ( 301 HttpServletResponse.SC_MOVED_PERMANENTLY ) to the given location.
static Redirect	temporary(String location) Issue a temporary redirect ( 302 HttpServletResponse.SC_MOVED_TEMPORARILY ) to the given location.
String	toString()
IRedirect.RedirectParameter	where(String param)
IRedirect.RedirectParameter	where(String param, Binding binding)

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

Methods inherited from interface org.ocpsoft.rewrite.config.OperationBuilder

and

Methods inherited from interface org.ocpsoft.rewrite.config.Operation

perform

Method Detail

performHttp

public void performHttp(HttpServletRewrite event,
                        EvaluationContext context)

Specified by:

performHttp in class HttpOperation

permanent

public static Redirect permanent(String location)

Issue a permanent redirect ( 301 HttpServletResponse.SC_MOVED_PERMANENTLY ) to the given location. If the given location is not the same as HttpServletRewrite.getAddress(), this will change the browser URL and result in a new request. Note that in order to redirect within the ServletContext, you must prepend the ServletContext.getContextPath() manually.

The given location may be parameterized using the following format:

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

By default, matching parameter values are bound to the EvaluationContext.

See also where(String)

temporary

public static Redirect temporary(String location)

Issue a temporary redirect ( 302 HttpServletResponse.SC_MOVED_TEMPORARILY ) to the given location. If the given location is not the same as HttpServletRewrite.getAddress(), this will change the browser URL and result in a new request. Note that in order to redirect within the ServletContext, you must prepend the ServletContext.getContextPath() manually.

The given location may be parameterized using the following format:

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

By default, matching parameter values are bound to the EvaluationContext.

See also where(String)

where

public IRedirect.RedirectParameter where(String param)

Specified by:

where in interface Parameterized<IRedirect,IRedirect.RedirectParameter,String>

where

public IRedirect.RedirectParameter where(String param,
                                         Binding binding)

Specified by:

where in interface Parameterized<IRedirect,IRedirect.RedirectParameter,String>

getTargetExpression

public RegexParameterizedPatternBuilder getTargetExpression()

Specified by:

getTargetExpression in interface IRedirect

toString

public String toString()

Overrides:

toString in class Object