Package io.servicetalk.http.router.predicate.dsl

Interface RouteStarter

All Known Implementing Classes:

HttpPredicateRouterBuilder

public interface RouteStarter

Methods for starting a route.

Method Summary

Modifier and Type	Method	Description
StreamingHttpService	buildStreaming()	Builds the StreamingHttpService that performs the configured routing.
RouteContinuation	when(BiPredicate<ConnectionContext,StreamingHttpRequest> predicate)	Begin a route that matches StreamingHttpRequest and ConnectionContext with a user-specified predicate.
RouteContinuation	when(Predicate<StreamingHttpRequest> predicate)	Begin a route that matches StreamingHttpRequests with a user-specified predicate.
CookieMatcher	whenCookie(String name)	Begin a route with a CookieMatcher that matches against HttpCookiePairs with the name name.
StringMultiValueMatcher	whenHeader(CharSequence name)	Begin a route with a StringMultiValueMatcher that matches against the value(s) of the name headers.
RouteContinuation	whenIsNotSsl()	Begin a route that matches requests that are not over SSL/TLS.
RouteContinuation	whenIsSsl()	Begin a route that matches requests that are over SSL/TLS.
RouteContinuation	whenMethod(HttpRequestMethod method)	Begin a route that matches requests where the HttpRequestMethod is method.
RouteContinuation	whenMethodIsOneOf(HttpRequestMethod... methods)	Begin a route that matches requests where the HttpRequestMethod is one of the methods.
RouteContinuation	whenPathEquals(String path)	Begin a route that matches requests where the path is equal to path.
RouteContinuation	whenPathIsOneOf(String... paths)	Begin a route that matches requests where the path is equal to any of the specified paths.
RouteContinuation	whenPathMatches(String pathRegex)	Begin a route that matches requests where the path matches the regex pathRegex.
RouteContinuation	whenPathMatches(Pattern pathRegex)	Begin a route that matches requests where the path matches the regex pathRegex.
RouteContinuation	whenPathStartsWith(String pathPrefix)	Begin a route that matches requests where the path starts with pathPrefix.
StringMultiValueMatcher	whenQueryParam(String name)	Begin a route with a StringMultiValueMatcher that matches against the value(s) of the request parameter name.

Method Details

whenMethod

RouteContinuation whenMethod(HttpRequestMethod method)

Begin a route that matches requests where the HttpRequestMethod is method.

Parameters:

method - the method to match.

Returns:

RouteContinuation for the next steps of building a route.

whenMethodIsOneOf

RouteContinuation whenMethodIsOneOf(HttpRequestMethod... methods)

Begin a route that matches requests where the HttpRequestMethod is one of the methods.

Parameters:

methods - the methods to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathEquals

RouteContinuation whenPathEquals(String path)

Begin a route that matches requests where the path is equal to path.

Parameters:

path - the path to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathIsOneOf

RouteContinuation whenPathIsOneOf(String... paths)

Begin a route that matches requests where the path is equal to any of the specified paths.

Parameters:

paths - the paths to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathStartsWith

RouteContinuation whenPathStartsWith(String pathPrefix)

Begin a route that matches requests where the path starts with pathPrefix.

Parameters:

pathPrefix - the path prefix to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathMatches

RouteContinuation whenPathMatches(String pathRegex)

Begin a route that matches requests where the path matches the regex pathRegex.

Parameters:

pathRegex - the regex to match against the request path.

Returns:

RouteContinuation for the next steps of building a route.

whenPathMatches

RouteContinuation whenPathMatches(Pattern pathRegex)

Begin a route that matches requests where the path matches the regex pathRegex.

Parameters:

pathRegex - the regex to match against the request path.

Returns:

RouteContinuation for the next steps of building a route.

whenQueryParam

StringMultiValueMatcher whenQueryParam(String name)

Begin a route with a StringMultiValueMatcher that matches against the value(s) of the request parameter name.

Parameters:

name - the request parameter name that must be present in the request in order to continue evaluation of this route.

Returns:

StringMultiValueMatcher for the next steps of building a route.

whenHeader

StringMultiValueMatcher whenHeader(CharSequence name)

Begin a route with a StringMultiValueMatcher that matches against the value(s) of the name headers.

Parameters:

name - The header name that must be present in the request in order to continue evaluation of this route.

Returns:

StringMultiValueMatcher for the next steps of building a route.

whenCookie

CookieMatcher whenCookie(String name)

Begin a route with a CookieMatcher that matches against HttpCookiePairs with the name name.

Parameters:

name - the cookie name that must be present in the request in order to continue evaluation of this route.

Returns:

CookieMatcher for the next steps of building a route.

whenIsSsl

RouteContinuation whenIsSsl()

Begin a route that matches requests that are over SSL/TLS.

Returns:

RouteContinuation for the next steps of building a route.

whenIsNotSsl

RouteContinuation whenIsNotSsl()

Begin a route that matches requests that are not over SSL/TLS.

Returns:

RouteContinuation for the next steps of building a route.

when

RouteContinuation when(Predicate<StreamingHttpRequest> predicate)

Begin a route that matches StreamingHttpRequests with a user-specified predicate.

Parameters:

predicate - the predicate to evaluate against requests.

Returns:

RouteContinuation for the next steps of building a route.

when

RouteContinuation when(BiPredicate<ConnectionContext,StreamingHttpRequest> predicate)

Begin a route that matches StreamingHttpRequest and ConnectionContext with a user-specified predicate.

Parameters:

predicate - the predicate to evaluate against the request and connection context.

Returns:

RouteContinuation for the next steps of building a route.

buildStreaming

StreamingHttpService buildStreaming()

Builds the StreamingHttpService that performs the configured routing.

Returns:

the router StreamingHttpService.