io.micronaut.web.router

Class DefaultRouter

java.lang.Object

io.micronaut.web.router.DefaultRouter

All Implemented Interfaces:

Router

@Singleton
public class DefaultRouter
extends Object
implements Router

The default Router implementation. This implementation does not perform any additional caching of route discovery.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
DefaultRouter(Collection<RouteBuilder> builders) Construct a new router for the given route builders.
DefaultRouter(RouteBuilder... builders) Construct a new router for the given route builders.

Method Summary

Modifier and Type	Method and Description
<T,R> Stream<UriRouteMatch<T,R>>	find(HttpMethod httpMethod, CharSequence uri) Finds all of the possible routes for the given HTTP method and URI.
<T,R> Stream<UriRouteMatch<T,R>>	findAny(CharSequence uri) Find any RouteMatch regardless of HTTP method.
List<HttpFilter>	findFilters(HttpRequest<?> request) Build a filtered Publisher for an action.
<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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.web.router.Router

DELETE, find, GET, HEAD, OPTIONS, PATCH, POST, PUT

Constructor Detail

DefaultRouter

@Inject
public DefaultRouter(Collection<RouteBuilder> builders)

Construct a new router for the given route builders.

Parameters:

builders - The builders

DefaultRouter

public DefaultRouter(RouteBuilder... builders)

Construct a new router for the given route builders.

Parameters:

builders - The builders

Method Detail

find

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

Description copied from interface: Router

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

Specified by:

find in interface Router

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.

uriRoutes

public Stream<UriRoute> uriRoutes()

Description copied from interface: Router

Returns all UriRoutes.

Specified by:

uriRoutes in interface Router

Returns:

A Stream of all registered UriRoute instances.

route

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

Description copied from interface: Router

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

Specified by:

route in interface Router

Type Parameters:

T - The target type

R - The URI route match

Parameters:

httpMethod - The HTTP method

uri - The URI

Returns:

The route match

route

public <R> Optional<RouteMatch<R>> route(HttpStatus status)

Description copied from interface: Router

Found a RouteMatch for the given HttpStatus code.

Specified by:

route in interface Router

Type Parameters:

R - The matched route

Parameters:

status - The HTTP status

Returns:

The RouteMatch

route

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

Description copied from interface: Router

Found a RouteMatch for the given HttpStatus code.

Specified by:

route in interface Router

Type Parameters:

R - The matched route

Parameters:

originatingClass - The class the error originates from

status - The HTTP status

Returns:

The RouteMatch

route

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

Description copied from interface: Router

Match a route to an error.

Specified by:

route in interface Router

Type Parameters:

R - The matched route

Parameters:

originatingClass - The class the error originates from

error - The error

Returns:

The RouteMatch

route

public <R> Optional<RouteMatch<R>> route(Throwable error)

Description copied from interface: Router

Match a route to an error.

Specified by:

route in interface Router

Type Parameters:

R - The matched route

Parameters:

error - The error

Returns:

The RouteMatch

findFilters

public List<HttpFilter> findFilters(HttpRequest<?> request)

Description copied from interface: Router

Build a filtered Publisher for an action.

Specified by:

findFilters in interface Router

Parameters:

request - The request

Returns:

A new filtered publisher

findAny

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

Description copied from interface: Router

Find any RouteMatch regardless of HTTP method.

Specified by:

findAny in interface Router

Type Parameters:

T - The target type

R - The return type

Parameters:

uri - The URI

Returns:

A stream of route matches