Module com.aoapps.servlet.firewall.pathspace

Package com.aoapps.servlet.firewall.pathspace

Class Rules.pathMatch.path

java.lang.Object

com.aoapps.servlet.firewall.pathspace.Rules.pathMatch.path

Enclosing class:

Rules.pathMatch

public static final class Rules.pathMatch.path
extends Object

See PathMatch.getPath().

Method Summary

Modifier and Type	Method	Description
static Matcher	contains(CharSequence substring)	Matches when a request path contains a given character sequence, case-sensitive.
static Matcher	contains(CharSequence substring, Rule... rules)	Matches when a request path contains a given character sequence, case-sensitive.
static Matcher	contains(CharSequence substring, Rule[] rules, Rule... otherwise)	Matches when a request path contains a given character sequence, case-sensitive.
static Matcher	contains(CharSequence substring, Iterable<? extends Rule> rules)	Matches when a request path contains a given character sequence, case-sensitive.
static Matcher	contains(CharSequence substring, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path contains a given character sequence, case-sensitive.
static Matcher	endsWith(String suffix)	Matches when a request path ends with a given string, case-sensitive.
static Matcher	endsWith(String suffix, Rule... rules)	Matches when a request path ends with a given string, case-sensitive.
static Matcher	endsWith(String suffix, Rule[] rules, Rule... otherwise)	Matches when a request path ends with a given string, case-sensitive.
static Matcher	endsWith(String suffix, Iterable<? extends Rule> rules)	Matches when a request path ends with a given string, case-sensitive.
static Matcher	endsWith(String suffix, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path ends with a given string, case-sensitive.
static Matcher	equals(Path target)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(Path target, Rule... rules)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(Path target, Rule[] rules, Rule... otherwise)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(Path target, Iterable<? extends Rule> rules)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(Path target, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(CharSequence target)	Matches when a request path is equal to a given character sequence, case-sensitive.
static Matcher	equals(CharSequence target, Rule... rules)	Matches when a request path is equal to a given character sequence, case-sensitive.
static Matcher	equals(CharSequence target, Rule[] rules, Rule... otherwise)	Matches when a request path is equal to a given character sequence, case-sensitive.
static Matcher	equals(CharSequence target, Iterable<? extends Rule> rules)	Matches when a request path is equal to a given character sequence, case-sensitive.
static Matcher	equals(CharSequence target, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path is equal to a given character sequence, case-sensitive.
static Matcher	equals(String target)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(String target, Rule... rules)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(String target, Rule[] rules, Rule... otherwise)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(String target, Iterable<? extends Rule> rules)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equals(String target, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path is equal to a given string, case-sensitive.
static Matcher	equalsIgnoreCase(String target)	Matches when a request path is equal to a given string, case-insensitive.
static Matcher	equalsIgnoreCase(String target, Rule... rules)	Matches when a request path is equal to a given string, case-insensitive.
static Matcher	equalsIgnoreCase(String target, Rule[] rules, Rule... otherwise)	Matches when a request path is equal to a given string, case-insensitive.
static Matcher	equalsIgnoreCase(String target, Iterable<? extends Rule> rules)	Matches when a request path is equal to a given string, case-insensitive.
static Matcher	equalsIgnoreCase(String target, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path is equal to a given string, case-insensitive.
static Matcher	matches(WildcardPatternMatcher wildcardPattern)	Matches when a request path matches a given WildcardPatternMatcher.
static Matcher	matches(WildcardPatternMatcher wildcardPattern, Rule... rules)	Matches when a request path matches a given WildcardPatternMatcher.
static Matcher	matches(WildcardPatternMatcher wildcardPattern, Rule[] rules, Rule... otherwise)	Matches when a request path matches a given WildcardPatternMatcher.
static Matcher	matches(WildcardPatternMatcher wildcardPattern, Iterable<? extends Rule> rules)	Matches when a request path matches a given WildcardPatternMatcher.
static Matcher	matches(WildcardPatternMatcher wildcardPattern, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path matches a given WildcardPatternMatcher.
static Matcher	matches(Pattern pattern)	Matches when a request path matches a given regular expression.
static Matcher	matches(Pattern pattern, Rule... rules)	Matches when a request path matches a given regular expression.
static Matcher	matches(Pattern pattern, Rule[] rules, Rule... otherwise)	Matches when a request path matches a given regular expression.
static Matcher	matches(Pattern pattern, Iterable<? extends Rule> rules)	Matches when a request path matches a given regular expression.
static Matcher	matches(Pattern pattern, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path matches a given regular expression.
static Matcher	startsWith(String prefix)	Matches when a request path starts with a given string, case-sensitive.
static Matcher	startsWith(String prefix, Rule... rules)	Matches when a request path starts with a given string, case-sensitive.
static Matcher	startsWith(String prefix, Rule[] rules, Rule... otherwise)	Matches when a request path starts with a given string, case-sensitive.
static Matcher	startsWith(String prefix, Iterable<? extends Rule> rules)	Matches when a request path starts with a given string, case-sensitive.
static Matcher	startsWith(String prefix, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches when a request path starts with a given string, case-sensitive.

Methods inherited from class java.lang.Object

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

Method Details

startsWith

public static Matcher startsWith(String prefix)

Matches when a request path starts with a given string, case-sensitive. Matches when prefix is empty.

See Also:

• String.startsWith(java.lang.String)

startsWith

public static Matcher startsWith(String prefix,
 Iterable<? extends Rule> rules)

Matches when a request path starts with a given string, case-sensitive. Matches when prefix is empty.

Parameters:

rules - Invoked only when matched.

See Also:

• String.startsWith(java.lang.String)

startsWith

public static Matcher startsWith(String prefix,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path starts with a given string, case-sensitive. Matches when prefix is empty.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.startsWith(java.lang.String)

startsWith

public static Matcher startsWith(String prefix,
 Rule... rules)

Matches when a request path starts with a given string, case-sensitive. Matches when prefix is empty.

Parameters:

rules - Invoked only when matched.

See Also:

• String.startsWith(java.lang.String)

startsWith

public static Matcher startsWith(String prefix,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path starts with a given string, case-sensitive. Matches when prefix is empty.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.startsWith(java.lang.String)

endsWith

public static Matcher endsWith(String suffix)

Matches when a request path ends with a given string, case-sensitive. Matches when suffix is empty.

See Also:

• String.endsWith(java.lang.String)

endsWith

public static Matcher endsWith(String suffix,
 Iterable<? extends Rule> rules)

Matches when a request path ends with a given string, case-sensitive. Matches when suffix is empty.

Parameters:

rules - Invoked only when matched.

See Also:

• String.endsWith(java.lang.String)

endsWith

public static Matcher endsWith(String suffix,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path ends with a given string, case-sensitive. Matches when suffix is empty.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.endsWith(java.lang.String)

endsWith

public static Matcher endsWith(String suffix,
 Rule... rules)

Matches when a request path ends with a given string, case-sensitive. Matches when suffix is empty.

Parameters:

rules - Invoked only when matched.

See Also:

• String.endsWith(java.lang.String)

endsWith

public static Matcher endsWith(String suffix,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path ends with a given string, case-sensitive. Matches when suffix is empty.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.endsWith(java.lang.String)

contains

public static Matcher contains(CharSequence substring)

Matches when a request path contains a given character sequence, case-sensitive. Matches when substring is empty.

See Also:

• String.contains(java.lang.CharSequence)

contains

public static Matcher contains(CharSequence substring,
 Iterable<? extends Rule> rules)

Matches when a request path contains a given character sequence, case-sensitive. Matches when substring is empty.

Parameters:

rules - Invoked only when matched.

See Also:

• String.contains(java.lang.CharSequence)

contains

public static Matcher contains(CharSequence substring,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path contains a given character sequence, case-sensitive. Matches when substring is empty.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.contains(java.lang.CharSequence)

contains

public static Matcher contains(CharSequence substring,
 Rule... rules)

Matches when a request path contains a given character sequence, case-sensitive. Matches when substring is empty.

Parameters:

rules - Invoked only when matched.

See Also:

• String.contains(java.lang.CharSequence)

contains

public static Matcher contains(CharSequence substring,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path contains a given character sequence, case-sensitive. Matches when substring is empty.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.contains(java.lang.CharSequence)

equals

public static Matcher equals(Path target)

Matches when a request path is equal to a given string, case-sensitive.

See Also:

• Path.equals(java.lang.Object)

equals

public static Matcher equals(Path target,
 Iterable<? extends Rule> rules)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• Path.equals(java.lang.Object)

equals

public static Matcher equals(Path target,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• Path.equals(java.lang.Object)

equals

public static Matcher equals(Path target,
 Rule... rules)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• Path.equals(java.lang.Object)

equals

public static Matcher equals(Path target,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• Path.equals(java.lang.Object)

equals

public static Matcher equals(String target)

Matches when a request path is equal to a given string, case-sensitive.

See Also:

• Path.valueOf(java.lang.String)

equals

public static Matcher equals(String target,
 Iterable<? extends Rule> rules)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• Path.valueOf(java.lang.String)

equals

public static Matcher equals(String target,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• Path.valueOf(java.lang.String)

equals

public static Matcher equals(String target,
 Rule... rules)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• Path.valueOf(java.lang.String)

equals

public static Matcher equals(String target,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path is equal to a given string, case-sensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• Path.valueOf(java.lang.String)

equals

public static Matcher equals(CharSequence target)

Matches when a request path is equal to a given character sequence, case-sensitive.

See Also:

• String.contentEquals(java.lang.CharSequence)

equals

public static Matcher equals(CharSequence target,
 Iterable<? extends Rule> rules)

Matches when a request path is equal to a given character sequence, case-sensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• String.contentEquals(java.lang.CharSequence)

equals

public static Matcher equals(CharSequence target,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path is equal to a given character sequence, case-sensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.contentEquals(java.lang.CharSequence)

equals

public static Matcher equals(CharSequence target,
 Rule... rules)

Matches when a request path is equal to a given character sequence, case-sensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• String.contentEquals(java.lang.CharSequence)

equals

public static Matcher equals(CharSequence target,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path is equal to a given character sequence, case-sensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.contentEquals(java.lang.CharSequence)

equalsIgnoreCase

public static Matcher equalsIgnoreCase(String target)

Matches when a request path is equal to a given string, case-insensitive.

See Also:

• String.equalsIgnoreCase(java.lang.String)

equalsIgnoreCase

public static Matcher equalsIgnoreCase(String target,
 Iterable<? extends Rule> rules)

Matches when a request path is equal to a given string, case-insensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• String.equalsIgnoreCase(java.lang.String)

equalsIgnoreCase

public static Matcher equalsIgnoreCase(String target,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path is equal to a given string, case-insensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.equalsIgnoreCase(java.lang.String)

equalsIgnoreCase

public static Matcher equalsIgnoreCase(String target,
 Rule... rules)

Matches when a request path is equal to a given string, case-insensitive.

Parameters:

rules - Invoked only when matched.

See Also:

• String.equalsIgnoreCase(java.lang.String)

equalsIgnoreCase

public static Matcher equalsIgnoreCase(String target,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path is equal to a given string, case-insensitive.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• String.equalsIgnoreCase(java.lang.String)

matches

public static Matcher matches(Pattern pattern)

Matches when a request path matches a given regular expression.

See Also:

• Pattern.compile(java.lang.String)
• Pattern.compile(java.lang.String, int)

matches

public static Matcher matches(Pattern pattern,
 Iterable<? extends Rule> rules)

Matches when a request path matches a given regular expression.

Parameters:

rules - Invoked only when matched.

See Also:

• Pattern.compile(java.lang.String)
• Pattern.compile(java.lang.String, int)

matches

public static Matcher matches(Pattern pattern,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path matches a given regular expression.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• Pattern.compile(java.lang.String)
• Pattern.compile(java.lang.String, int)

matches

public static Matcher matches(Pattern pattern,
 Rule... rules)

Matches when a request path matches a given regular expression.

Parameters:

rules - Invoked only when matched.

See Also:

• Pattern.compile(java.lang.String)
• Pattern.compile(java.lang.String, int)

matches

public static Matcher matches(Pattern pattern,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path matches a given regular expression.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• Pattern.compile(java.lang.String)
• Pattern.compile(java.lang.String, int)

matches

public static Matcher matches(WildcardPatternMatcher wildcardPattern)

Matches when a request path matches a given WildcardPatternMatcher.

WildcardPatternMatcher can significantly outperform Pattern, especially in suffix matching.

TODO: Move WildcardPatternMatcher to own microproject and remove dependency on larger ao-hodgepodge project.

See Also:

• WildcardPatternMatcher.compile(java.lang.String)

matches

public static Matcher matches(WildcardPatternMatcher wildcardPattern,
 Iterable<? extends Rule> rules)

Matches when a request path matches a given WildcardPatternMatcher.

WildcardPatternMatcher can significantly outperform Pattern, especially in suffix matching.

Parameters:

rules - Invoked only when matched.

See Also:

• WildcardPatternMatcher.compile(java.lang.String)

matches

public static Matcher matches(WildcardPatternMatcher wildcardPattern,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches when a request path matches a given WildcardPatternMatcher.

WildcardPatternMatcher can significantly outperform Pattern, especially in suffix matching.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• WildcardPatternMatcher.compile(java.lang.String)

matches

public static Matcher matches(WildcardPatternMatcher wildcardPattern,
 Rule... rules)

Matches when a request path matches a given WildcardPatternMatcher.

WildcardPatternMatcher can significantly outperform Pattern, especially in suffix matching.

Parameters:

rules - Invoked only when matched.

See Also:

• WildcardPatternMatcher.compile(java.lang.String)

matches

public static Matcher matches(WildcardPatternMatcher wildcardPattern,
 Rule[] rules,
 Rule... otherwise)

Matches when a request path matches a given WildcardPatternMatcher.

WildcardPatternMatcher can significantly outperform Pattern, especially in suffix matching.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

See Also:

• WildcardPatternMatcher.compile(java.lang.String)