Package io.servicetalk.http.router.predicate

Class HttpPredicateRouterBuilder

java.lang.Object

io.servicetalk.http.router.predicate.HttpPredicateRouterBuilder

All Implemented Interfaces:

RouteStarter

public final class HttpPredicateRouterBuilder
extends Object
implements RouteStarter

Builds a StreamingHttpService which routes requests to a number of other StreamingHttpServices based on user specified criteria.

eg.

 final StreamingHttpService<HttpChunk, HttpChunk> router = new HttpPredicateRouterBuilder<HttpChunk, HttpChunk>()
     .whenMethod(GET).andPathStartsWith("/a/").thenRouteTo(serviceA)
     .whenMethod(GET).andPathStartsWith("/b/").thenRouteTo(serviceB)
     .whenMethod(POST).thenRouteTo(serviceC)
     .buildStreaming();
 

If no routes match, a default service is used, which returns a 404 response.

Constructor Summary

Constructors

Constructor	Description
HttpPredicateRouterBuilder()

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.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpPredicateRouterBuilder

public HttpPredicateRouterBuilder()

Method Details

whenMethod

public RouteContinuation whenMethod(HttpRequestMethod method)

Description copied from interface: RouteStarter

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

Specified by:

whenMethod in interface RouteStarter

Parameters:

method - the method to match.

Returns:

RouteContinuation for the next steps of building a route.

whenMethodIsOneOf

public RouteContinuation whenMethodIsOneOf(HttpRequestMethod... methods)

Description copied from interface: RouteStarter

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

Specified by:

whenMethodIsOneOf in interface RouteStarter

Parameters:

methods - the methods to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathEquals

public RouteContinuation whenPathEquals(String path)

Description copied from interface: RouteStarter

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

Specified by:

whenPathEquals in interface RouteStarter

Parameters:

path - the path to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathIsOneOf

public RouteContinuation whenPathIsOneOf(String... paths)

Description copied from interface: RouteStarter

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

Specified by:

whenPathIsOneOf in interface RouteStarter

Parameters:

paths - the paths to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathStartsWith

public RouteContinuation whenPathStartsWith(String pathPrefix)

Description copied from interface: RouteStarter

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

Specified by:

whenPathStartsWith in interface RouteStarter

Parameters:

pathPrefix - the path prefix to match.

Returns:

RouteContinuation for the next steps of building a route.

whenPathMatches

public RouteContinuation whenPathMatches(String pathRegex)

Description copied from interface: RouteStarter

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

Specified by:

whenPathMatches in interface RouteStarter

Parameters:

pathRegex - the regex to match against the request path.

Returns:

RouteContinuation for the next steps of building a route.

whenPathMatches

public RouteContinuation whenPathMatches(Pattern pathRegex)

Description copied from interface: RouteStarter

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

Specified by:

whenPathMatches in interface RouteStarter

Parameters:

pathRegex - the regex to match against the request path.

Returns:

RouteContinuation for the next steps of building a route.

whenQueryParam

public StringMultiValueMatcher whenQueryParam(String name)

Description copied from interface: RouteStarter

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

Specified by:

whenQueryParam in interface RouteStarter

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

public StringMultiValueMatcher whenHeader(CharSequence name)

Description copied from interface: RouteStarter

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

Specified by:

whenHeader in interface RouteStarter

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

public CookieMatcher whenCookie(String name)

Description copied from interface: RouteStarter

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

Specified by:

whenCookie in interface RouteStarter

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

public RouteContinuation whenIsSsl()

Description copied from interface: RouteStarter

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

Specified by:

whenIsSsl in interface RouteStarter

Returns:

RouteContinuation for the next steps of building a route.

whenIsNotSsl

public RouteContinuation whenIsNotSsl()

Description copied from interface: RouteStarter

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

Specified by:

whenIsNotSsl in interface RouteStarter

Returns:

RouteContinuation for the next steps of building a route.

when

public RouteContinuation when(Predicate<StreamingHttpRequest> predicate)

Description copied from interface: RouteStarter

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

Specified by:

when in interface RouteStarter

Parameters:

predicate - the predicate to evaluate against requests.

Returns:

RouteContinuation for the next steps of building a route.

when

public RouteContinuation when(BiPredicate<ConnectionContext,StreamingHttpRequest> predicate)

Description copied from interface: RouteStarter

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

Specified by:

when in interface RouteStarter

Parameters:

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

Returns:

RouteContinuation for the next steps of building a route.

buildStreaming

public StreamingHttpService buildStreaming()

Description copied from interface: RouteStarter

Builds the StreamingHttpService that performs the configured routing.

Specified by:

buildStreaming in interface RouteStarter

Returns:

the router StreamingHttpService.