HttpPredicateRouterBuilder

java.lang.Object
- io.servicetalk.http.router.predicate.HttpPredicateRouterBuilder

All Implemented Interfaces:: RouteStarter

public final class HttpPredicateRouterBuilder
extends java.lang.Object
implements RouteStarter

Builds an 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 and Description

HttpPredicateRouterBuilder()

Constructors
Constructor and Description
`HttpPredicateRouterBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamingHttpService`	`buildStreaming()` Builds the `StreamingHttpService` that performs the configured routing.
`RouteContinuation`	`when(java.util.function.BiPredicate<ConnectionContext,StreamingHttpRequest> predicate)` Begin a route that matches `StreamingHttpRequest` and `ConnectionContext` with a user-specified `predicate`.
`RouteContinuation`	`when(java.util.function.Predicate<StreamingHttpRequest> predicate)` Begin a route that matches `StreamingHttpRequest`s with a user-specified `predicate`.
`CookieMatcher`	`whenCookie(java.lang.String name)` Begin a route with a `CookieMatcher` that matches against `HttpCookiePair`s with the name `name`.
`StringMultiValueMatcher`	`whenHeader(java.lang.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(java.lang.String path)` Begin a route that matches requests where the path is equal to `path`.
`RouteContinuation`	`whenPathIsOneOf(java.lang.String... paths)` Begin a route that matches requests where the path is equal to any of the specified `path`s.
`RouteContinuation`	`whenPathMatches(java.util.regex.Pattern pathRegex)` Begin a route that matches requests where the path matches the regex `pathRegex`.
`RouteContinuation`	`whenPathMatches(java.lang.String pathRegex)` Begin a route that matches requests where the path matches the regex `pathRegex`.
`RouteContinuation`	`whenPathStartsWith(java.lang.String pathPrefix)` Begin a route that matches requests where the path starts with `pathPrefix`.
`StringMultiValueMatcher`	`whenQueryParam(java.lang.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 Detail
  - HttpPredicateRouterBuilder
```
public HttpPredicateRouterBuilder()
```
- Method Detail
  - 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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.util.regex.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(java.lang.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(java.lang.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(java.lang.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(java.util.function.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(java.util.function.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.

Class HttpPredicateRouterBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpPredicateRouterBuilder

Method Detail

whenMethod

whenMethodIsOneOf

whenPathEquals

whenPathIsOneOf

whenPathStartsWith

whenPathMatches

whenPathMatches

whenQueryParam

whenHeader

whenCookie

whenIsSsl

whenIsNotSsl

when

when

buildStreaming