Module org.eclipse.jetty.rewrite

Package org.eclipse.jetty.rewrite.handler

Class HeaderPatternRule

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

org.eclipse.jetty.rewrite.handler.PatternRule

org.eclipse.jetty.rewrite.handler.HeaderPatternRule

public class HeaderPatternRule
extends PatternRule

Puts or adds a response header whenever the rule matches a path Servlet 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
HeaderPatternRule()
HeaderPatternRule(String pattern, String name, String value)

Method Summary

Modifier and Type	Method	Description
Rule.Handler	apply(Rule.Handler input)	Invoked after the Servlet pattern matched the URI path to apply the rule's logic.
String	getHeaderName()
String	getHeaderValue()
boolean	isAdd()
void	setAdd(boolean add)	Use 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.PatternRule

getPattern, matchAndApply, setPattern

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

HeaderPatternRule

public HeaderPatternRule()

HeaderPatternRule

public HeaderPatternRule(@Name("pattern")
 String pattern,
 @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)

Use 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

public Rule.Handler apply(Rule.Handler input)
                   throws IOException

Description copied from class: PatternRule

Invoked after the Servlet pattern matched the URI path to apply the rule's logic.

Specified by:

apply in class PatternRule

Parameters:

input - the input Request and Handler

Returns:

the possibly wrapped Request and Handler

Throws:

IOException - if applying the rule failed

toString

public String toString()

Overrides:

toString in class PatternRule