Package io.micronaut.web.router

Class DefaultRouter

java.lang.Object

io.micronaut.web.router.DefaultRouter

All Implemented Interfaces:

HttpFilterResolver<RouteMatch<?>>, HttpServerFilterResolver<RouteMatch<?>>, Router

@Singleton
public class DefaultRouter
extends Object
implements Router, HttpServerFilterResolver<RouteMatch<?>>

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

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.http.filter.HttpFilterResolver

HttpFilterResolver.FilterEntry

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	applyDefaultPorts(List<Integer> ports)	Sets the ports the application will listen to by default.
<T, R> @NonNull Stream<UriRouteMatch<T,R>>	find(@NonNull HttpMethod httpMethod, @NonNull CharSequence uri, @Nullable HttpRequest<?> context)	Finds all possible routes for the given HTTP method and URI.
<T, R> @NonNull Stream<UriRouteMatch<T,R>>	find(@NonNull HttpRequest<?> request)	Finds all possible routes for the given HTTP request.
<T, R> @NonNull Stream<UriRouteMatch<T,R>>	find(@NonNull HttpRequest<?> request, @NonNull CharSequence uri)	Find method, that should be used for non-standard http methods.
<T, R> @NonNull List<UriRouteMatch<T,R>>	findAllClosest(@NonNull HttpRequest<?> request)	Finds the closest match for the given request.
<T, R> @NonNull List<UriRouteMatch<T,R>>	findAny(@NonNull HttpRequest<?> request)	Find any RouteMatch regardless of HTTP method.
<T, R> @NonNull Stream<UriRouteMatch<T,R>>	findAny(@NonNull CharSequence uri, @Nullable HttpRequest<?> request)	Find any RouteMatch regardless of HTTP method.
<T, R> UriRouteMatch<T,R>	findClosest(@NonNull HttpRequest<?> request)	Finds the closest match for the given request or null if none is found.
<R> Optional<RouteMatch<R>>	findErrorRoute(@NonNull Class<?> originatingClass, @NonNull Throwable error, HttpRequest<?> request)	Match a route to an error.
<R> Optional<RouteMatch<R>>	findErrorRoute(@NonNull Throwable error, HttpRequest<?> request)	Match a route to an error.
@NonNull List<GenericHttpFilter>	findFilters(@NonNull HttpRequest<?> request)	Find filters for the request.
@NonNull List<GenericHttpFilter>	findFilters(@NonNull HttpRequest<?> request, @Nullable RouteMatch<?> routeMatch)	Find filters for the request and a route match.
@NonNull List<GenericHttpFilter>	findPreMatchingFilters(@NonNull HttpRequest<?> request)	Find pre-matching filters for the request.
<R> Optional<RouteMatch<R>>	findStatusRoute(int statusCode, HttpRequest<?> request)	Found a RouteMatch for the given status code.
<R> Optional<RouteMatch<R>>	findStatusRoute(@NonNull HttpStatus status, HttpRequest<?> request)	Found a RouteMatch for the given HttpStatus code.
<R> Optional<RouteMatch<R>>	findStatusRoute(@NonNull Class<?> originatingClass, int statusCode, HttpRequest<?> request)	Found a RouteMatch for the given status code.
<R> Optional<RouteMatch<R>>	findStatusRoute(@NonNull Class<?> originatingClass, @NonNull HttpStatus status, HttpRequest<?> request)	Found a RouteMatch for the given HttpStatus code.
Set<Integer>	getExposedPorts()
List<HttpFilterResolver.FilterEntry>	resolveFilterEntries(RouteMatch<?> routeMatch)	Resolves the initial list of filters.
List<GenericHttpFilter>	resolveFilters(HttpRequest<?> request, List<HttpFilterResolver.FilterEntry> filterEntries)	Returns which filters should apply for the given request.
<T, R> @NonNull Optional<UriRouteMatch<T,R>>	route(@NonNull HttpMethod httpMethod, @NonNull CharSequence uri)	Finds the first possible route for the given HTTP method and URI.
<R> Optional<RouteMatch<R>>	route(@NonNull HttpStatus status)	Found a RouteMatch for the given HttpStatus code.
<R> Optional<RouteMatch<R>>	route(@NonNull Class<?> originatingClass, @NonNull HttpStatus status)	Found a RouteMatch for the given HttpStatus code.
<R> Optional<RouteMatch<R>>	route(@NonNull Class<?> originatingClass, @NonNull Throwable error)	Match a route to an error.
<R> Optional<RouteMatch<R>>	route(@NonNull Throwable error)	Match a route to an error.
@NonNull Stream<UriRouteInfo<?,?>>	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 Details

