Top Description Inners Fields Constructors Methods
io.undertow.predicate

public Class RegularExpressionPredicate

extends Object
implements Predicate
Class Inheritance
All Implemented Interfaces
io.undertow.predicate.Predicate
Imports
java.util.HashMap, .HashSet, .Map, .Set, .TreeMap, java.util.regex.Matcher, .Pattern, io.undertow.attribute.ExchangeAttribute, .ExchangeAttributes, io.undertow.server.HttpServerExchange, io.undertow.UndertowLogger
A predicate that does a regex match against an exchange.

By default this match is done against the relative URI, however it is possible to set it to match against other exchange attributes.

Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
RegularExpressionPredicate.Builder

Field Summary

Modifier and TypeField and Description
private final ExchangeAttribute
matchAttribute

private final Pattern
pattern

private final boolean
requireFullMatch

private static final boolean
traceEnabled

Constructor Summary

AccessConstructor and Description
public
RegularExpressionPredicate(final String regex, final ExchangeAttribute matchAttribute, final boolean requireFullMatch, boolean caseSensitive)

public
RegularExpressionPredicate(final String regex, final ExchangeAttribute matchAttribute, final boolean requireFullMatch)

public
RegularExpressionPredicate(final String regex, final ExchangeAttribute matchAttribute)

Method Summary

Modifier and TypeMethod and Description
public boolean
resolve(final HttpServerExchange value)

Implements io.undertow.predicate.Predicate.resolve.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

matchAttributeback to summary
private final ExchangeAttribute matchAttribute
patternback to summary
private final Pattern pattern
requireFullMatchback to summary
private final boolean requireFullMatch
traceEnabledback to summary
private static final boolean traceEnabled

Constructor Detail

RegularExpressionPredicateback to summary
public RegularExpressionPredicate(final String regex, final ExchangeAttribute matchAttribute, final boolean requireFullMatch, boolean caseSensitive)
RegularExpressionPredicateback to summary
public RegularExpressionPredicate(final String regex, final ExchangeAttribute matchAttribute, final boolean requireFullMatch)
RegularExpressionPredicateback to summary
public RegularExpressionPredicate(final String regex, final ExchangeAttribute matchAttribute)

Method Detail

resolveback to summary
public boolean resolve(final HttpServerExchange value)

Implements io.undertow.predicate.Predicate.resolve.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
io.undertow.predicate back to summary

public Class RegularExpressionPredicate.Builder

extends Object
implements PredicateBuilder
Class Inheritance
All Implemented Interfaces
io.undertow.predicate.PredicateBuilder

Constructor Summary

AccessConstructor and Description
public
Builder()

Method Summary

Modifier and TypeMethod and Description
public Predicate
build(final Map<String, Object>
The predicate config
config)

Implements io.undertow.predicate.PredicateBuilder.build.

Creates a predicate

public String
defaultParameter()

Implements io.undertow.predicate.PredicateBuilder.defaultParameter.

public String
name()

Implements io.undertow.predicate.PredicateBuilder.name.

The string representation of the predicate name.

public Map<String, Class<?>>
parameters()

Implements io.undertow.predicate.PredicateBuilder.parameters.

Returns a map of parameters and their types.

public Set<String>
requiredParameters()

Implements io.undertow.predicate.PredicateBuilder.requiredParameters.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Builderback to summary
public Builder()

Method Detail

buildback to summary
public Predicate build(final Map<String, Object> config)

Implements io.undertow.predicate.PredicateBuilder.build.

Doc from io.undertow.predicate.PredicateBuilder.build.

Creates a predicate

Parameters
config:Map<String, Object>

The predicate config

Returns:Predicate

The new predicate

Annotations
@Override
defaultParameterback to summary
public String defaultParameter()

Implements io.undertow.predicate.PredicateBuilder.defaultParameter.

Returns:String

Doc from io.undertow.predicate.PredicateBuilder.defaultParameter.

The default parameter name, or null if it does not have a default parameter

Annotations
@Override
nameback to summary
public String name()

Implements io.undertow.predicate.PredicateBuilder.name.

Doc from io.undertow.predicate.PredicateBuilder.name.

The string representation of the predicate name.

Returns:String

The predicate name

Annotations
@Override
parametersback to summary
public Map<String, Class<?>> parameters()

Implements io.undertow.predicate.PredicateBuilder.parameters.

Doc from io.undertow.predicate.PredicateBuilder.parameters.

Returns a map of parameters and their types.

Annotations
@Override
requiredParametersback to summary
public Set<String> requiredParameters()

Implements io.undertow.predicate.PredicateBuilder.requiredParameters.

Returns:Set<String>

Doc from io.undertow.predicate.PredicateBuilder.requiredParameters.

The required parameters

Annotations
@Override