Module org.eclipse.jetty.rewrite

Package org.eclipse.jetty.rewrite.handler

Class HeaderRegexRule

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

org.eclipse.jetty.rewrite.handler.RegexRule

org.eclipse.jetty.rewrite.handler.HeaderRegexRule

public class HeaderRegexRule
extends RegexRule

Puts or adds a response header whenever the rule matches a path regex pattern.

Nested Class Summary

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

Rule.Handler, Rule.HttpURIHandler

Constructor Summary

Constructors

Constructor	Description
HeaderRegexRule()
HeaderRegexRule(String regex, String name, String value)

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	getHeaderName()
String	getHeaderValue()
boolean	isAdd()
void	setAdd(boolean add)	Set true to add the response header, false to put the response header.
void	setHeaderName(String name)
void	setHeaderValue(String value)
String	toString()

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

getRegex, matchAndApply, 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

HeaderRegexRule

public HeaderRegexRule()

HeaderRegexRule

public HeaderRegexRule(@Name("regex")
 String regex,
 @Name("name")
 String name,
 @Name("value")
 String value)

Method Details

getHeaderName

public String getHeaderName()

setHeaderName

public void setHeaderName(String name)

getHeaderValue

public String getHeaderValue()

setHeaderValue

public void setHeaderValue(String value)

isAdd

public boolean isAdd()

setAdd

public void setAdd(boolean add)

Set true to add the response header, false to put the response header.

Parameters:

add - true to add the response header, false to put the response header.

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

Overrides:

toString in class RegexRule