Package io.micronaut.management.endpoint.processors

Class ReadEndpointRouteBuilder

  • All Implemented Interfaces:
    io.micronaut.context.LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>, io.micronaut.context.processor.AnnotationProcessor<Endpoint,​io.micronaut.inject.ExecutableMethod<?,​?>>, io.micronaut.context.processor.ExecutableMethodProcessor<Endpoint>, io.micronaut.web.router.RouteBuilder, java.io.Closeable, java.lang.AutoCloseable
    @Singleton
public class ReadEndpointRouteBuilder
extends io.micronaut.web.router.DefaultRouteBuilder
    A processor that processes references to Read operations Endpoint instances.
    Since:
    1.0

    • Nested Class Summary

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

        io.micronaut.web.router.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​(io.micronaut.context.ApplicationContext beanContext, io.micronaut.web.router.RouteBuilder.UriNamingStrategy uriNamingStrategy, io.micronaut.core.convert.ConversionService<?> conversionService, EndpointDefaultConfiguration endpointDefaultConfiguration)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected io.micronaut.http.uri.UriTemplate buildUriTemplate​(io.micronaut.inject.ExecutableMethod<?,​?> method, java.lang.String id)  
      protected java.lang.Class<? extends java.lang.annotation.Annotation> getSupportedAnnotation()  
      protected boolean isPathParameter​(io.micronaut.core.type.Argument argument)  
      boolean isRunning()  
      void process​(io.micronaut.inject.BeanDefinition<?> beanDefinition, io.micronaut.inject.ExecutableMethod<?,​?> method)  
      protected void registerRoute​(io.micronaut.inject.ExecutableMethod<?,​?> method, java.lang.String id, java.lang.Integer port)
      Register a route.
      protected java.util.Optional<java.lang.String> resolveActiveEndPointId​(java.lang.Class<?> declaringType)  
      io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder start()  
      io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder stop()
      Clears endpoint ids information.

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

        addFilter, addFilter, buildBeanRoute, 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 Detail

      • ReadEndpointRouteBuilder

        public ReadEndpointRouteBuilder​(io.micronaut.context.ApplicationContext beanContext,
                                io.micronaut.web.router.RouteBuilder.UriNamingStrategy uriNamingStrategy,
                                io.micronaut.core.convert.ConversionService<?> conversionService,
                                EndpointDefaultConfiguration endpointDefaultConfiguration)
        Parameters:
        beanContext - The application context
        uriNamingStrategy - The URI naming strategy
        conversionService - The conversion service
        endpointDefaultConfiguration - Endpoints default Configuration

    • Method Detail

      • getSupportedAnnotation

        protected java.lang.Class<? extends java.lang.annotation.Annotation> getSupportedAnnotation()
        Returns:
        The class

      • registerRoute

        protected void registerRoute​(io.micronaut.inject.ExecutableMethod<?,​?> method,
                             java.lang.String id,
                             java.lang.Integer port)
        Register a route.
        Parameters:
        method - The ExecutableMethod
        id - The route id
        port - The port

      • start

        @NonNull
public io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder start()
        Specified by:
        start in interface io.micronaut.context.LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>

      • stop

        @NonNull
public io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder stop()
        Clears endpoint ids information.
        Specified by:
        stop in interface io.micronaut.context.LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>

      • isRunning

        public boolean isRunning()
        Specified by:
        isRunning in interface io.micronaut.context.LifeCycle<io.micronaut.management.endpoint.processors.AbstractEndpointRouteBuilder>

      • process

        public void process​(io.micronaut.inject.BeanDefinition<?> beanDefinition,
                    io.micronaut.inject.ExecutableMethod<?,​?> method)
        Specified by:
        process in interface io.micronaut.context.processor.AnnotationProcessor<Endpoint,​io.micronaut.inject.ExecutableMethod<?,​?>>
        Specified by:
        process in interface io.micronaut.context.processor.ExecutableMethodProcessor<Endpoint>
        Parameters:
        beanDefinition - The bean definition to process
        method - The executable method

      • resolveActiveEndPointId

        protected java.util.Optional<java.lang.String> resolveActiveEndPointId​(java.lang.Class<?> declaringType)
        Parameters:
        declaringType - The type
        Returns:
        An optional string with the endpoint id

      • buildUriTemplate

        protected io.micronaut.http.uri.UriTemplate buildUriTemplate​(io.micronaut.inject.ExecutableMethod<?,​?> method,
                                                             java.lang.String id)
        Parameters:
        method - The ExecutableMethod
        id - The route id
        Returns:
        An UriTemplate

      • isPathParameter

        protected boolean isPathParameter​(io.micronaut.core.type.Argument argument)
        Parameters:
        argument - An Argument
        Returns:
        Whether the argument is a path parameter