Package org.eclipse.jetty.rewrite.handler

Class RewriteRegexRule

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

org.eclipse.jetty.rewrite.handler.RegexRule

org.eclipse.jetty.rewrite.handler.RewriteRegexRule

public class RewriteRegexRule
extends RegexRule

A rule to rewrite the path and query that match a regular expression pattern with a fixed string.

The replacement String follows standard Matcher.replaceAll(String) behavior, including named groups

Nested Class Summary

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

Rule.Handler, Rule.HttpURIHandler

Constructor Summary

Constructors

Constructor	Description
RewriteRegexRule()
RewriteRegexRule(String regex, String replacement)

Method Summary

Modifier and Type	Method	Description
Rule.Handler	apply(Rule.Handler input, Matcher matcher)	Invoked after the regular expression matched the URI path to apply the rule's logic.
boolean	isAddQueries()	Is the input URI query added with replacement URI query
void	setAddQueries(boolean flag)	Set if input query should be preserved, and added together with replacement query
void	setReplacement(String replacement)	Whenever a match is found, it replaces with this value.
String	toString()

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

isTerminating, setTerminating

Methods inherited from class java.lang.Object

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

Constructor Details

RewriteRegexRule

public RewriteRegexRule()

RewriteRegexRule

public RewriteRegexRule(@Name("regex")
 String regex,
 @Name("replacement")
 String replacement)

Method Details

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.

setReplacement

public void setReplacement(String replacement)

Whenever a match is found, it replaces with this value.

Parameters:

replacement - the replacement string.

apply

public 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()

Overrides:

toString in class RegexRule