Package org.elasticsearch.xpack.core.security.support

Class StringMatcher

java.lang.Object

org.elasticsearch.xpack.core.security.support.StringMatcher

All Implemented Interfaces:

Predicate<String>

public class StringMatcher
extends Object
implements Predicate<String>

This class acts as a facade / encapsulation around the expression and testing of string-based patterns within Elasticsearch security. Security supports "wildcards" in a number of places (e.g. index names within roles). These cases also support Lucene-syntax regular expressions and are implemented via Lucene Automaton objects. However, it can be more efficient to have special handling and avoid Automata for particular cases such as exact string matches. This class handles that logic, an provides a clean interface for test whether a provided string matches one of an existing set of patterns that hides the possible implementation options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringMatcher.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Predicate<String>	ALWAYS_TRUE_PREDICATE

Method Summary

Modifier and Type	Method	Description
StringMatcher	and(String otherDescription, Predicate<? super String> otherPredicate)
StringMatcher	and(Predicate<? super String> other)
static StringMatcher.Builder	builder()
boolean	isTotal()
static StringMatcher	of(Iterable<String> patterns)
static StringMatcher	of(String... patterns)
StringMatcher	or(Predicate<? super String> other)
boolean	test(String s)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

negate

Field Details

ALWAYS_TRUE_PREDICATE

protected static final Predicate<String> ALWAYS_TRUE_PREDICATE

Method Details

of

public static StringMatcher of(Iterable<String> patterns)

of

public static StringMatcher of(String... patterns)

builder

public static StringMatcher.Builder builder()

toString

public String toString()

Overrides:

toString in class Object

test

public boolean test(String s)

Specified by:

test in interface Predicate<String>

isTotal

public boolean isTotal()

or

public StringMatcher or(Predicate<? super String> other)

Specified by:

or in interface Predicate<String>

and

public StringMatcher and(Predicate<? super String> other)

Specified by:

and in interface Predicate<String>

and

public StringMatcher and(String otherDescription,
 Predicate<? super String> otherPredicate)