Module io.helidon.pico.configdriven.runtime
Package io.helidon.pico.configdriven.runtime

Class AbstractConfiguredServiceProvider<T,CB>

java.lang.Object
io.helidon.pico.runtime.AbstractServiceProvider<T>
io.helidon.pico.configdriven.runtime.AbstractConfiguredServiceProvider<T,CB>
Type Parameters:
T - the type of the service this provider manages
CB - the type of config beans that this service is configured by
All Implemented Interfaces:
ConfigBeanMapper, Weighted, ActivationPhaseReceiver, Activator, DeActivator, InjectionPointProvider<T>, Resettable, ServiceProvider<T>, ServiceProviderBindable<T>, ServiceProviderProvider, ConfiguredServiceProvider<T,CB>, InjectionResolver, Provider<T>, Comparable<Weighted>
public abstract class AbstractConfiguredServiceProvider<T,CB> extends AbstractServiceProvider<T> implements ConfiguredServiceProvider<T,CB>, ServiceProviderProvider, InjectionPointProvider<T>, InjectionResolver
Abstract base for any config-driven-service.

  • Constructor Details

    • AbstractConfiguredServiceProvider

      protected AbstractConfiguredServiceProvider()
      The default constructor.

  • Method Details

    • configBeanMap

      public Map<String,Object> configBeanMap()
      The map of bean instance id's to config bean instances.
      Returns:
      map of bean instance id's to config bean instances

    • configuredServicesMap

      public Map<String,Optional<AbstractConfiguredServiceProvider<T,CB>>> configuredServicesMap()
      The map of bean instance id's to managed configured service providers that this instance managed directly.
      Returns:
      map of bean instance id to managed configured service providers

    • registerConfigBean

      public void registerConfigBean(String instanceId, Object configBean)
      Called during initialization to register a loaded config bean.
      Parameters:
      instanceId - the config bean instance id
      configBean - the config bean

    • reset

      public boolean reset(boolean deep)
      Description copied from interface: Resettable
      Resets the state of this object.
      Specified by:
      reset in interface Resettable
      Overrides:
      reset in class AbstractServiceProvider<T>
      Parameters:
      deep - true to iterate over any contained objects, to reflect the reset into the retained object
      Returns:
      returns true if the state was changed

    • isRootProvider

      public boolean isRootProvider()
      Description copied from interface: ServiceProviderBindable
      Returns true if this provider is the root provider.
      Specified by:
      isRootProvider in interface ServiceProviderBindable<T>
      Returns:
      indicates whether this provider is a root provider - the default is true

    • rootProvider

      public Optional<ServiceProvider<?>> rootProvider()
      Description copied from interface: ServiceProviderBindable
      Gets the root/parent provider for this service. A root/parent provider is intended to manage it's underlying providers. Note that "root" and "parent" are interchangeable here since there is at most one level of depth that occurs when ServiceProvider's are wrapped by other providers.
      Specified by:
      rootProvider in interface ServiceProviderBindable<T>
      Returns:
      the root/parent provider or empty if this instance is the root provider

    • rootProvider

      public void rootProvider(ServiceProvider<T> root)
      Description copied from interface: ServiceProviderBindable
      Sets the root/parent provider for this instance.
      Specified by:
      rootProvider in interface ServiceProviderBindable<T>
      Parameters:
      root - sets the root provider

    • picoServices

      public void picoServices(Optional<PicoServices> picoServices)
      Description copied from interface: ServiceProviderBindable
      Assigns the services instance this provider is bound to. A service provider can be associated with 0..1 services instance. If not set, the service provider should use PicoServices.picoServices() to ascertain the instance.
      Specified by:
      picoServices in interface ServiceProviderBindable<T>
      Overrides:
      picoServices in class AbstractServiceProvider<T>
      Parameters:
      picoServices - the pico services instance, or empty to clear any active binding

    • onPhaseEvent

      public void onPhaseEvent(Event event, Phase phase)
      Description copied from interface: ActivationPhaseReceiver
      Called when there is an event transition within the service registry.
      Specified by:
      onPhaseEvent in interface ActivationPhaseReceiver
      Overrides:
      onPhaseEvent in class AbstractServiceProvider<T>
      Parameters:
      event - the event
      phase - the phase

    • configBeanType

      public Class<?> configBeanType()
      Description copied from interface: ConfiguredServiceProvider
      The ConfigBean type that is used to configure this provider.
      Specified by:
      configBeanType in interface ConfiguredServiceProvider<T,CB>
      Returns:
      the ConfigBean type that is used to configure this provider

    • metaConfigBeanInfo

      public io.helidon.builder.config.spi.MetaConfigBeanInfo metaConfigBeanInfo()
      Description copied from interface: ConfiguredServiceProvider
      The meta config bean information associated with this service provider's ConfigBean.
      Specified by:
      metaConfigBeanInfo in interface ConfiguredServiceProvider<T,CB>
      Returns:
      the MetaConfigBeanInfo for this config bean

    • configBeanAttributes

      public Map<String,Map<String,Object>> configBeanAttributes()
      Description copied from interface: ConfiguredServiceProvider
      The config bean attributes for our ConfigBean. Generally this method is for internal use only. Most should use ConfiguredServiceProvider.visitAttributes(CB, io.helidon.builder.AttributeVisitor<java.lang.Object>, R) instead of this method.
      Specified by:
      configBeanAttributes in interface ConfiguredServiceProvider<T,CB>
      Returns:
      the config bean attributes

    • resolve

      public Optional<Object> resolve(InjectionPointInfo ipInfo, PicoServices picoServices, ServiceProvider<?> serviceProvider, boolean resolveIps)
      Description copied from interface: InjectionResolver
      Attempts to resolve the injection point info for a given service provider.

      There are two modes that injection resolvers run through. Phase 1 (resolveIps=false) is during the time when the injection plan is being formulated. This is the time we need to identify which ServiceProvider instances qualify. Phase 2 (resolveIps=true) is during actual resolution, and typically comes during the service activation lifecycle.

      Specified by:
      resolve in interface InjectionResolver
      Parameters:
      ipInfo - the injection point being resolved
      picoServices - the pico services
      serviceProvider - the service provider this pertains to
      resolveIps - flag indicating whether injection points should be resolved
      Returns:
      the resolution for the plan or the injection point, or empty if unable to resolve the injection point context

    • serviceProviders

      public List<ServiceProvider<?>> serviceProviders(ServiceInfoCriteria criteria, boolean wantThis, boolean thisAlreadyMatches)
      Here we are only looking for service providers, not service instances. What we need to do here is to determine whether to (a) include root providers, (b) include slave providers, or (c) include both.

      The result depends on the type of this provider instance. Here is the heuristic:

      • if this is a slave then simply use the standard matching behavior.

        If, however, we are the root provider then the additional heuristic is applied:

      • if the request mentions the ConfiguredBy qualifier w/ no value specified then the caller is only interested in the root provider.
      • if the request mentions the ConfiguredBy qualifier w/ a value specified then the caller is only interested in the slave providers.
      • if the request is completely empty then they are interested in everything - the root provider as well as the slave providers.
      • if there is no slaves under management then they must be interested in the root provider.
      • the fallback is to use standard matching using the criteria provided and only include the slaves.
      Specified by:
      serviceProviders in interface ServiceProviderProvider
      Parameters:
      criteria - the injection point criteria that must match
      wantThis - if this instance matches criteria, do we want to return this instance as part of the result
      thisAlreadyMatches - an optimization that signals to the implementation that this instance has already matched using the standard service info matching checks
      Returns:
      the list of matching service providers based upon the context and criteria provided

    • managedServiceProviders

      public Map<String,AbstractConfiguredServiceProvider<?,CB>> managedServiceProviders(ServiceInfoCriteria criteria)
      Description copied from interface: ServiceProviderProvider
      This method will only apply to the managed/slave instances being provided, not to itself as in the case for ServiceProviderProvider.serviceProviders(ServiceInfoCriteria, boolean, boolean).
      Specified by:
      managedServiceProviders in interface ServiceProviderProvider
      Parameters:
      criteria - the injection point criteria that must match
      Returns:
      the map of managed service providers matching the criteria, identified by its key/context

    • first

      public Optional<T> first(ContextualServiceQuery query)
      Description copied from interface: InjectionPointProvider
      Get (or create) an instance of this service type for the given injection point context. This is logically the same as using the first element of the result from calling InjectionPointProvider.list(ContextualServiceQuery).
      Specified by:
      first in interface InjectionPointProvider<T>
      Overrides:
      first in class AbstractServiceProvider<T>
      Parameters:
      query - the service query
      Returns:
      the best service provider matching the criteria

    • list

      public List<T> list(ContextualServiceQuery query)
      Description copied from interface: InjectionPointProvider
      Get (or create) a list of instances matching the criteria for the given injection point context.
      Specified by:
      list in interface InjectionPointProvider<T>
      Overrides:
      list in class AbstractServiceProvider<T>
      Parameters:
      query - the service query
      Returns:
      the resolved services matching criteria for the injection point in order of weight, or null if the context is not supported

    • serviceProviderBindable

      public Optional<ServiceProviderBindable<T>> serviceProviderBindable()
      Configurable services by their very nature are not compile-time bindable during application creation.
      Specified by:
      serviceProviderBindable in interface ServiceProvider<T>
      Overrides:
      serviceProviderBindable in class AbstractServiceProvider<T>
      Returns:
      empty, signaling that we are not bindable
      See Also:

    • toConfigBean

      public <C extends Config, CB> Optional<CB> toConfigBean(C config, Class<CB> configBeanType)
      Description copied from interface: ConfigBeanMapper
      Translate the provided configuration into the appropriate config bean for this service type.
      Specified by:
      toConfigBean in interface ConfigBeanMapper
      Type Parameters:
      C - the config type
      CB - the config bean type
      Parameters:
      config - the config
      configBeanType - the config bean type
      Returns:
      the config bean generated, or empty if not possible to create

    • toConfigBeanInstanceId

      public abstract String toConfigBeanInstanceId(CB configBean)
      Description copied from interface: ConfiguredServiceProvider
      Gets the internal config bean instance id for the provided config bean.
      Specified by:
      toConfigBeanInstanceId in interface ConfiguredServiceProvider<T,CB>
      Parameters:
      configBean - the config bean
      Returns:
      the config bean instance id

    • configBeanInstanceId

      public abstract void configBeanInstanceId(CB configBean, String val)
      Brokers the set of the instance id for the given config bean.
      Parameters:
      configBean - the config bean to set
      val - the instance id to associate it with

    • rawConfig

      protected abstract Optional<Config> rawConfig()
      The backing config of this configured service instance.
      Returns:
      the backing config of this configured service instance

    • createInstance

      protected abstract AbstractConfiguredServiceProvider<T,CB> createInstance(Object configBean)
      Creates a new instance of this type of configured service provider, along with the configuration bean associated with the service.
      Parameters:
      configBean - the config bean
      Returns:
      the created instance injected with the provided config bean

    • doConstructing

      protected void doConstructing(AbstractServiceProvider.LogEntryAndResult logEntryAndResult)
      After the gathering dependency phase, we will short circuit directly to the finish line.
      Overrides:
      doConstructing in class AbstractServiceProvider<T>
      Parameters:
      logEntryAndResult - the record that holds the results

    • identitySuffix

      protected String identitySuffix()
      Description copied from class: AbstractServiceProvider
      The identity suffix, or empty string if there is no suffix.
      Overrides:
      identitySuffix in class AbstractServiceProvider<T>
      Returns:
      the identity suffix

    • serviceInfo

      protected void serviceInfo(ServiceInfo serviceInfo)
      Description copied from class: AbstractServiceProvider
      Sets the service info that describes the managed service that is assigned.
      Overrides:
      serviceInfo in class AbstractServiceProvider<T>
      Parameters:
      serviceInfo - the service info

    • logger

      protected System.Logger logger()
      Description copied from class: AbstractServiceProvider
      The logger.
      Overrides:
      logger in class AbstractServiceProvider<T>
      Returns:
      the logger

    • doPreDestroying

      protected void doPreDestroying(AbstractServiceProvider.LogEntryAndResult logEntryAndResult)
      Description copied from class: AbstractServiceProvider
      Called during the PreDestroyMethod process.
      Overrides:
      doPreDestroying in class AbstractServiceProvider<T>
      Parameters:
      logEntryAndResult - the entry holding the result

    • doDestroying

      protected void doDestroying(AbstractServiceProvider.LogEntryAndResult logEntryAndResult)
      Description copied from class: AbstractServiceProvider
      Called after the PreDestroyMethod process.
      Overrides:
      doDestroying in class AbstractServiceProvider<T>
      Parameters:
      logEntryAndResult - the entry holding the result

    • onFinalShutdown

      protected void onFinalShutdown()
      Description copied from class: AbstractServiceProvider
      Called on the final leg of the shutdown sequence.
      Overrides:
      onFinalShutdown in class AbstractServiceProvider<T>

    • assertIsRootProvider

      protected void assertIsRootProvider(boolean isRootProvider, boolean expectSet)
      Maybe transition into being a root provider if we are the first to claim it. Otherwise, we are a slave being managed.
      Parameters:
      isRootProvider - true if an asserting is being made to claim root or claim managed slave
      expectSet - true if this is a strong assertion, and if not claimed an exception will be thrown

    • drivesActivation

      protected boolean drivesActivation()
      Return true if this service is driven to activation during startup (and provided it has some config). See ConfiguredBy.drivesActivation() and see ConfigBean.drivesActivation() for more.
      Returns:
      true if this service is driven to activation during startup

    • acceptConfig

      protected CB acceptConfig(Config config)
      Called to accept the new config bean instance initialized from the appropriate configuration tree location.
      Parameters:
      config - the configuration
      Returns:
      the new config bean