Package io.micronaut.function.web

Class AnnotatedFunctionRouteBuilder

java.lang.Object

io.micronaut.web.router.DefaultRouteBuilder

io.micronaut.function.web.AnnotatedFunctionRouteBuilder

All Implemented Interfaces:

AnnotationProcessor<FunctionBean,ExecutableMethod<?,?>>, ExecutableMethodProcessor<FunctionBean>, LocalFunctionRegistry, MediaTypeCodecRegistry, RouteBuilder

@Singleton
@Replaces(DefaultLocalFunctionRegistry.class)
public class AnnotatedFunctionRouteBuilder
extends DefaultRouteBuilder
implements ExecutableMethodProcessor<FunctionBean>, LocalFunctionRegistry, MediaTypeCodecRegistry

Process methods for FunctionBean instances.

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 inherited from class io.micronaut.web.router.DefaultRouteBuilder

CAMEL_CASE_NAMING_STRATEGY, conversionService, defaultCharset, executionHandleLocator, LOG, uriNamingStrategy

Fields inherited from interface io.micronaut.function.LocalFunctionRegistry

FUNCTION_CHARSET, FUNCTION_NAME, FUNCTION_PREFIX

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

ID

Constructor Summary

Constructors

Constructor	Description
AnnotatedFunctionRouteBuilder(ExecutionHandleLocator executionHandleLocator, RouteBuilder.UriNamingStrategy uriNamingStrategy, ConversionService conversionService, MediaTypeCodecRegistry codecRegistry, String contextPath)	Constructor.

Method Summary

Modifier and Type	Method	Description
<T, R> Optional<? extends ExecutableMethod<T,R>>	find(String name)	Find the first available registered function.
<T, U, R> Optional<ExecutableMethod<BiFunction<T,U,R>,R>>	findBiFunction(String name)	Find a BiFunction for the given name.
Optional<MediaTypeCodec>	findCodec(@Nullable MediaType mediaType)	Find a codec for the given media type.
Optional<MediaTypeCodec>	findCodec(@Nullable MediaType mediaType, Class<?> type)	Find a codec for the given media type and target type.
<T> Optional<ExecutableMethod<Consumer<T>,Void>>	findConsumer(String name)	Find a Consumer for the given name.
<T, R> Optional<? extends ExecutableMethod<T,R>>	findFirst()	Find the first available registered function.
<T, R> Optional<ExecutableMethod<Function<T,R>,R>>	findFunction(String name)	Find a Function for the given name.
<T> Optional<ExecutableMethod<Supplier<T>,T>>	findSupplier(String name)	Find a Supplier for the given name.
Map<String,URI>	getAvailableFunctions()	A map of available functions with the key being the function name and the value being the function URI.
Collection<MediaTypeCodec>	getCodecs()
void	process(BeanDefinition<?> beanDefinition, ExecutableMethod<?,?> method)	The process method will be called for every ExecutableMethod that is annotated with the type parameter A.

Methods inherited from class io.micronaut.web.router.DefaultRouteBuilder

addFilter, buildBeanRoute, buildRoute, buildRoute, buildRoute, DELETE, DELETE, DELETE, error, error, GET, GET, GET, getErrorRoutes, getExposedPorts, getFilterRoutes, getStatusRoutes, getUriNamingStrategy, getUriRoutes, HEAD, HEAD, HEAD, OPTIONS, OPTIONS, OPTIONS, PATCH, PATCH, PATCH, POST, POST, POST, PUT, PUT, PUT, resources, single, status, status, TRACE, TRACE, TRACE

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

Constructor Details

AnnotatedFunctionRouteBuilder

public AnnotatedFunctionRouteBuilder(ExecutionHandleLocator executionHandleLocator,
 RouteBuilder.UriNamingStrategy uriNamingStrategy,
 ConversionService conversionService,
 MediaTypeCodecRegistry codecRegistry,
 @Value("${micronaut.function.context-path:/}")
 String contextPath)

Constructor.

Parameters:

executionHandleLocator - executionHandleLocator

