Package io.helidon.webserver

Interface RequestPredicate

All Superinterfaces:

java.util.function.Predicate<ServerRequest>

public interface RequestPredicate
extends java.util.function.Predicate<ServerRequest>

Fluent API to define complex request conditions. Suitable for definition of more complex routing in Routing.Rules.

Construct condition using whenRequest() method and fluent API. Then create request handler using thenApply(Handler))} method.

Examples

Creates Handler which executes provided logic only if request contains foo header and accepts text/plain. If not, then it calls req.next().

 RequestPredicate.whenRequest()
                 .containsHeader("foo")
                 .accepts(MediaType.TEXT_PLAIN)
                 .thenApply((req, resp) -> {
                     // Some logic
                 });
 

Creates Handler which executes provided logic only if request contains foo header. If not, then it executes 'otherwise logic' which, in this case, throws a RuntimeException.

 RequestPredicate.whenRequest()
                 .containsHeader("foo")
                 .thenApply((req, resp) -> {
                     // Some logic
                 })
                 .otherwise(req, resp) -> {
                     throw new RuntimeException("Missing 'foo' header!");
                 });
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RequestPredicate.ConditionalHandler A Handler which executes provided logic only if provided condition is satisfied.

Method Summary

Modifier and Type	Method and Description
RequestPredicate	accepts(MediaType... contentType) Accepts only requests accepting any of specified content types.
RequestPredicate	accepts(java.lang.String... contentType) Accepts only requests accepting any of specified content types.
default RequestPredicate	and(java.util.function.Predicate<? super ServerRequest> other)
static RequestPredicate	any(RequestPredicate... predicates) Combines several provided predicates in short circuit OR manner.
RequestPredicate	containsCookie(java.lang.String cookieName) Accepts only requests with specified cookie name.
RequestPredicate	containsCookie(java.lang.String cookieName, java.util.function.Predicate<java.lang.String> cookieValuePredicate) Accepts only requests with specified cookie containing valid value.
RequestPredicate	containsCookie(java.lang.String cookieName, java.lang.String value) Accepts only requests with specified cookie containing valid value.
RequestPredicate	containsHeader(java.lang.String headerName) Accepts only requests with specified header name.
RequestPredicate	containsHeader(java.lang.String headerName, java.util.function.Predicate<java.lang.String> headerValuePredicate) Accepts only requests with specified header containing valid value.
RequestPredicate	containsHeader(java.lang.String headerName, java.lang.String value) Accepts only requests with specified header containing valid value.
RequestPredicate	containsQueryParameter(java.lang.String queryParameterName) Accepts only requests with specified query parameter.
RequestPredicate	containsQueryParameter(java.lang.String queryParameterName, java.util.function.Predicate<java.lang.String> parameterValuePredicate) Accepts only requests with specified query parameter.
RequestPredicate	containsQueryParameter(java.lang.String queryParameterName, java.lang.String value) Accepts only requests with specified query parameter.
RequestPredicate	hasContentType(java.lang.String... contentType) Accepts only requests of any specified content types.
RequestPredicate	is(java.util.function.Predicate<? super ServerRequest> requestPredicate) Accepts by free form condition.
RequestPredicate	isOfMethod(java.lang.String... methodNames) Accepts only requests with one of specified HTTP methods.
default RequestPredicate	negate()
default RequestPredicate	or(java.util.function.Predicate<? super ServerRequest> other)
RequestPredicate.ConditionalHandler	thenApply(Handler handler) Creates request-response handler/filter which calls provided handler only if this predicate accepts provided request, otherwise call ServerRequest.next() method.
static RequestPredicate	whenRequest() Creates new empty instance RequestPredicate instance.

Methods inherited from interface java.util.function.Predicate

isEqual, test

Method Detail

isOfMethod

RequestPredicate isOfMethod(java.lang.String... methodNames)

Accepts only requests with one of specified HTTP methods.

Parameters:

methodNames - Acceptable method names.

Returns:

New enhanced instance.

containsHeader

RequestPredicate containsHeader(java.lang.String headerName)

Accepts only requests with specified header name.

Parameters:

headerName - Header name.

Returns:

New enhanced instance.

containsHeader

RequestPredicate containsHeader(java.lang.String headerName,
                                java.util.function.Predicate<java.lang.String> headerValuePredicate)

