io.micronaut.web.router

Interface Router

All Known Implementing Classes:

DefaultRouter, FilteredRouter

public interface Router

Core Router interface that allows discovery of a route given an HTTP method and URI.

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method and Description
default <T,R> Optional<UriRouteMatch<T,R>>	DELETE(CharSequence uri) Find the first RouteMatch route for an HttpMethod.DELETE method and the given URI.
<T,R> Stream<UriRouteMatch<T,R>>	find(HttpMethod httpMethod, CharSequence uri) Finds all of the possible routes for the given HTTP method and URI.
default <T,R> Stream<UriRouteMatch<T,R>>	find(HttpMethod httpMethod, CharSequence uri, HttpRequest<?> context) Finds all of the possible routes for the given HTTP method and URI.
default <T,R> Stream<UriRouteMatch<T,R>>	find(HttpMethod httpMethod, URI uri) Finds all of the possible routes for the given HTTP method and URI.
default <T,R> Stream<UriRouteMatch<T,R>>	find(HttpRequest<?> request) Finds all of the possible routes for the given HTTP request.
<T,R> List<UriRouteMatch<T,R>>	findAllClosest(HttpRequest<?> request) Finds the closest match for the given request.
<T,R> Stream<UriRouteMatch<T,R>>	findAny(CharSequence uri) Find any RouteMatch regardless of HTTP method.
default <T,R> Stream<UriRouteMatch<T,R>>	findAny(CharSequence uri, HttpRequest<?> context) Find any RouteMatch regardless of HTTP method.
List<HttpFilter>	findFilters(HttpRequest<?> request) Build a filtered Publisher for an action.
default <T,R> Optional<UriRouteMatch<T,R>>	GET(CharSequence uri) Find the first RouteMatch route for an HttpMethod.GET method and the given URI.
default <T,R> Optional<UriRouteMatch<T,R>>	HEAD(CharSequence uri) Find the first RouteMatch route for an HttpMethod.HEAD method and the given URI.
default <T,R> Optional<UriRouteMatch<T,R>>	OPTIONS(CharSequence uri) Find the first RouteMatch route for an HttpMethod.OPTIONS method and the given URI.
default <T,R> Optional<UriRouteMatch<T,R>>	PATCH(CharSequence uri) Find the first RouteMatch route for an HttpMethod.PATCH method and the given URI.
default <T,R> Optional<UriRouteMatch<T,R>>	POST(CharSequence uri) Find the first RouteMatch route for an HttpMethod.POST method and the given URI.
default <T,R> Optional<UriRouteMatch<T,R>>	PUT(CharSequence uri) Find the first RouteMatch route for an HttpMethod.PUT method and the given URI.
<R> Optional<RouteMatch<R>>	route(Class originatingClass, HttpStatus status) Found a RouteMatch for the given HttpStatus code.
<R> Optional<RouteMatch<R>>	route(Class originatingClass, Throwable error) Match a route to an error.
<T,R> Optional<UriRouteMatch<T,R>>	route(HttpMethod httpMethod, CharSequence uri) Finds the first possible route for the given HTTP method and URI.
<R> Optional<RouteMatch<R>>	route(HttpStatus status) Found a RouteMatch for the given HttpStatus code.
<R> Optional<RouteMatch<R>>	route(Throwable error) Match a route to an error.
Stream<UriRoute>	uriRoutes() Returns all UriRoutes.

Method Detail

findAny

@Nonnull
<T,R> Stream<UriRouteMatch<T,R>> findAny(@Nonnull
                                                  CharSequence uri)

Find any RouteMatch regardless of HTTP method.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

A stream of route matches

findAny

@Nonnull
default <T,R> Stream<UriRouteMatch<T,R>> findAny(@Nonnull
                                                          CharSequence uri,
                                                          @Nullable
                                                          HttpRequest<?> context)

Find any RouteMatch regardless of HTTP method.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

context - The optional HttpRequest context information to apply RouteMatchFilter.

Returns:

A stream of route matches

find

@Nonnull
<T,R> Stream<UriRouteMatch<T,R>> find(@Nonnull
                                               HttpMethod httpMethod,
                                               @Nonnull
                                               CharSequence uri)

Finds all of the possible routes for the given HTTP method and URI.

Type Parameters:

T - The target type

R - The type

Parameters:

httpMethod - The HTTP method

uri - The URI route match

Returns:

A Stream of possible Route instances.

find

@Nonnull
default <T,R> Stream<UriRouteMatch<T,R>> find(@Nonnull
                                                       HttpMethod httpMethod,
                                                       @Nonnull
                                                       CharSequence uri,
                                                       @Nullable
                                                       HttpRequest<?> context)

Finds all of the possible routes for the given HTTP method and URI.

Type Parameters:

T - The target type

R - The type