DefaultRouter

public DefaultRouter(RouteBuilder... builders)

Construct a new router for the given route builders.

Parameters:

builders - The builders

DefaultRouter

@Inject
public DefaultRouter(Collection<RouteBuilder> builders)

Construct a new router for the given route builders.

Parameters:

builders - The builders

Method Details

getExposedPorts

public Set<Integer> getExposedPorts()

Specified by:

getExposedPorts in interface Router

Returns:

The exposed ports.

applyDefaultPorts

public void applyDefaultPorts(List<Integer> ports)

Description copied from interface: Router

Sets the ports the application will listen to by default.

Specified by:

applyDefaultPorts in interface Router

Parameters:

ports - The default ports

find

@NonNull
public <T,
R> @NonNull Stream<UriRouteMatch<T,R>> find(@NonNull
 @NonNull HttpRequest<?> request,
 @NonNull
 @NonNull CharSequence uri)

Description copied from interface: Router

Find method, that should be used for non-standard http methods. For standards, it should act the same as Router.find(HttpMethod, CharSequence, HttpRequest)

Specified by:

find in interface Router

Type Parameters:

T - The target type.

R - The type of what

Parameters:

request - The request, that can have overridden HttpRequest.getMethodName()

uri - The URI route match.

Returns:

A Stream of possible Route instances.

find

@NonNull
public <T,
R> @NonNull Stream<UriRouteMatch<T,R>> find(@NonNull
 @NonNull HttpRequest<?> request)

Description copied from interface: Router

Finds all possible routes for the given HTTP request.

Specified by:

find in interface Router

Type Parameters:

T - The target type

R - The URI route match

Parameters:

request - The HTTP request

Returns:

A Stream of possible Route instances.

find

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

Description copied from interface: Router

Finds all 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

context - The optional HttpRequest context information to apply RouteMatchFilter.

Returns:

A Stream of possible Route instances.

uriRoutes

@NonNull
public @NonNull Stream<UriRouteInfo<?,?>> uriRoutes()

Description copied from interface: Router

Returns all UriRoutes.

Specified by:

uriRoutes in interface Router

Returns:

A Stream of all registered UriRoute instances.

findClosest

public <T,
R> UriRouteMatch<T,R> findClosest(@NonNull
 @NonNull HttpRequest<?> request)
                                     throws DuplicateRouteException

Description copied from interface: Router

Finds the closest match for the given request or null if none is found.

Specified by:

findClosest in interface Router

Type Parameters:

T - The target type

R - The type

Parameters:

request - The request

Returns:

A match or null, throws DuplicateRouteException on multiple routes.

Throws:

DuplicateRouteException

findAllClosest

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

Description copied from interface: Router

Finds the closest match for the given request.

Specified by:

findAllClosest in interface Router

Type Parameters:

T - The target type

R - The type

Parameters:

request - The request

Returns:

A List of possible Route instances.

route

