Module org.eclipse.jetty.rewrite

Package org.eclipse.jetty.rewrite.handler

Class RedirectRegexRule

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

org.eclipse.jetty.rewrite.handler.RegexRule

org.eclipse.jetty.rewrite.handler.RedirectRegexRule

public class RedirectRegexRule
extends RegexRule

Issues a (3xx) redirect response whenever the rule finds a request path regular expression match

The replacement string may use $n to replace the nth capture group.

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.Handler, Rule.HttpURIHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_location

Constructor Summary

Constructors

Constructor	Description
RedirectRegexRule()
RedirectRegexRule(String regex, String location)

Method Summary

Modifier and Type	Method	Description
protected Rule.Handler	apply(Rule.Handler input, Matcher matcher)	Invoked after the regular expression matched the URI path to apply the rule's logic.
String	getLocation()
int	getStatusCode()
boolean	isAddQueries()	Is the input URI query added with replacement URI query
boolean	isTerminating()
void	setAddQueries(boolean flag)	Set if input query should be preserved, and added together with replacement query
void	setLocation(String location)	Set the location to redirect.
void	setStatusCode(int statusCode)
String	toString()	Returns the redirect status code and replacement.

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

getRegex, isMatchQuery, matchAndApply, setMatchQuery, setRegex

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

setTerminating

Methods inherited from class java.lang.Object

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

Field Details

_location

protected String _location

Constructor Details

RedirectRegexRule

public RedirectRegexRule()

RedirectRegexRule

public RedirectRegexRule(@Name("regex")
 String regex,
 @Name("location")
 String location)

Method Details

isTerminating

public boolean isTerminating()

Overrides:

isTerminating in class Rule

Returns:

whether rules after this one are not invoked

getLocation

public String getLocation()

setLocation

public void setLocation(String location)

Set the location to redirect.

Parameters:

location - the location to redirect.

isAddQueries

public boolean isAddQueries()

Is the input URI query added with replacement URI query

Returns:

true to add input query with replacement query.

setAddQueries

public void setAddQueries(boolean flag)

Set if input query should be preserved, and added together with replacement query

This is especially useful when used in combination with a disabled RegexRule.setMatchQuery(boolean)

Parameters:

flag - true to have input query added with replacement query, false (default) to have query from input or output just be treated as a string, and not merged.

getStatusCode

public int getStatusCode()

setStatusCode

public void setStatusCode(int statusCode)

apply

protected Rule.Handler apply(Rule.Handler input,
 Matcher matcher)
                      throws IOException

Description copied from class: RegexRule

Invoked after the regular expression matched the URI path to apply the rule's logic.

Specified by:

apply in class RegexRule

Parameters:

input - the input Request and Handler

matcher - the Matcher that matched the request path, with capture groups available for replacement.

Returns:

the possibly wrapped Request and Handler

Throws:

IOException - if applying the rule failed

toString

public String toString()

Returns the redirect status code and replacement.

Overrides:

toString in class RegexRule