io.micronaut.web.router

Class DefaultRouteBuilder

java.lang.Object

io.micronaut.web.router.DefaultRouteBuilder

All Implemented Interfaces:

RouteBuilder

Direct Known Subclasses:

AnnotatedFilterRouteBuilder, AnnotatedFunctionRouteBuilder, AnnotatedMethodRouteBuilder, DeleteEndpointRouteBuilder, ReadEndpointRouteBuilder, ServerWebSocketProcessor, WriteEndpointRouteBuilder

public abstract class DefaultRouteBuilder
extends Object
implements RouteBuilder

A DefaultRouteBuilder implementation for building roots.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.web.router.RouteBuilder

RouteBuilder.UriNamingStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static RouteBuilder.UriNamingStrategy	CAMEL_CASE_NAMING_STRATEGY A RouteBuilder.UriNamingStrategy where by camel case conventions are used.
protected ConversionService<?>	conversionService
protected Charset	defaultCharset
protected ExecutionHandleLocator	executionHandleLocator
protected static org.slf4j.Logger	LOG
protected RouteBuilder.UriNamingStrategy	uriNamingStrategy

Fields inherited from interface io.micronaut.web.router.RouteBuilder

ID

Constructor Summary

Constructors

Constructor and Description
DefaultRouteBuilder(ExecutionHandleLocator executionHandleLocator)
DefaultRouteBuilder(ExecutionHandleLocator executionHandleLocator, RouteBuilder.UriNamingStrategy uriNamingStrategy)
DefaultRouteBuilder(ExecutionHandleLocator executionHandleLocator, RouteBuilder.UriNamingStrategy uriNamingStrategy, ConversionService<?> conversionService)

Method Summary

