public interface UriRoute extends Route, UriMatcher, Comparable<UriRoute>
DEFAULT_PRODUCES
Modifier and Type | Method and Description |
---|---|
UriRoute |
body(String argument)
The name of the argument to the route that is the request body.
|
UriRoute |
consumes(MediaType... mediaType)
Applies the given accepted media type the route.
|
UriRoute |
consumesAll()
Accept all
MediaType references. |
UriRoute |
exposedPort(int port)
The exposed port that the route applies to.
|
HttpMethod |
getHttpMethod() |
default String |
getHttpMethodName() |
Integer |
getPort() |
UriMatchTemplate |
getUriMatchTemplate() |
Optional<UriRouteMatch> |
match(String uri)
Match this route within the given URI and produce a
RouteMatch if a match is found. |
default Optional<UriRouteMatch> |
match(URI uri)
Match this route within the given URI and produce a
RouteMatch if a match is found. |
UriRoute |
nest(Runnable nested)
Defines routes nested within this route.
|
UriRoute |
produces(MediaType... mediaType)
Applies the given accepted media type the route.
|
UriRoute |
where(Predicate<HttpRequest<?>> condition)
Match this
Route only if the given predicate is true. |
body, getConsumes, getProduces
compareTo
HttpMethod getHttpMethod()
UriMatchTemplate getUriMatchTemplate()
UriMatchTemplate
used to match URIsdefault Optional<UriRouteMatch> match(URI uri)
RouteMatch
if a match is found.match
in interface UriMatcher
uri
- The URI The URIOptional
of RouteMatch
Optional<UriRouteMatch> match(String uri)
RouteMatch
if a match is found.match
in interface UriMatcher
uri
- The URI The URIOptional
of RouteMatch
UriRoute consumes(MediaType... mediaType)
Route
UriRoute produces(MediaType... mediaType)
Route
UriRoute consumesAll()
Route
MediaType
references.consumesAll
in interface Route
UriRoute where(Predicate<HttpRequest<?>> condition)
Route
Route
only if the given predicate is true.where
in interface Route
condition
- The condition which accepts a HttpRequest
UriRoute body(String argument)
Route
UriRoute exposedPort(int port)
port
- The port@Nullable Integer getPort()
default String getHttpMethodName()
getHttpMethod()
value for standard http methods.