Parameters:

httpMethod - The HTTP method

uri - The URI route match

context - The optional HttpRequest context information to apply RouteMatchFilter.

Returns:

A Stream of possible Route instances.

findAllClosest

@Nonnull
<T,R> List<UriRouteMatch<T,R>> findAllClosest(@Nonnull
                                                       HttpRequest<?> request)

Finds the closest match for the given request.

Type Parameters:

T - The target type

R - The type

Parameters:

request - The request

Returns:

A List of possible Route instances.

Since:

1.2.1

uriRoutes

@Nonnull
Stream<UriRoute> uriRoutes()

Returns all UriRoutes.

Returns:

A Stream of all registered UriRoute instances.

route

<T,R> Optional<UriRouteMatch<T,R>> route(@Nonnull
                                         HttpMethod httpMethod,
                                         @Nonnull
                                         CharSequence uri)

Finds the first possible route for the given HTTP method and URI.

Type Parameters:

T - The target type

R - The URI route match

Parameters:

httpMethod - The HTTP method

uri - The URI

Returns:

The route match

route

<R> Optional<RouteMatch<R>> route(@Nonnull
                                  HttpStatus status)

Found a RouteMatch for the given HttpStatus code.

Type Parameters:

R - The matched route

Parameters:

status - The HTTP status

Returns:

The RouteMatch

route

<R> Optional<RouteMatch<R>> route(@Nonnull
                                  Class originatingClass,
                                  @Nonnull
                                  HttpStatus status)

Found a RouteMatch for the given HttpStatus code.

Type Parameters:

R - The matched route

Parameters:

originatingClass - The class the error originates from

status - The HTTP status

Returns:

The RouteMatch

route

<R> Optional<RouteMatch<R>> route(@Nonnull
                                  Throwable error)

Match a route to an error.

Type Parameters:

R - The matched route

Parameters:

error - The error

Returns:

The RouteMatch

route

<R> Optional<RouteMatch<R>> route(@Nonnull
                                  Class originatingClass,
                                  @Nonnull
                                  Throwable error)

Match a route to an error.

Type Parameters:

R - The matched route

Parameters:

originatingClass - The class the error originates from

error - The error

Returns:

The RouteMatch

findFilters

@Nonnull
List<HttpFilter> findFilters(@Nonnull
                                      HttpRequest<?> request)

Build a filtered Publisher for an action.

Parameters:

request - The request

Returns:

A new filtered publisher

GET

default <T,R> Optional<UriRouteMatch<T,R>> GET(@Nonnull
                                               CharSequence uri)

Find the first RouteMatch route for an HttpMethod.GET method and the given URI.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

POST

default <T,R> Optional<UriRouteMatch<T,R>> POST(@Nonnull
                                                CharSequence uri)

Find the first RouteMatch route for an HttpMethod.POST method and the given URI.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

PUT

default <T,R> Optional<UriRouteMatch<T,R>> PUT(@Nonnull
                                               CharSequence uri)

Find the first RouteMatch route for an HttpMethod.PUT method and the given URI.

Type Parameters:

T - The target type

R - The URI route match

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

PATCH

default <T,R> Optional<UriRouteMatch<T,R>> PATCH(@Nonnull
                                                 CharSequence uri)

Find the first RouteMatch route for an HttpMethod.PATCH method and the given URI.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

DELETE

default <T,R> Optional<UriRouteMatch<T,R>> DELETE(@Nonnull
                                                  CharSequence uri)

Find the first RouteMatch route for an HttpMethod.DELETE method and the given URI.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

OPTIONS

default <T,R> Optional<UriRouteMatch<T,R>> OPTIONS(@Nonnull
                                                   CharSequence uri)

Find the first RouteMatch route for an HttpMethod.OPTIONS method and the given URI.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

HEAD

default <T,R> Optional<UriRouteMatch<T,R>> HEAD(@Nonnull
                                                CharSequence uri)

Find the first RouteMatch route for an HttpMethod.HEAD method and the given URI.

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

An Optional of RouteMatch

find

@Nonnull
default <T,R> Stream<UriRouteMatch<T,R>> find(@Nonnull
                                                       HttpMethod httpMethod,
                                                       @Nonnull
                                                       URI uri)

Finds all of the possible routes for the given HTTP method and URI.

Type Parameters:

T - The target type

R - The URI route match

Parameters:

httpMethod - The HTTP method

uri - The URI

Returns:

A Stream of possible Route instances.

find

@Nonnull
default <T,R> Stream<UriRouteMatch<T,R>> find(@Nonnull
                                                       HttpRequest<?> request)

Finds all of the possible routes for the given HTTP request.

Type Parameters:

T - The target type

R - The URI route match

Parameters:

request - The HTTP request

Returns:

A Stream of possible Route instances.