io.micronaut.web.router

Interface Route

All Known Subinterfaces:

ErrorRoute, MethodBasedRoute, ResourceRoute, StatusRoute, UriRoute

public interface Route

Represents a Route definition constructed by a RouteBuilder.

Since:

1.0

Author:

Graeme Rocher

See Also:

RouteBuilder, ResourceRoute

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<MediaType>	DEFAULT_PRODUCES The default media type produced by routes.

Method Summary

Modifier and Type	Method and Description
default Route	acceptAll() Deprecated. Use consumesAll() instead.
Route	body(Argument<?> argument) The name of the argument to the route that is the request body.
Route	body(java.lang.String argument) The name of the argument to the route that is the request body.
Route	consumes(MediaType... mediaType) Applies the given accepted media type the route.
Route	consumesAll() Accept all MediaType references.
default java.util.List<MediaType>	getConsumes() The media types able to produced by this route.
default java.util.List<MediaType>	getProduces() The media types able to produced by this route.
Route	nest(java.lang.Runnable nested) Defines routes nested within this route.
Route	produces(MediaType... mediaType) Applies the given accepted media type the route.
Route	where(java.util.function.Predicate<HttpRequest<?>> condition) Match this Route only if the given predicate is true.

Field Detail

DEFAULT_PRODUCES

static final java.util.List<MediaType> DEFAULT_PRODUCES

The default media type produced by routes.

Method Detail

consumes

Route consumes(MediaType... mediaType)

Applies the given accepted media type the route.

Parameters:

mediaType - The media type

Returns:

A new route with the media type applied

produces

Route produces(MediaType... mediaType)

Applies the given accepted media type the route.

Parameters:

mediaType - The media type

Returns:

A new route with the media type applied

consumesAll

Route consumesAll()

Accept all MediaType references.

Returns:

A new route with the media type applied

nest

Route nest(java.lang.Runnable nested)

Defines routes nested within this route.

Parameters:

nested - The nested routes

Returns:

This route

where

Route where(java.util.function.Predicate<HttpRequest<?>> condition)

Match this Route only if the given predicate is true.

Parameters:

condition - The condition which accepts a HttpRequest

Returns:

This route

body

Route body(java.lang.String argument)

The name of the argument to the route that is the request body.

Parameters:

argument - The argument

Returns:

This route

body

Route body(Argument<?> argument)

The name of the argument to the route that is the request body.

Parameters:

argument - The argument

Returns:

This route

getProduces

default java.util.List<MediaType> getProduces()

The media types able to produced by this route.

Returns:

A list of MediaType that this route can produce

getConsumes

default java.util.List<MediaType> getConsumes()

The media types able to produced by this route.

Returns:

A list of MediaType that this route can produce

acceptAll

@Deprecated
default Route acceptAll()

Deprecated. Use consumesAll() instead.

Accept all MediaType references.

Returns:

A new route with the media type applied