Package org.eclipse.jetty.rewrite.handler

Class RedirectPatternRule

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

org.eclipse.jetty.rewrite.handler.PatternRule

org.eclipse.jetty.rewrite.handler.RedirectPatternRule

public class RedirectPatternRule
extends PatternRule

Issues a (3xx) Redirect response whenever the rule finds a match.

All redirects are part of the 3xx Redirection status code set.

Defaults to 302 Found

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.rewrite.handler.Rule

Rule.ApplyURI

Field Summary

Fields inherited from class org.eclipse.jetty.rewrite.handler.PatternRule

_pattern

Fields inherited from class org.eclipse.jetty.rewrite.handler.Rule

_handling, _terminating

Constructor Summary

Constructors

Constructor	Description
RedirectPatternRule()
RedirectPatternRule(String pattern, String location)

Method Summary

Modifier and Type	Method	Description
String	apply(String target, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Apply the rule to the request
void	setLocation(String value)	Sets the redirect location.
void	setStatusCode(int statusCode)	Sets the redirect status code.
String	toString()	Returns the redirect status code and location.

Methods inherited from class org.eclipse.jetty.rewrite.handler.PatternRule

getPattern, matchAndApply, setPattern

Methods inherited from class org.eclipse.jetty.rewrite.handler.Rule

isHandling, isTerminating, setHandling, setTerminating

Methods inherited from class java.lang.Object

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

Constructor Details

RedirectPatternRule

public RedirectPatternRule()

RedirectPatternRule

public RedirectPatternRule(@Name("pattern")
 String pattern,
 @Name("location")
 String location)

Method Details

setLocation

public void setLocation(String value)

Sets the redirect location.

Parameters:

value - the location to redirect.

setStatusCode

public void setStatusCode(int statusCode)

Sets the redirect status code.

Parameters:

statusCode - the 3xx redirect status code

apply

public String apply(String target,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws IOException

Description copied from class: PatternRule

Apply the rule to the request

Specified by:

apply in class PatternRule

Parameters:

target - field to attempt match

request - request object

response - response object

Returns:

The target (possible updated)

Throws:

IOException - exceptions dealing with operating on request or response objects

toString

public String toString()

Returns the redirect status code and location.

Overrides:

toString in class PatternRule