uriNamingStrategy - uriNamingStrategy

conversionService - conversionService

codecRegistry - codecRegistry

contextPath - contextPath

Method Details

process

public void process(BeanDefinition<?> beanDefinition,
 ExecutableMethod<?,?> method)

Description copied from interface: ExecutableMethodProcessor

The process method will be called for every ExecutableMethod that is annotated with the type parameter A.

Specified by:

process in interface AnnotationProcessor<FunctionBean,ExecutableMethod<?,?>>

Specified by:

process in interface ExecutableMethodProcessor<FunctionBean>

Parameters:

beanDefinition - The bean definition to process

method - The executable method

getAvailableFunctions

public Map<String,URI> getAvailableFunctions()

A map of available functions with the key being the function name and the value being the function URI.

Specified by:

getAvailableFunctions in interface LocalFunctionRegistry

Returns:

A map of functions

findFirst

public <T,
R>
Optional<? extends ExecutableMethod<T,R>> findFirst()

Description copied from interface: LocalFunctionRegistry

Find the first available registered function.

Specified by:

findFirst in interface LocalFunctionRegistry

Type Parameters:

T - The declaring type

R - The result of the method call

Returns:

The ExecutableMethod method representing the function

find

public <T,
R>
Optional<? extends ExecutableMethod<T,R>> find(String name)

Description copied from interface: LocalFunctionRegistry

Find the first available registered function.

Specified by:

find in interface LocalFunctionRegistry

Type Parameters:

T - The declaring type

R - The result of the method call

Parameters:

name - the name

Returns:

The ExecutableMethod method representing the function

findSupplier

public <T>
Optional<ExecutableMethod<Supplier<T>,T>> findSupplier(String name)

Description copied from interface: LocalFunctionRegistry

Find a Supplier for the given name.

Specified by:

findSupplier in interface LocalFunctionRegistry

Type Parameters:

T - The type

Parameters:

name - The name

Returns:

An Optional of a Supplier

findConsumer

public <T>
Optional<ExecutableMethod<Consumer<T>,Void>> findConsumer(String name)

Description copied from interface: LocalFunctionRegistry

Find a Consumer for the given name.

Specified by:

findConsumer in interface LocalFunctionRegistry

Type Parameters:

T - The type

Parameters:

name - The name

Returns:

An Optional of a Consumer

findFunction

public <T,
R>
Optional<ExecutableMethod<Function<T,R>,R>> findFunction(String name)

Description copied from interface: LocalFunctionRegistry

Find a Function for the given name.

Specified by:

findFunction in interface LocalFunctionRegistry

Type Parameters:

T - The type

R - The result of the method call

Parameters:

name - The name

Returns:

An Optional of a Function

findBiFunction

public <T,
U,
R>
Optional<ExecutableMethod<BiFunction<T,U,R>,R>> findBiFunction(String name)

Description copied from interface: LocalFunctionRegistry

Find a BiFunction for the given name.

Specified by:

findBiFunction in interface LocalFunctionRegistry

Type Parameters:

T - The type

U - the type of the second argument to the function

R - The result of the method call

Parameters:

name - The name

Returns:

An Optional of a BiFunction

findCodec

public Optional<MediaTypeCodec> findCodec(@Nullable
 @Nullable MediaType mediaType)

Description copied from interface: MediaTypeCodecRegistry

Find a codec for the given media type.

Specified by:

findCodec in interface MediaTypeCodecRegistry

Parameters:

mediaType - The MediaType

Returns:

The codec

findCodec

public Optional<MediaTypeCodec> findCodec(@Nullable
 @Nullable MediaType mediaType,
 Class<?> type)

Description copied from interface: MediaTypeCodecRegistry

Find a codec for the given media type and target type.

Specified by:

findCodec in interface MediaTypeCodecRegistry

Parameters:

mediaType - The MediaType

type - The type

Returns:

The codec

getCodecs

public Collection<MediaTypeCodec> getCodecs()

Specified by:

getCodecs in interface MediaTypeCodecRegistry

Returns:

The available codecs