Package io.micronaut.management.endpoint.processors

Class ReadEndpointRouteBuilder

java.lang.Object

io.micronaut.web.router.DefaultRouteBuilder

io.micronaut.management.endpoint.processors.ReadEndpointRouteBuilder

All Implemented Interfaces:

LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>, BeanDefinitionProcessor<Endpoint>, RouteBuilder, Closeable, AutoCloseable

@Singleton
public class ReadEndpointRouteBuilder
extends DefaultRouteBuilder

A processor that processes references to Read operations Endpoint 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.web.router.RouteBuilder

ID

Constructor Summary

Constructors

Constructor	Description
ReadEndpointRouteBuilder(ApplicationContext beanContext, RouteBuilder.UriNamingStrategy uriNamingStrategy, ConversionService conversionService, EndpointDefaultConfiguration endpointDefaultConfiguration)

Method Summary

Modifier and Type	Method	Description
protected UriTemplate	buildUriTemplate(ExecutableMethod<?,?> method, String id)
protected Class<? extends Annotation>	getSupportedAnnotation()
protected boolean	isPathParameter(Argument argument)
boolean	isRunning()
void	process(BeanDefinition<?> beanDefinition, BeanContext beanContext)	The process method will be called for every bean annotated with the given annotation type.
protected void	registerRoute(ExecutableMethod<?,?> method, String id, Integer port)	Register a route.
protected Optional<String>	resolveActiveEndPointId(Class<?> declaringType)
@NonNull io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder	start()	Starts the lifecyle component.
@NonNull io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder	stop()	Clears endpoint ids information.

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.context.LifeCycle

close, refresh

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

ReadEndpointRouteBuilder

public ReadEndpointRouteBuilder(ApplicationContext beanContext,
 RouteBuilder.UriNamingStrategy uriNamingStrategy,
 ConversionService conversionService,
 EndpointDefaultConfiguration endpointDefaultConfiguration)

Parameters:

beanContext - The application context

uriNamingStrategy - The URI naming strategy

conversionService - The conversion service

endpointDefaultConfiguration - Endpoints default Configuration

Method Details

getSupportedAnnotation

protected Class<? extends Annotation> getSupportedAnnotation()

Returns:

The class

registerRoute

protected void registerRoute(ExecutableMethod<?,?> method,
 String id,
 Integer port)

Register a route.

Parameters:

method - The ExecutableMethod

id - The route id

port - The port

start

public @NonNull io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder start()

Description copied from interface: LifeCycle

Starts the lifecyle component.

Specified by:

start in interface LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>

Returns:

This lifecycle component

stop

public @NonNull io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder stop()

Clears endpoint ids information.

Specified by:

stop in interface LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>

Returns:

This lifecycle component

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>

Returns:

Whether the component is running

process

public void process(BeanDefinition<?> beanDefinition,
 BeanContext beanContext)

Description copied from interface: BeanDefinitionProcessor

The process method will be called for every bean annotated with the given annotation type.

Specified by:

process in interface BeanDefinitionProcessor<Endpoint>

Parameters:

beanDefinition - The bean definition

beanContext - The bean context

resolveActiveEndPointId

protected Optional<String> resolveActiveEndPointId(Class<?> declaringType)

Parameters:

declaringType - The type

Returns:

An optional string with the endpoint id

buildUriTemplate

protected UriTemplate buildUriTemplate(ExecutableMethod<?,?> method,
 String id)

Parameters:

method - The ExecutableMethod

id - The route id

Returns:

An UriTemplate

isPathParameter

protected boolean isPathParameter(Argument argument)

Parameters:

argument - An Argument

Returns:

Whether the argument is a path parameter