Module org.eclipse.jetty.rewrite

Package org.eclipse.jetty.rewrite.handler

Class RuleContainer

java.lang.Object

org.eclipse.jetty.rewrite.handler.Rule

org.eclipse.jetty.rewrite.handler.RuleContainer

All Implemented Interfaces:

Iterable<Rule>, org.eclipse.jetty.util.component.Dumpable

Direct Known Subclasses:

RewriteCustomizer, VirtualHostRuleContainer

public class RuleContainer
extends Rule
implements Iterable<Rule>, org.eclipse.jetty.util.component.Dumpable

A container that groups Rules and is itself a Rule.

The contained rules will be applied only if the container rule matches.

Nested Class Summary

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

Rule.Handler, Rule.HttpURIHandler

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
RuleContainer()

Method Summary

Modifier and Type	Method	Description
void	addRule(Rule rule)	Adds a Rule to the existing ones.
void	clear()	Removes all the rules.
void	dump(Appendable out, String indent)
String	getOriginalPathAttribute()
List<Rule>	getRules()
Iterator<Rule>	iterator()
Rule.Handler	matchAndApply(Rule.Handler input)	Processes the rules.
void	setOriginalPathAttribute(String originalPathAttribute)	Sets a request attribute name that will be used to store the request original path.
void	setRules(List<Rule> rules)	Set the list of Rule..

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

isTerminating, setTerminating, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dumpSelf

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX

public static final String ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX

See Also:

• Constant Field Values

Constructor Details

RuleContainer

public RuleContainer()

Method Details

getRules

public List<Rule> getRules()

Returns:

the list of Rules

setRules

public void setRules(List<Rule> rules)

Set the list of Rule..

Parameters:

rules - the list of Rule.

iterator

public Iterator<Rule> iterator()

Specified by:

iterator in interface Iterable<Rule>

addRule

public void addRule(Rule rule)

Adds a Rule to the existing ones.

Parameters:

rule - the rule to add to the rules list

clear

public void clear()

Removes all the rules.

getOriginalPathAttribute

public String getOriginalPathAttribute()

Returns:

the request attribute name used to store the request original path

See Also:

• setOriginalPathAttribute(String)

setOriginalPathAttribute

public void setOriginalPathAttribute(String originalPathAttribute)

Sets a request attribute name that will be used to store the request original path.

A request attribute name that stores the request original query is derived from this attribute name by adding ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX, as in:

 String originalQueryAttribute = ruleContainer.getOriginalPathAttribute() + ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX;
 

Parameters:

originalPathAttribute - the request attribute name used to store the request original path

matchAndApply

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

Processes the rules.

Specified by:

matchAndApply in class Rule

Parameters:

input - the input Request and Handler

Returns:

a Request and Handler, possibly wrapped by rules to implement the rule's logic, or null if no rule matched

Throws:

IOException - if applying the rule fails

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Throws:

IOException