Interface RouteStarter
-
- All Known Implementing Classes:
HttpPredicateRouterBuilder
public interface RouteStarter
Methods for starting a route.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StreamingHttpService
buildStreaming()
Builds theStreamingHttpService
that performs the configured routing.RouteContinuation
when(java.util.function.BiPredicate<ConnectionContext,StreamingHttpRequest> predicate)
Begin a route that matchesStreamingHttpRequest
andConnectionContext
with a user-specifiedpredicate
.RouteContinuation
when(java.util.function.Predicate<StreamingHttpRequest> predicate)
Begin a route that matchesStreamingHttpRequest
s with a user-specifiedpredicate
.CookieMatcher
whenCookie(java.lang.String name)
StringMultiValueMatcher
whenHeader(java.lang.CharSequence name)
Begin a route with aStringMultiValueMatcher
that matches against the value(s) of thename
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 theHttpRequestMethod
ismethod
.RouteContinuation
whenMethodIsOneOf(HttpRequestMethod... methods)
Begin a route that matches requests where theHttpRequestMethod
is one of themethods
.RouteContinuation
whenPathEquals(java.lang.String path)
Begin a route that matches requests where the path is equal topath
.RouteContinuation
whenPathIsOneOf(java.lang.String... paths)
Begin a route that matches requests where the path is equal to any of the specifiedpath
s.RouteContinuation
whenPathMatches(java.lang.String pathRegex)
Begin a route that matches requests where the path matches the regexpathRegex
.RouteContinuation
whenPathMatches(java.util.regex.Pattern pathRegex)
Begin a route that matches requests where the path matches the regexpathRegex
.RouteContinuation
whenPathStartsWith(java.lang.String pathPrefix)
Begin a route that matches requests where the path starts withpathPrefix
.StringMultiValueMatcher
whenQueryParam(java.lang.String name)
Begin a route with aStringMultiValueMatcher
that matches against the value(s) of the request parametername
.
-
-
-
Method Detail
-
whenMethod
RouteContinuation whenMethod(HttpRequestMethod method)
Begin a route that matches requests where theHttpRequestMethod
ismethod
.- 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 theHttpRequestMethod
is one of themethods
.- Parameters:
methods
- the methods to match.- Returns:
RouteContinuation
for the next steps of building a route.
-
whenPathEquals
RouteContinuation whenPathEquals(java.lang.String path)
Begin a route that matches requests where the path is equal topath
.- Parameters:
path
- the path to match.- Returns:
RouteContinuation
for the next steps of building a route.
-
whenPathIsOneOf
RouteContinuation whenPathIsOneOf(java.lang.String... paths)
Begin a route that matches requests where the path is equal to any of the specifiedpath
s.- Parameters:
paths
- the paths to match.- Returns:
RouteContinuation
for the next steps of building a route.
-
whenPathStartsWith
RouteContinuation whenPathStartsWith(java.lang.String pathPrefix)
Begin a route that matches requests where the path starts withpathPrefix
.- Parameters:
pathPrefix
- the path prefix to match.- Returns:
RouteContinuation
for the next steps of building a route.
-
whenPathMatches
RouteContinuation whenPathMatches(java.lang.String pathRegex)
Begin a route that matches requests where the path matches the regexpathRegex
.- Parameters:
pathRegex
- the regex to match against the request path.- Returns:
RouteContinuation
for the next steps of building a route.
-
whenPathMatches
RouteContinuation whenPathMatches(java.util.regex.Pattern pathRegex)
Begin a route that matches requests where the path matches the regexpathRegex
.- Parameters:
pathRegex
- the regex to match against the request path.- Returns:
RouteContinuation
for the next steps of building a route.
-
whenQueryParam
StringMultiValueMatcher whenQueryParam(java.lang.String name)
Begin a route with aStringMultiValueMatcher
that matches against the value(s) of the request parametername
.- 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(java.lang.CharSequence name)
Begin a route with aStringMultiValueMatcher
that matches against the value(s) of thename
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(java.lang.String 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(java.util.function.Predicate<StreamingHttpRequest> predicate)
Begin a route that matchesStreamingHttpRequest
s with a user-specifiedpredicate
.- Parameters:
predicate
- the predicate to evaluate against requests.- Returns:
RouteContinuation
for the next steps of building a route.
-
when
RouteContinuation when(java.util.function.BiPredicate<ConnectionContext,StreamingHttpRequest> predicate)
Begin a route that matchesStreamingHttpRequest
andConnectionContext
with a user-specifiedpredicate
.- 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 theStreamingHttpService
that performs the configured routing.- Returns:
- the router
StreamingHttpService
.
-
-