Module io.helidon.microprofile.servicecommon
Package io.helidon.microprofile.servicecommon

Class HelidonRestCdiExtension

java.lang.Object
io.helidon.microprofile.servicecommon.HelidonRestCdiExtension
All Implemented Interfaces:
Extension
Direct Known Subclasses:
HealthCdiExtension, MetricsCdiExtension, MicrometerCdiExtension, OpenApiCdiExtension
public abstract class HelidonRestCdiExtension extends Object implements Extension
Abstract superclass of service-specific, REST-based CDI extensions.

This class implements a substantial amount of the work many extensions must do to process annotated types for REST-based services.

Each CDI extension is presumed to layer on an SE-style service support class which itself is a subclass of HelidonFeatureSupport with an associated Builder class. The service support base class and its builder are both type parameters to this class.

Each concrete implementation should:

  • Invoke recordAnnotatedType(jakarta.enterprise.inject.spi.ProcessAnnotatedType<?>) for each class which bears an annotation of interest to the extension, often from a ProcessAnnotatedType observer method.
  • Implement processManagedBean(ProcessManagedBean) which this base class invokes to notify the implementation class of each managed bean type that was reported by the concrete extension but not vetoed by some other extension. Each extension can interpret "process" however it needs to. Metrics, for example, creates metrics and registers them with the appropriate metrics registry.

  • Constructor Details

    • HelidonRestCdiExtension

      protected HelidonRestCdiExtension(System.Logger logger, String... configPrefixes)
      Common initialization for concrete implementations.
      Parameters:
      logger - Logger instance to use for logging messages
      configPrefixes - prefixes for retrieving config related to this extension

  • Method Details

    • clearAnnotationInfo

      public void clearAnnotationInfo(@Observes AfterDeploymentValidation adv)
      Cleans up any data structures created during annotation processing but which are not needed once the CDI container has started.
      Parameters:
      adv - the AfterDeploymentValidation event

    • observeManagedBeans

      public void observeManagedBeans(@Observes ProcessManagedBean<?> pmb)
      Observes all managed beans but immediately dismisses ones for which the Java class was not previously noted by the ProcessAnnotatedType observer (which recorded only classes with selected annotations).
      Parameters:
      pmb - event describing the managed bean being processed

    • processManagedBean

      protected void processManagedBean(ProcessManagedBean<?> processManagedBean)
      Deals with a managed bean that survived vetoing, provided by concrete extension implementations.

      The meaning of "process" varies among the concrete implementations. At this point, this base implementation has managed the annotation processing in a general way (e.g., only non-vetoed beans survive) and now delegates to the concrete implementations to actually respond appropriately to the bean and whichever of its members are annotated.

      Parameters:
      processManagedBean - the managed bean, with at least one annotation of interest to the extension

    • isConcreteNonInterceptor

      protected boolean isConcreteNonInterceptor(ProcessAnnotatedType<?> pat)
      Checks to make sure the annotated type is not abstract and is not an interceptor.
      Parameters:
      pat - ProcessAnnotatedType event
      Returns:
      true if the annotated type should be kept for potential processing later; false otherwise

    • recordAnnotatedType

      protected void recordAnnotatedType(ProcessAnnotatedType<?> pat)
      Records the Java class underlying an annotated type.
      Parameters:
      pat - ProcessAnnotatedType event

    • isOwnProducerOrNonDefaultQualified

      protected boolean isOwnProducerOrNonDefaultQualified(Bean<?> bean, Class<?> ownProducerClass)

    • recordProducerField

      protected void recordProducerField(ProcessProducerField<?,?> ppf)
      Records a producer field defined by the application. Ignores producers with non-default qualifiers and library producers.
      Parameters:
      ppf - Producer field.

    • recordProducerMethod

      protected void recordProducerMethod(ProcessProducerMethod<?,?> ppm)
      Records a producer method defined by the application. Ignores producers with non-default qualifiers and library producers.
      Parameters:
      ppm - Producer method.

    • producers

      protected Map<Bean<?>,AnnotatedMember<?>> producers()

    • rootConfig

      protected Config rootConfig()
      SE Configuration, root.
      Returns:
      config instance

    • componentConfig

      protected Config componentConfig()
      SE Configuration of the current compoennt.
      Returns:
      component configuration

    • routingBuilder

      protected HttpRouting.Builder routingBuilder(ServerCdiExtension server)
      Find routing builder to use for this component to be registered on. Uses the routing key on the service level to choose the correct routing (listener).
      Parameters:
      server - server CDI extension
      Returns:
      routing builder to use

    • nestedConfigKey

      protected static String nestedConfigKey(String suffix)
      Returns the config key for settings for the specified suffix nested within the server config tree.
      Parameters:
      suffix - the config key suffix (typically the name of the component: e.g., health)
      Returns:
      full nested config key for the specified suffix

    • prepareRuntime

      public void prepareRuntime(@Observes @RuntimeStart Config config)
      Configure with runtime config.
      Parameters:
      config - config to use