@NonNull
public <T,
R> @NonNull Optional<UriRouteMatch<T,R>> route(@NonNull
 @NonNull HttpMethod httpMethod,
 @NonNull
 @NonNull 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(@NonNull
 @NonNull 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(@NonNull
 @NonNull Class<?> originatingClass,
 @NonNull
 @NonNull 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(@NonNull
 @NonNull Class<?> originatingClass,
 @NonNull
 @NonNull 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

findErrorRoute

public <R> Optional<RouteMatch<R>> findErrorRoute(@NonNull
 @NonNull Class<?> originatingClass,
 @NonNull
 @NonNull Throwable error,
 HttpRequest<?> request)

Description copied from interface: Router

Match a route to an error.

Specified by:

findErrorRoute in interface Router

Type Parameters:

R - The matched route

Parameters:

originatingClass - The class the error originates from

error - The error

request - The request

Returns:

The RouteMatch

findErrorRoute

public <R> Optional<RouteMatch<R>> findErrorRoute(@NonNull
 @NonNull Throwable error,
 HttpRequest<?> request)

Description copied from interface: Router

Match a route to an error.

Specified by:

findErrorRoute in interface Router

Type Parameters:

R - The matched route

Parameters:

error - The error

request - The request

Returns:

The RouteMatch

findStatusRoute

public <R> Optional<RouteMatch<R>> findStatusRoute(@NonNull
 @NonNull Class<?> originatingClass,
 @NonNull
 @NonNull HttpStatus status,
 HttpRequest<?> request)

Description copied from interface: Router

Found a RouteMatch for the given HttpStatus code.

Specified by:

findStatusRoute in interface Router

Type Parameters:

R - The matched route

Parameters:

originatingClass - The class the error originates from

status - The HTTP status

request - The request

Returns:

The RouteMatch

findStatusRoute

public <R> Optional<RouteMatch<R>> findStatusRoute(@NonNull
 @NonNull HttpStatus status,
 HttpRequest<?> request)

Description copied from interface: Router

Found a RouteMatch for the given HttpStatus code.

Specified by:

findStatusRoute in interface Router

Type Parameters:

R - The matched route

Parameters:

status - The HTTP status

request - The request

Returns:

The RouteMatch

findStatusRoute

public <R> Optional<RouteMatch<R>> findStatusRoute(@NonNull
 @NonNull Class<?> originatingClass,
 int statusCode,
 HttpRequest<?> request)

Description copied from interface: Router

Found a RouteMatch for the given status code.

Specified by:

findStatusRoute in interface Router

Type Parameters:

R - The matched route

Parameters:

originatingClass - The class the error originates from

statusCode - The HTTP status

request - The request

Returns:

The RouteMatch

findStatusRoute

public <R> Optional<RouteMatch<R>> findStatusRoute(int statusCode,
 HttpRequest<?> request)

Description copied from interface: Router

Found a RouteMatch for the given status code.

Specified by:

findStatusRoute in interface Router

Type Parameters:

R - The matched route

Parameters:

statusCode - The HTTP status code

request - The request

Returns:

The RouteMatch

route

public <R> Optional<RouteMatch<R>> route(@NonNull
 @NonNull 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

@NonNull
public @NonNull List<GenericHttpFilter> findFilters(@NonNull
 @NonNull HttpRequest<?> request)

Description copied from interface: Router

Find filters for the request.

Specified by:

findFilters in interface Router

Parameters:

request - The request

Returns:

filters

findFilters

@NonNull
public @NonNull List<GenericHttpFilter> findFilters(@NonNull
 @NonNull HttpRequest<?> request,
 @Nullable
 @Nullable RouteMatch<?> routeMatch)

Description copied from interface: Router

Find filters for the request and a route match.

Specified by:

findFilters in interface Router

Parameters:

request - The request

routeMatch - The route match

Returns:

filters

findPreMatchingFilters

@NonNull
public @NonNull List<GenericHttpFilter> findPreMatchingFilters(@NonNull
 @NonNull HttpRequest<?> request)

Description copied from interface: Router

Find pre-matching filters for the request.

Specified by:

findPreMatchingFilters in interface Router

Parameters:

request - The request

Returns:

filters

findAny

@NonNull
public <T,
R> @NonNull Stream<UriRouteMatch<T,R>> findAny(@NonNull
 @NonNull CharSequence uri,
 @Nullable
 @Nullable HttpRequest<?> request)

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

request - The optional HttpRequest context information to apply RouteMatchFilter.

Returns:

A stream of route matches

findAny

@NonNull
public <T,
R> @NonNull List<UriRouteMatch<T,R>> findAny(@NonNull
 @NonNull HttpRequest<?> request)

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:

request - The request

Returns:

A stream of route matches

resolveFilterEntries

public List<HttpFilterResolver.FilterEntry> resolveFilterEntries(RouteMatch<?> routeMatch)

Description copied from interface: HttpFilterResolver

Resolves the initial list of filters.

Specified by:

resolveFilterEntries in interface HttpFilterResolver<RouteMatch<?>>

Parameters:

routeMatch - The context

Returns:

The filters

resolveFilters

public List<GenericHttpFilter> resolveFilters(HttpRequest<?> request,
 List<HttpFilterResolver.FilterEntry> filterEntries)

Description copied from interface: HttpFilterResolver

Returns which filters should apply for the given request.

Specified by:

resolveFilters in interface HttpFilterResolver<RouteMatch<?>>

Parameters:

request - The request

filterEntries - the filter entries

Returns:

The list of filters