Modifier and Type	Method and Description
FilterRoute	addFilter(String pathPattern, BeanLocator beanLocator, BeanDefinition<? extends HttpFilter> beanDefinition) Add a filter.
FilterRoute	addFilter(String pathPattern, Supplier<HttpFilter> filter) Add a filter.
protected UriRoute	buildBeanRoute(String httpMethodName, HttpMethod httpMethod, String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) A special case that is required for non standard http methods.
protected UriRoute	buildRoute(HttpMethod httpMethod, String uri, Class<?> type, String method, Class... parameterTypes) Build a route.
protected UriRoute	buildRoute(HttpMethod httpMethod, String uri, MethodExecutionHandle<?,Object> executableHandle) Build a route.
UriRoute	DELETE(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	DELETE(String uri, Class type, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	DELETE(String uri, Object target, String method, Class... parameterTypes) Route the specified URI template to the specified target.
ErrorRoute	error(Class<? extends Throwable> error, Class type, String method, Class[] parameterTypes) Register a route to handle the error.
ErrorRoute	error(Class originatingClass, Class<? extends Throwable> error, Class type, String method, Class[] parameterTypes) Register a route to handle the error.
UriRoute	GET(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	GET(String uri, Class<?> type, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	GET(String uri, Object target, String method, Class... parameterTypes) Route the specified URI template to the specified target.
List<ErrorRoute>	getErrorRoutes()
Set<Integer>	getExposedPorts()
List<FilterRoute>	getFilterRoutes()
List<StatusRoute>	getStatusRoutes()
RouteBuilder.UriNamingStrategy	getUriNamingStrategy()
List<UriRoute>	getUriRoutes()
UriRoute	HEAD(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	HEAD(String uri, Class type, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	HEAD(String uri, Object target, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	OPTIONS(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	OPTIONS(String uri, Class type, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	OPTIONS(String uri, Object target, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	PATCH(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	PATCH(String uri, Class type, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	PATCH(String uri, Object target, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	POST(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	POST(String uri, Class type, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	POST(String uri, Object target, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	PUT(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	PUT(String uri, Class type, String method, Class... parameterTypes) Route the specified URI template to the specified target.
UriRoute	PUT(String uri, Object target, String method, Class... parameterTypes) Route the specified URI template to the specified target.
ResourceRoute	resources(Class cls) Builds the necessary mappings to treat the given class as a REST endpoint.
ResourceRoute	single(Class cls) Builds the necessary mappings to treat the given class as a singular REST endpoint.
StatusRoute	status(Class originatingClass, HttpStatus status, Class type, String method, Class[] parameterTypes) Register a route to handle the returned status code.
StatusRoute	status(HttpStatus status, Class type, String method, Class[] parameterTypes) Register a route to handle the returned status code.
UriRoute	TRACE(String uri, BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method) Route the specified URI template to the specified target.
UriRoute	TRACE(String uri, Class type, String method, Class[] parameterTypes) Route the specified URI template to the specified target.
UriRoute	TRACE(String uri, Object target, String method, Class[] parameterTypes) Route the specified URI template to the specified target.

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.RouteBuilder

DELETE, DELETE, DELETE, DELETE, DELETE, DELETE, error, error, error, error, GET, GET, GET, GET, GET, GET, HEAD, HEAD, HEAD, HEAD, HEAD, HEAD, OPTIONS, OPTIONS, OPTIONS, OPTIONS, OPTIONS, OPTIONS, PATCH, PATCH, PATCH, PATCH, PATCH, PATCH, POST, POST, POST, POST, POST, POST, PUT, PUT, PUT, PUT, PUT, PUT, resources, single, status, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE

Field Detail

CAMEL_CASE_NAMING_STRATEGY

public static final RouteBuilder.UriNamingStrategy CAMEL_CASE_NAMING_STRATEGY

A RouteBuilder.UriNamingStrategy where by camel case conventions are used.

LOG

protected static final org.slf4j.Logger LOG

executionHandleLocator

protected final ExecutionHandleLocator executionHandleLocator

uriNamingStrategy

protected final RouteBuilder.UriNamingStrategy uriNamingStrategy

conversionService

protected final ConversionService<?> conversionService

defaultCharset

protected final Charset defaultCharset

Constructor Detail

DefaultRouteBuilder

public DefaultRouteBuilder(ExecutionHandleLocator executionHandleLocator)

Parameters:

executionHandleLocator - The execution handler locator

DefaultRouteBuilder

public DefaultRouteBuilder(ExecutionHandleLocator executionHandleLocator,
                           RouteBuilder.UriNamingStrategy uriNamingStrategy)

Parameters:

executionHandleLocator - The execution handler locator

uriNamingStrategy - The URI naming strategy

DefaultRouteBuilder

public DefaultRouteBuilder(ExecutionHandleLocator executionHandleLocator,
                           RouteBuilder.UriNamingStrategy uriNamingStrategy,
                           ConversionService<?> conversionService)

Parameters:

executionHandleLocator - The execution handler locator

uriNamingStrategy - The URI naming strategy

conversionService - The conversion service

Method Detail

getExposedPorts

public Set<Integer> getExposedPorts()

Specified by:

getExposedPorts in interface RouteBuilder

Returns:

The exposed ports

getFilterRoutes

public List<FilterRoute> getFilterRoutes()

Specified by:

getFilterRoutes in interface RouteBuilder

Returns:

The filter routes

addFilter

public FilterRoute addFilter(String pathPattern,
                             Supplier<HttpFilter> filter)

Description copied from interface: RouteBuilder

Add a filter.

Specified by:

addFilter in interface RouteBuilder

Parameters:

pathPattern - The path pattern for the filter

filter - The filter itself

Returns:

The FilterRoute

addFilter

public FilterRoute addFilter(String pathPattern,
                             BeanLocator beanLocator,
                             BeanDefinition<? extends HttpFilter> beanDefinition)

Description copied from interface: RouteBuilder

Add a filter.

Specified by:

addFilter in interface RouteBuilder

Parameters:

pathPattern - The path pattern for the filter

beanLocator - The bean locator

beanDefinition - The bean definition

Returns:

The FilterRoute

getStatusRoutes

public List<StatusRoute> getStatusRoutes()

Specified by:

getStatusRoutes in interface RouteBuilder

Returns:

Obtain a list of constructed routes

getErrorRoutes

public List<ErrorRoute> getErrorRoutes()

Specified by:

getErrorRoutes in interface RouteBuilder

Returns:

Obtain a list of constructed routes

getUriRoutes

public List<UriRoute> getUriRoutes()

Specified by:

getUriRoutes in interface RouteBuilder

Returns:

Obtain a list of constructed routes

getUriNamingStrategy

public RouteBuilder.UriNamingStrategy getUriNamingStrategy()

Specified by:

getUriNamingStrategy in interface RouteBuilder

Returns:

The URI naming strategy

resources

public ResourceRoute resources(Class cls)

Description copied from interface: RouteBuilder

Builds the necessary mappings to treat the given class as a REST endpoint.

For example given a class called BookController the following routes will be produced:

     GET "/book"
     GET "/book{/id}"
     POST "/book"
     PUT "/book{/id}"
     PATCH "/book{/id}"
     DELETE "/book{/id}"
 

By default it is assumed the accepted and returned content type is MediaType.APPLICATION_JSON_TYPE.

Specified by:

resources in interface RouteBuilder

Parameters:

cls - The class

Returns:

The ResourceRoute

single

public ResourceRoute single(Class cls)

Description copied from interface: RouteBuilder

Builds the necessary mappings to treat the given class as a singular REST endpoint.

For example given a class called BookController the following routes will be produced:

     GET "/book"
     POST "/book"
     PUT "/book"
     PATCH "/book"
     DELETE "/book"
 

By default it is assumed the accepted and returned content type is MediaType.APPLICATION_JSON_TYPE.

Specified by:

single in interface RouteBuilder

Parameters:

cls - The class

Returns:

The ResourceRoute

status

public StatusRoute status(Class originatingClass,
                          HttpStatus status,
                          Class type,
                          String method,
                          Class[] parameterTypes)

Description copied from interface: RouteBuilder

Register a route to handle the returned status code. This implementation considers the originatingClass for matching.

Specified by:

status in interface RouteBuilder

Parameters:

originatingClass - The class where the error originates from

status - The status code

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

status

public StatusRoute status(HttpStatus status,
                          Class type,
                          String method,
                          Class[] parameterTypes)

Description copied from interface: RouteBuilder

Register a route to handle the returned status code.

Specified by:

status in interface RouteBuilder

Parameters:

status - The status code

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

error

public ErrorRoute error(Class originatingClass,
                        Class<? extends Throwable> error,
                        Class type,
                        String method,
                        Class[] parameterTypes)

Description copied from interface: RouteBuilder

Register a route to handle the error.

Specified by:

error in interface RouteBuilder

Parameters:

originatingClass - The class where the error originates from

error - The error type

type - The type to route to

method - The method THe method to route to

parameterTypes - The parameter types for the target method

Returns:

The route

error

public ErrorRoute error(Class<? extends Throwable> error,
                        Class type,
                        String method,
                        Class[] parameterTypes)

Description copied from interface: RouteBuilder

Register a route to handle the error.

Specified by:

error in interface RouteBuilder

Parameters:

error - The error

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

GET

public UriRoute GET(String uri,
                    Object target,
                    String method,
                    Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

GET in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

GET

public UriRoute GET(String uri,
                    Class<?> type,
                    String method,
                    Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

GET in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

POST

public UriRoute POST(String uri,
                     Object target,
                     String method,
                     Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

POST in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

POST

public UriRoute POST(String uri,
                     Class type,
                     String method,
                     Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

POST in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

PUT

public UriRoute PUT(String uri,
                    Object target,
                    String method,
                    Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

PUT in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

PUT

public UriRoute PUT(String uri,
                    Class type,
                    String method,
                    Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

PUT in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

PATCH

public UriRoute PATCH(String uri,
                      Object target,
                      String method,
                      Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

PATCH in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

PATCH

public UriRoute PATCH(String uri,
                      Class type,
                      String method,
                      Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

PATCH in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

DELETE

public UriRoute DELETE(String uri,
                       Object target,
                       String method,
                       Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

DELETE in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

DELETE

public UriRoute DELETE(String uri,
                       Class type,
                       String method,
                       Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

DELETE in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

OPTIONS

public UriRoute OPTIONS(String uri,
                        Object target,
                        String method,
                        Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

OPTIONS in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

OPTIONS

public UriRoute OPTIONS(String uri,
                        Class type,
                        String method,
                        Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

OPTIONS in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

HEAD

public UriRoute HEAD(String uri,
                     Object target,
                     String method,
                     Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

HEAD in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

HEAD

public UriRoute HEAD(String uri,
                     Class type,
                     String method,
                     Class... parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

HEAD in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

TRACE

public UriRoute TRACE(String uri,
                      Object target,
                      String method,
                      Class[] parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

TRACE in interface RouteBuilder

Parameters:

uri - The URI

target - The target

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

TRACE

public UriRoute TRACE(String uri,
                      Class type,
                      String method,
                      Class[] parameterTypes)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

TRACE in interface RouteBuilder

Parameters:

uri - The URI

type - The type

method - The method

parameterTypes - The parameter types for the target method

Returns:

The route

GET

public UriRoute GET(String uri,
                    BeanDefinition<?> beanDefinition,
                    ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

GET in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

POST

public UriRoute POST(String uri,
                     BeanDefinition<?> beanDefinition,
                     ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

POST in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

PUT

public UriRoute PUT(String uri,
                    BeanDefinition<?> beanDefinition,
                    ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

PUT in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

PATCH

public UriRoute PATCH(String uri,
                      BeanDefinition<?> beanDefinition,
                      ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

PATCH in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

DELETE

public UriRoute DELETE(String uri,
                       BeanDefinition<?> beanDefinition,
                       ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

DELETE in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

OPTIONS

public UriRoute OPTIONS(String uri,
                        BeanDefinition<?> beanDefinition,
                        ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

OPTIONS in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

HEAD

public UriRoute HEAD(String uri,
                     BeanDefinition<?> beanDefinition,
                     ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

HEAD in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

TRACE

public UriRoute TRACE(String uri,
                      BeanDefinition<?> beanDefinition,
                      ExecutableMethod<?,?> method)

Description copied from interface: RouteBuilder

Route the specified URI template to the specified target.

The number of variables in the template should match the number of method arguments

Specified by:

TRACE in interface RouteBuilder

Parameters:

uri - The URI

beanDefinition - The bean definition

method - The method

Returns:

The route

buildRoute

protected UriRoute buildRoute(HttpMethod httpMethod,
                              String uri,
                              Class<?> type,
                              String method,
                              Class... parameterTypes)

Build a route.

Parameters:

httpMethod - The HTTP method

uri - The URI

type - The type

method - The method

parameterTypes - Parameters

Returns:

an UriRoute

buildRoute

protected UriRoute buildRoute(HttpMethod httpMethod,
                              String uri,
                              MethodExecutionHandle<?,Object> executableHandle)

Build a route.

Parameters:

httpMethod - The HTTP method

uri - The URI

executableHandle - The executable handle

Returns:

an UriRoute

buildBeanRoute

protected UriRoute buildBeanRoute(String httpMethodName,
                                  HttpMethod httpMethod,
                                  String uri,
                                  BeanDefinition<?> beanDefinition,
                                  ExecutableMethod<?,?> method)

A special case that is required for non standard http methods.

Parameters:

httpMethodName - The name of method. For standard http methods matches Enum.name()

httpMethod - The http method. Is HttpMethod.CUSTOM for non standard http methods.

uri - The uri.

beanDefinition - The definition of the bean.

method - The method description

Returns:

The uri route corresponding to the method.