Undertow 2.3.12.Final · io.undertow.predicate.Predicates

Access	Constructor and Description
private	Predicates()

Method Summary

Modifier and Type	Method and Description
public static Predicate	and(final Predicate... predicates) Creates a predicate that returns true if an only if the given predicates all return true.
public static Predicate	Returns: A predicate that returns true if authentication is required authRequired() A predicate that returns true if authentication is required
public static Predicate	contains(final ExchangeAttribute The exchange attribute. attribute, final String... The values to check for. values) Returns true if the given attribute is present and contains one of the provided value.
public static Predicate	Returns: A new EqualsPredicate. equals(final ExchangeAttribute[] to be compared in the predictor. attributes) Creates a procedure that returns true if the given ExchangeAttributes are equal.
public static Predicate	exists(final ExchangeAttribute The attribute to check whether it exists or not. attribute) Return a predicate that will return true if the given attribute is not null and not empty.
public static Predicate	falsePredicate() Predicate which always returns false.
public static Predicate	maxContentSize(final long size) Deprecated Predicate that returns true if the Content-Size of a request is above a given value.
public static Predicate	minContentSize(final long size) Deprecated Predicate that returns true if the Content-Size of a request is below a given value.
public static Predicate	not(final Predicate predicate) Creates a predicate that returns true if the given predicate returns false.
public static Predicate	or(final Predicate... predicates) Creates a predicate that returns true if any of the given predicates return true.
public static Predicate	Returns: The predicate parse(final String The prediate string predicate) parses the predicate string, and returns the result, using the TCCL to load predicate definitions
public static Predicate	Returns: The predicate parse(final String The prediate string predicate, ClassLoader The class loader to load the predicates from classLoader) parses the predicate string, and returns the result
public static Predicate	path(final String path) Creates a predicate that returns true if the given path matches exactly.
public static Predicate	paths(final String... paths) Creates a predicate that returns true if any of the given paths match exactly.
public static Predicate	prefix(final String path) Creates a predicate that returns true if the given relative path starts with the provided prefix.
public static Predicate	prefixes(final String... paths) Creates a predicate that returns true if the relative request path matches any of the provided prefixes.
public static Predicate	regex(final ExchangeAttribute The exchange attribute to check against. attribute, final String The pattern to look for. pattern) Creates a predicate that matches the given attribute against a regex.
public static Predicate	regex(final ExchangeAttribute The attribute to check against. attribute, final String The pattern to look for. pattern, boolean If a full match is required in order to return true. requireFullMatch) Creates a predicate that matches the given attribute against a regex.
public static Predicate	regex(final String The attribute to check against. attribute, final String The pattern to look for. pattern, final ClassLoader classLoader, final boolean If a full match is required in order to return true. requireFullMatch) Creates a predicate that matches the given attribute against a regex.
public static Predicate	requestLargerThan(final long size) Predicate that returns true if the Content-Size of a request is larger than a given size.
public static Predicate	requestSmallerThan(final long size) Predicate that returns true if the Content-Size of a request is smaller than a given size.
public static Predicate	Returns: A predicate that returns true if the request is secure secure()
public static Predicate	suffix(final String path) Creates a predicate that returns true if the request path ends with the provided suffix.
public static Predicate	suffixes(final String... paths) Creates a predicate that returns true if the request path ends with any of the provided suffixes.
public static Predicate	truePredicate() Prediction which always returns true

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Predicates	back to summary
private Predicates()

Method Detail

and	back to summary
public static Predicate and(final Predicate... predicates) Creates a predicate that returns true if an only if the given predicates all return true.

authRequired	back to summary
public static Predicate authRequired() A predicate that returns true if authentication is required Returns:Predicate A predicate that returns true if authentication is required

authRequired

back to summary

public static Predicate authRequired()

A predicate that returns true if authentication is required

Returns:Predicate: A predicate that returns true if authentication is required

contains	back to summary
public static Predicate contains(final ExchangeAttribute attribute, final String... values) Returns true if the given attribute is present and contains one of the provided value. Parameters attribute:ExchangeAttribute The exchange attribute. values:String[] The values to check for.

contains

back to summary

public static Predicate contains(final ExchangeAttribute attribute, final String... values)

Returns true if the given attribute is present and contains one of the provided value.

Parameters

attribute:ExchangeAttribute: The exchange attribute.
values:String[]: The values to check for.

equals	back to summary
public static Predicate equals(final ExchangeAttribute[] attributes) Creates a procedure that returns true if the given ExchangeAttributes are equal. Parameters attributes:ExchangeAttribute[] to be compared in the predictor. Returns:Predicate A new EqualsPredicate.

equals

back to summary

public static Predicate equals(final ExchangeAttribute[] attributes)

Creates a procedure that returns true if the given ExchangeAttributes are equal.

Parameters

attributes:ExchangeAttribute[]: to be compared in the predictor.

Returns:Predicate

A new EqualsPredicate.

exists	back to summary
public static Predicate exists(final ExchangeAttribute attribute) Return a predicate that will return true if the given attribute is not null and not empty. Parameters attribute:ExchangeAttribute The attribute to check whether it exists or not.

exists

back to summary

public static Predicate exists(final ExchangeAttribute attribute)

Return a predicate that will return true if the given attribute is not null and not empty.

Parameters

attribute:ExchangeAttribute: The attribute to check whether it exists or not.

