Class ResponsePatternRule

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

org.eclipse.jetty.rewrite.handler.PatternRule

org.eclipse.jetty.rewrite.handler.ResponsePatternRule

public class ResponsePatternRule
extends PatternRule

Sends the response code whenever the rule finds a match.

Nested Class Summary

Nested classes/interfaces inherited from class Rule

Rule.Handler, Rule.HttpURIHandler

Constructor Summary

Constructors

Constructor	Description
ResponsePatternRule()
ResponsePatternRule(String pattern, int code, String message)

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.
int	getCode()
String	getMessage()
boolean	isTerminating()
void	setCode(int code)	Set the response code.
void	setMessage(String message)	Sets the message for the response body (if the response code may have a body).
String	toString()

Methods inherited from class PatternRule

getPattern, matchAndApply, setPattern

Methods inherited from class Rule

setTerminating

Methods inherited from class Object

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

Constructor Details

ResponsePatternRule

public ResponsePatternRule()

ResponsePatternRule

public ResponsePatternRule(@Name("pattern")
 String pattern,
 @Name("code")
 int code,
 @Name("message")
 String message)

Method Details

isTerminating

public boolean isTerminating()

Overrides:

isTerminating in class Rule

Returns:

whether rules after this one are not invoked

getCode

public int getCode()

setCode

public void setCode(int code)

Set the response code.

Parameters:

code - the response code

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

Sets the message for the response body (if the response code may have a body).

Parameters:

message - the response message

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