Module org.eclipse.jetty.rewrite

Package org.eclipse.jetty.rewrite.handler

Class Rule

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

Direct Known Subclasses:

CompactPathRule, ForceRequestHeaderValueRule, HeaderRule, InvalidURIRule, PatternRule, RegexRule, RuleContainer

public abstract class Rule
extends Object

An abstract rule that, upon matching a certain condition, may wrap the Request or the Handler to execute custom logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Rule.Handler	A Request.Wrapper that is also a Request.Handler, used to chain a sequence of Rules together.
static class	Rule.HttpURIHandler

Constructor Summary

Constructors

Constructor	Description
Rule()

Method Summary

Modifier and Type	Method	Description
boolean	isTerminating()
abstract Rule.Handler	matchAndApply(Rule.Handler input)	Tests whether the given Request should apply, and if so the rule logic is triggered.
void	setTerminating(boolean value)
String	toString()	Returns the handling and terminating flag values.

Methods inherited from class java.lang.Object

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

Constructor Details

Rule

public Rule()

Method Details

matchAndApply

public abstract Rule.Handler matchAndApply(Rule.Handler input)
                                    throws IOException

Tests whether the given Request should apply, and if so the rule logic is triggered.

Parameters:

input - the input Request and Handler

Returns:

the possibly wrapped Request and Handler, or null if the rule did not match

Throws:

IOException - if applying the rule failed

isTerminating

public boolean isTerminating()

Returns:

when true, rules after this one are not invoked

setTerminating

public void setTerminating(boolean value)

toString

public String toString()

Returns the handling and terminating flag values.

Overrides:

toString in class Object