Class Matchers.HeaderMatcher

java.lang.Object

io.grpc.xds.internal.Matchers.HeaderMatcher

Direct Known Subclasses:

AutoValue_Matchers_HeaderMatcher

Enclosing class:

Matchers

public abstract static class Matchers.HeaderMatcher
extends Object

Matcher for HTTP request headers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Matchers.HeaderMatcher.Range	Represents an integer range.

Constructor Summary

Constructors

Constructor	Description
HeaderMatcher()

Method Summary

Modifier and Type	Method	Description
abstract String	contains()
private static Matchers.HeaderMatcher	create(String name, String exactValue, com.google.re2j.Pattern safeRegEx, Matchers.HeaderMatcher.Range range, Boolean present, String prefix, String suffix, String contains, Matchers.StringMatcher stringMatcher, boolean inverted)
abstract String	exactValue()
static Matchers.HeaderMatcher	forContains(String name, String contains, boolean inverted)	The request header value should have this substring.
static Matchers.HeaderMatcher	forExactValue(String name, String exactValue, boolean inverted)	The request header value should exactly match the specified value.
static Matchers.HeaderMatcher	forPrefix(String name, String prefix, boolean inverted)	The request header value should have this prefix.
static Matchers.HeaderMatcher	forPresent(String name, boolean present, boolean inverted)	The request header value should exist.
static Matchers.HeaderMatcher	forRange(String name, Matchers.HeaderMatcher.Range range, boolean inverted)	The request header value should be within the range.
static Matchers.HeaderMatcher	forSafeRegEx(String name, com.google.re2j.Pattern safeRegEx, boolean inverted)	The request header value should match the regular expression pattern.
static Matchers.HeaderMatcher	forString(String name, Matchers.StringMatcher stringMatcher, boolean inverted)	The request header value should match this stringMatcher.
static Matchers.HeaderMatcher	forSuffix(String name, String suffix, boolean inverted)	The request header value should have this suffix.
abstract boolean	inverted()
boolean	matches(String value)	Returns the matching result.
abstract String	name()
abstract String	prefix()
abstract Boolean	present()
abstract Matchers.HeaderMatcher.Range	range()
abstract com.google.re2j.Pattern	safeRegEx()
abstract Matchers.StringMatcher	stringMatcher()
abstract String	suffix()

Methods inherited from class Object

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

Constructor Details

HeaderMatcher

public HeaderMatcher()

Method Details

name

public abstract String name()

exactValue

@Nullable
public abstract String exactValue()

safeRegEx

@Nullable
public abstract com.google.re2j.Pattern safeRegEx()

range

@Nullable
public abstract Matchers.HeaderMatcher.Range range()

present

@Nullable
public abstract Boolean present()

prefix

@Nullable
public abstract String prefix()

suffix

@Nullable
public abstract String suffix()

contains

@Nullable
public abstract String contains()

stringMatcher

@Nullable
public abstract Matchers.StringMatcher stringMatcher()

inverted

public abstract boolean inverted()

forExactValue

public static Matchers.HeaderMatcher forExactValue(String name,
 String exactValue,
 boolean inverted)

The request header value should exactly match the specified value.

forSafeRegEx

public static Matchers.HeaderMatcher forSafeRegEx(String name,
 com.google.re2j.Pattern safeRegEx,
 boolean inverted)

The request header value should match the regular expression pattern.

forRange

public static Matchers.HeaderMatcher forRange(String name,
 Matchers.HeaderMatcher.Range range,
 boolean inverted)

The request header value should be within the range.

forPresent

public static Matchers.HeaderMatcher forPresent(String name,
 boolean present,
 boolean inverted)

The request header value should exist.

forPrefix

public static Matchers.HeaderMatcher forPrefix(String name,
 String prefix,
 boolean inverted)

The request header value should have this prefix.

forSuffix

public static Matchers.HeaderMatcher forSuffix(String name,
 String suffix,
 boolean inverted)

The request header value should have this suffix.

forContains

public static Matchers.HeaderMatcher forContains(String name,
 String contains,
 boolean inverted)

The request header value should have this substring.

forString

public static Matchers.HeaderMatcher forString(String name,
 Matchers.StringMatcher stringMatcher,
 boolean inverted)

The request header value should match this stringMatcher.

create

private static Matchers.HeaderMatcher create(String name,
 @Nullable
 String exactValue,
 @Nullable
 com.google.re2j.Pattern safeRegEx,
 @Nullable
 Matchers.HeaderMatcher.Range range,
 @Nullable
 Boolean present,
 @Nullable
 String prefix,
 @Nullable
 String suffix,
 @Nullable
 String contains,
 @Nullable
 Matchers.StringMatcher stringMatcher,
 boolean inverted)

matches

public boolean matches(@Nullable
 String value)

Returns the matching result.