falsePredicate	back to summary
public static Predicate falsePredicate() Predicate which always returns false.

maxContentSize back to summary

maxContentSize	back to summary
public static Predicate maxContentSize(final long size) Deprecated Predicate that returns true if the Content-Size of a request is above a given value. Use `requestLargerThan(long)` instead. Annotations @Deprecated

public static Predicate maxContentSize(final long size)

Deprecated

Predicate that returns true if the Content-Size of a request is above a given value. Use requestLargerThan(long) instead.

Annotations

@Deprecated

minContentSize back to summary

minContentSize	back to summary
public static Predicate minContentSize(final long size) Deprecated Predicate that returns true if the Content-Size of a request is below a given value. Use `requestSmallerThan(long)` instead. Annotations @Deprecated

public static Predicate minContentSize(final long size)

Deprecated

Predicate that returns true if the Content-Size of a request is below a given value. Use requestSmallerThan(long) instead.

Annotations

@Deprecated

not	back to summary
public static Predicate not(final Predicate predicate) Creates a predicate that returns true if the given predicate returns false.

or	back to summary
public static Predicate or(final Predicate... predicates) Creates a predicate that returns true if any of the given predicates return true.

parse	back to summary
public static Predicate parse(final String predicate) parses the predicate string, and returns the result, using the TCCL to load predicate definitions Parameters predicate:String The prediate string Returns:Predicate The predicate

parse

back to summary

public static Predicate parse(final String predicate)

parses the predicate string, and returns the result, using the TCCL to load predicate definitions

Parameters

predicate:String: The prediate string

Returns:Predicate

The predicate

parse	back to summary
public static Predicate parse(final String predicate, ClassLoader classLoader) parses the predicate string, and returns the result Parameters predicate:String The prediate string classLoader:ClassLoader The class loader to load the predicates from Returns:Predicate The predicate

parse

back to summary

public static Predicate parse(final String predicate, ClassLoader classLoader)

parses the predicate string, and returns the result

Parameters

predicate:String: The prediate string
classLoader:ClassLoader: The class loader to load the predicates from

Returns:Predicate

The predicate

path	back to summary
public static Predicate path(final String path) Creates a predicate that returns true if the given path matches exactly.

paths	back to summary
public static Predicate paths(final String... paths) Creates a predicate that returns true if any of the given paths match exactly.

prefix	back to summary
public static Predicate prefix(final String path) Creates a predicate that returns true if the given relative path starts with the provided prefix.

prefixes	back to summary
public static Predicate prefixes(final String... paths) Creates a predicate that returns true if the relative request path matches any of the provided prefixes.

regex	back to summary
public static Predicate regex(final ExchangeAttribute attribute, final String pattern) Creates a predicate that matches the given attribute against a regex. A full match is not required Parameters attribute:ExchangeAttribute The exchange attribute to check against. pattern:String The pattern to look for.

regex

back to summary

public static Predicate regex(final ExchangeAttribute attribute, final String pattern)

Creates a predicate that matches the given attribute against a regex. A full match is not required

Parameters

attribute:ExchangeAttribute: The exchange attribute to check against.
pattern:String: The pattern to look for.

regex	back to summary
public static Predicate regex(final ExchangeAttribute attribute, final String pattern, boolean requireFullMatch) Creates a predicate that matches the given attribute against a regex. Parameters attribute:ExchangeAttribute The attribute to check against. pattern:String The pattern to look for. requireFullMatch:boolean If a full match is required in order to return true.

regex

back to summary

public static Predicate regex(final ExchangeAttribute attribute, final String pattern, boolean requireFullMatch)

Creates a predicate that matches the given attribute against a regex.

Parameters

attribute:ExchangeAttribute: The attribute to check against.
pattern:String: The pattern to look for.
requireFullMatch:boolean: If a full match is required in order to return true.

regex	back to summary
public static Predicate regex(final String attribute, final String pattern, final ClassLoader classLoader, final boolean requireFullMatch) Creates a predicate that matches the given attribute against a regex. Parameters attribute:String The attribute to check against. pattern:String The pattern to look for. requireFullMatch:boolean If a full match is required in order to return true.

regex

back to summary

public static Predicate regex(final String attribute, final String pattern, final ClassLoader classLoader, final boolean requireFullMatch)

Creates a predicate that matches the given attribute against a regex.

Parameters

attribute:String: The attribute to check against.
pattern:String: The pattern to look for.
requireFullMatch:boolean: If a full match is required in order to return true.

requestLargerThan	back to summary
public static Predicate requestLargerThan(final long size) Predicate that returns true if the Content-Size of a request is larger than a given size.

requestSmallerThan	back to summary
public static Predicate requestSmallerThan(final long size) Predicate that returns true if the Content-Size of a request is smaller than a given size.

secure	back to summary
public static Predicate secure() Returns:Predicate A predicate that returns true if the request is secure

suffix	back to summary
public static Predicate suffix(final String path) Creates a predicate that returns true if the request path ends with the provided suffix.

suffixes	back to summary
public static Predicate suffixes(final String... paths) Creates a predicate that returns true if the request path ends with any of the provided suffixes.

truePredicate	back to summary
public static Predicate truePredicate() Prediction which always returns true

public Class Predicates

Constructor Summary

Method Summary

Constructor Detail

Method Detail