Top Inners Fields Constructors Methods
org.apache.catalina.valves.rewrite

public Class Substitution

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, .Map, java.util.regex.Matcher, org.apache.catalina.util.URLEncoder

Nested and Inner Type Summary

Modifier and TypeClass and Description
public class
public static class
public class
public static class
public static class
public static class
public static class
public static class
public abstract static class

Field Summary

Modifier and TypeField and Description
protected Substitution.SubstitutionElement[]
private boolean
protected String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The substitution result
evaluate
(Matcher
corresponding matched rule
rule
,
Matcher
last matched condition
cond
,
Resolver
The property resolver
resolver
)

Evaluate the substitution based on the context.

private String
private static int
findMatchingBrace(String sub, int start)

private static int
findMatchingColonOrBar(boolean colon, String sub, int start)

public String
private boolean

Returns:

true if testPos is not negative and is less then any given other integer, false otherwise
isFirstPos
(int
integer to test against
testPos
,
int...
list of integers that are paired against testPos. Any negative integer will be ignored.
others
)

Checks whether the first int is non negative and smaller than any non negative other int given with others.

public void
private Substitution.SubstitutionElement[]
pack-priv void
setEscapeBackReferences(boolean escapeBackReferences)

public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

elementsback to summary
protected Substitution.SubstitutionElement[] elements
escapeBackReferencesback to summary
private boolean escapeBackReferences
subback to summary
protected String sub

Constructor Detail

Substitutionback to summary
public Substitution()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Evaluate the substitution based on the context.

Parameters
rule:Matcher

corresponding matched rule

cond:Matcher

last matched condition

resolver:Resolver

The property resolver

Returns:String

The substitution result

evaluateSubstitutionback to summary
private String evaluateSubstitution(Substitution.SubstitutionElement[] elements, Matcher rule, Matcher cond, Resolver resolver)
findMatchingBraceback to summary
private static int findMatchingBrace(String sub, int start)
findMatchingColonOrBarback to summary
private static int findMatchingColonOrBar(boolean colon, String sub, int start)
getSubback to summary
public String getSub()
isFirstPosback to summary
private boolean isFirstPos(int testPos, int... others)

Checks whether the first int is non negative and smaller than any non negative other int given with others.

Parameters
testPos:int

integer to test against

others:int[]

list of integers that are paired against testPos. Any negative integer will be ignored.

Returns:boolean

true if testPos is not negative and is less then any given other integer, false otherwise

parseback to summary
public void parse(Map<String, RewriteMap> maps)
parseSubstitutionback to summary
private Substitution.SubstitutionElement[] parseSubstitution(String sub, Map<String, RewriteMap> maps)
setEscapeBackReferencesback to summary
pack-priv void setEscapeBackReferences(boolean escapeBackReferences)
setSubback to summary
public void setSub(String sub)
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.MapElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public Substitution.SubstitutionElement[]
public Substitution.SubstitutionElement[]
public RewriteMap

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

defaultValueback to summary
public Substitution.SubstitutionElement[] defaultValue
keyback to summary
public Substitution.SubstitutionElement[] key
mapback to summary
public RewriteMap map

Constructor Detail

MapElementback to summary
public MapElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.RewriteCondBackReferenceElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public int
n

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

nback to summary
public int n

Constructor Detail

RewriteCondBackReferenceElementback to summary
public RewriteCondBackReferenceElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.RewriteRuleBackReferenceElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public int
n

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

nback to summary
public int n

Constructor Detail

RewriteRuleBackReferenceElementback to summary
public RewriteRuleBackReferenceElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.ServerVariableElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

keyback to summary
public String key

Constructor Detail

ServerVariableElementback to summary
public ServerVariableElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.ServerVariableEnvElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

keyback to summary
public String key

Constructor Detail

ServerVariableEnvElementback to summary
public ServerVariableEnvElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.ServerVariableHttpElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

keyback to summary
public String key

Constructor Detail

ServerVariableHttpElementback to summary
public ServerVariableHttpElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.ServerVariableSslElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

keyback to summary
public String key

Constructor Detail

ServerVariableSslElementback to summary
public ServerVariableSslElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public Class Substitution.StaticElement

extends SubstitutionElement
Class Inheritance

Field Summary

Modifier and TypeField and Description
public String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Field Detail

valueback to summary
public String value

Constructor Detail

StaticElementback to summary
public StaticElement()

Method Detail

evaluateback to summary
public String evaluate(Matcher rule, Matcher cond, Resolver resolver)

Implements abstract org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement.evaluate.

Annotations
@Override
org.apache.catalina.valves.rewrite back to summary

public abstract Class Substitution.SubstitutionElement

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.catalina.valves.rewrite.Substitution.SubstitutionElement
Known Direct Subclasses
org.apache.catalina.valves.rewrite.Substitution.StaticElement, org.apache.catalina.valves.rewrite.Substitution.RewriteRuleBackReferenceElement, org.apache.catalina.valves.rewrite.Substitution.RewriteCondBackReferenceElement, org.apache.catalina.valves.rewrite.Substitution.ServerVariableElement, org.apache.catalina.valves.rewrite.Substitution.ServerVariableEnvElement, org.apache.catalina.valves.rewrite.Substitution.ServerVariableSslElement, org.apache.catalina.valves.rewrite.Substitution.ServerVariableHttpElement, org.apache.catalina.valves.rewrite.Substitution.MapElement

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public abstract String
evaluate(Matcher rule, Matcher cond, Resolver resolver)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

SubstitutionElementback to summary
public SubstitutionElement()

Method Detail

evaluateback to summary
public abstract String evaluate(Matcher rule, Matcher cond, Resolver resolver)