Accepts only requests with specified header containing valid value.

If request contains more then one header instance, then value predicate is called for all instances. Request is accepted if ANY predicate call returns true.

Parameters:

headerName - Header name.

headerValuePredicate - Predicate for header value. Is called for all header values.

Returns:

New enhanced instance.

containsHeader

RequestPredicate containsHeader(java.lang.String headerName,
                                java.lang.String value)

Accepts only requests with specified header containing valid value.

If request contains more then one header instance, then value is tested for all instances. Request is accepted if ANY value equals to provided.

Parameters:

headerName - Header name.

value - Expected header value.

Returns:

New enhanced instance.

containsQueryParameter

RequestPredicate containsQueryParameter(java.lang.String queryParameterName)

Accepts only requests with specified query parameter.

Parameters:

queryParameterName - Query parameter

Returns:

New enhanced instance.

containsQueryParameter

RequestPredicate containsQueryParameter(java.lang.String queryParameterName,
                                        java.util.function.Predicate<java.lang.String> parameterValuePredicate)

Accepts only requests with specified query parameter.

Parameters:

queryParameterName - Query parameter name.

parameterValuePredicate - Predicate for a parameter value.

Returns:

New enhanced instance.

containsQueryParameter

RequestPredicate containsQueryParameter(java.lang.String queryParameterName,
                                        java.lang.String value)

Accepts only requests with specified query parameter.

Parameters:

queryParameterName - Query parameter name.

value - Expected value.

Returns:

New enhanced instance.

containsCookie

RequestPredicate containsCookie(java.lang.String cookieName)

Accepts only requests with specified cookie name.

Parameters:

cookieName - Cookie name.

Returns:

New enhanced instance.

containsCookie

RequestPredicate containsCookie(java.lang.String cookieName,
                                java.util.function.Predicate<java.lang.String> cookieValuePredicate)

Accepts only requests with specified cookie containing valid value.

Parameters:

cookieName - Header name.

cookieValuePredicate - Predicate for a cookie value.

Returns:

New enhanced instance.

containsCookie

RequestPredicate containsCookie(java.lang.String cookieName,
                                java.lang.String value)

Accepts only requests with specified cookie containing valid value.

Parameters:

cookieName - Header name.

value - Predicate for a cookie value.

Returns:

New enhanced instance.

accepts

RequestPredicate accepts(java.lang.String... contentType)

Accepts only requests accepting any of specified content types.

Parameters:

contentType - Content type.

Returns:

New enhanced instance.

accepts

RequestPredicate accepts(MediaType... contentType)

Accepts only requests accepting any of specified content types.

Parameters:

contentType - Content type.

Returns:

New enhanced instance.

hasContentType

RequestPredicate hasContentType(java.lang.String... contentType)

Accepts only requests of any specified content types.

Parameters:

contentType - Content type.

Returns:

New enhanced instance.

is

RequestPredicate is(java.util.function.Predicate<? super ServerRequest> requestPredicate)

Accepts by free form condition. Equivalent method for and(Predicate).

Parameters:

requestPredicate - A request predicate.

Returns:

New enhanced instance.

thenApply

RequestPredicate.ConditionalHandler thenApply(Handler handler)

Creates request-response handler/filter which calls provided handler only if this predicate accepts provided request, otherwise call ServerRequest.next() method.

Parameters:

handler - to apply if this instance accepts provided request.

Returns:

a conditional handler.

and

default RequestPredicate and(java.util.function.Predicate<? super ServerRequest> other)

Specified by:

and in interface java.util.function.Predicate<ServerRequest>

negate

default RequestPredicate negate()

Specified by:

negate in interface java.util.function.Predicate<ServerRequest>

or

default RequestPredicate or(java.util.function.Predicate<? super ServerRequest> other)

Specified by:

or in interface java.util.function.Predicate<ServerRequest>

whenRequest

static RequestPredicate whenRequest()

Creates new empty instance RequestPredicate instance. It can be used as a base for fluent construction of complex predicate.

Returns:

New empty instance (accepts all requests).

any

static RequestPredicate any(RequestPredicate... predicates)

Combines several provided predicates in short circuit OR manner.

Parameters:

predicates - to combine.

Returns:

Combined predicate.