Class DynamicConfigurationImpl

java.lang.Object
org.jvnet.hk2.internal.DynamicConfigurationImpl
All Implemented Interfaces:
DynamicConfiguration
public class DynamicConfigurationImpl extends Object implements DynamicConfiguration
The system implementation of the DynamicConfiguration service

  • Field Details

  • Constructor Details

    • DynamicConfigurationImpl

      public DynamicConfigurationImpl(ServiceLocatorImpl locator)
      Created by the generator, and hence must be public
      Parameters:
      locator - The locator for which this will be the configuration service

  • Method Details

    • bind

      public <T> ActiveDescriptor<T> bind(Descriptor key)
      Description copied from interface: DynamicConfiguration
      This method will bind the given descriptor to this Module. If the descriptor given is not an ActiveDescriptor then a non-reified ActiveDescriptor will be returned with the system provided fields set. If the descriptor given is a reified ActiveDescriptor then the descriptor returned will be a reified ActiveDescriptor that takes all values except for the id from the given descriptor. A deep copy will be made of the incoming descriptor
      Specified by:
      bind in interface DynamicConfiguration
      Parameters:
      key - May not be null. Will be used to derive the various key fields associated with the given provider
      Returns:
      The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate

    • bind

      public <T> ActiveDescriptor<T> bind(Descriptor key, boolean requiresDeepCopy)
      Description copied from interface: DynamicConfiguration
      This method will bind the given descriptor to this Module. If the descriptor given is not an ActiveDescriptor then a non-reified ActiveDescriptor will be returned with the system provided fields set. If the descriptor given is a reified ActiveDescriptor then the descriptor returned will be a reified ActiveDescriptor that takes all values except for the id from the given descriptor.
      Specified by:
      bind in interface DynamicConfiguration
      Parameters:
      key - May not be null. Will be used to derive the various key fields associated with the given provider
      requiresDeepCopy - If true a deep copy will be made of the key. If false then the Descriptor will be used as is, and it is the responsibility of the caller to ensure that the fields of the Descriptor never change (with the exception of any writeable fields, such as ranking)
      Returns:
      The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate

    • bind

      public FactoryDescriptors bind(FactoryDescriptors factoryDescriptors)
      Description copied from interface: DynamicConfiguration
      This method will bind the descriptors found in the FactoryDescriptors. This method will first validate the descriptors from the FactoryDescriptors and then simply bind them into this configuration as two independent descriptors. A deep copy will be made of both descriptors
      Specified by:
      bind in interface DynamicConfiguration
      Parameters:
      factoryDescriptors - A description of a factory service and the type the factory service provides. May not be null
      Returns:
      The descriptors returned from this object may be cast to ActiveDescriptor and will contain all the fields of the descriptors filled in by the system

    • bind

      public FactoryDescriptors bind(FactoryDescriptors factoryDescriptors, boolean requiresDeepCopy)
      Description copied from interface: DynamicConfiguration
      This method will bind the descriptors found in the FactoryDescriptors. This method will first validate the descriptors from the FactoryDescriptors and then simply bind them into this configuration as two independent descriptors. A deep copy will be made of both descriptors
      Specified by:
      bind in interface DynamicConfiguration
      Parameters:
      factoryDescriptors - A description of a factory service and the type the factory service provides. May not be null
      requiresDeepCopy - If true a deep copy will be made of the key. If false then the Descriptor will be used as is, and it is the responsibility of the caller to ensure that the fields of the Descriptor never change (with the exception of any writeable fields, such as ranking)
      Returns:
      The descriptors returned from this object may be cast to ActiveDescriptor and will contain all the fields of the descriptors filled in by the system

    • addActiveDescriptor

      public <T> ActiveDescriptor<T> addActiveDescriptor(ActiveDescriptor<T> activeDescriptor) throws IllegalArgumentException
      Description copied from interface: DynamicConfiguration
      This allows third party systems to add reified active descriptors to the system. The active descriptor given must be fully reified (isReified must return true) and the create and destroy methods must be implemented. A deep copy will be made of the descriptor
      Specified by:
      addActiveDescriptor in interface DynamicConfiguration
      Parameters:
      activeDescriptor - The reified active descriptor to be added to the system. The system will not attempt to reify this descriptor itself
      Returns:
      The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate
      Throws:
      IllegalArgumentException - if the descriptor is not reified

    • addActiveDescriptor

      public <T> ActiveDescriptor<T> addActiveDescriptor(ActiveDescriptor<T> activeDescriptor, boolean requiresDeepCopy) throws IllegalArgumentException
      Description copied from interface: DynamicConfiguration
      This allows third party systems to add reified active descriptors to the system. The active descriptor given must be fully reified (isReified must return true) and the create and destroy methods must be implemented. A deep copy will be made of the descriptor
      Specified by:
      addActiveDescriptor in interface DynamicConfiguration
      Parameters:
      activeDescriptor - The reified active descriptor to be added to the system. The system will not attempt to reify this descriptor itself
      requiresDeepCopy - If true a deep copy will be made of the key. If false then the Descriptor will be used as is, and it is the responsibility of the caller to ensure that the fields of the Descriptor never change (with the exception of any writeable fields, such as ranking)
      Returns:
      The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate
      Throws:
      IllegalArgumentException - if the descriptor is not reified

    • addActiveDescriptor

      public <T> ActiveDescriptor<T> addActiveDescriptor(Class<T> rawClass) throws IllegalArgumentException
      Description copied from interface: DynamicConfiguration
      This adds an active descriptor to the system based completely on the analysis of the given class. The class itself and all interfaces marked contract will be in the list of advertised services. The scope and qualifiers will be taken from the annotations on the class.
      Specified by:
      addActiveDescriptor in interface DynamicConfiguration
      Parameters:
      rawClass - The class to analyze, must not be null
      Returns:
      The active (reified) descriptor that has been added to the system, with all fields filled in based on the rawClass
      Throws:
      IllegalArgumentException - if rawClass is null

    • addActiveFactoryDescriptor

      public <T> FactoryDescriptors addActiveFactoryDescriptor(Class<? extends Factory<T>> rawFactoryClass) throws MultiException, IllegalArgumentException
      Description copied from interface: DynamicConfiguration
      This adds two active descriptors to the system based completely on the analysis of the given Factory class. The Factory class itself and all interfaces marked contract will be in the list of advertised services. The scope and qualifiers will be taken from the annotations on the class. The annotations on the Factory.provide() method will provide the scope and qualifiers of the service produced by the Factory
      Specified by:
      addActiveFactoryDescriptor in interface DynamicConfiguration
      Parameters:
      rawFactoryClass - The class to analyze, must not be null
      Returns:
      The factory descriptors that have been added to the system, with all fields filled in based on the rawFactoryClass
      Throws:
      MultiException - If this class cannot be a service
      IllegalArgumentException - if rawClass is null

    • addUnbindFilter

      public void addUnbindFilter(Filter unbindFilter) throws IllegalArgumentException
      Description copied from interface: DynamicConfiguration
      This filter will added to the list of filters in this Configuration that will determine which Descriptors will be removed from the system. Only services directly from this Configuration objects' associated ServiceLocator will be given to this Filter (it will not be given descriptors from the ServiceLocators parent). The descriptors passed into this filter may be cast to ActiveDescriptor. The descriptors passed into this filter may or may not have been reified. This filter should not reify passed in descriptors.

      And descriptor for which this filter returns true will be removed from the ServiceLocator prior to any additions that are performed with this Configuration object. Hence a Configuration can remove and add a descriptor of the same type in one commit.

      In order to unbind a filter the caller of commit must pass the LOOKUP validators and the UNBIND validators.

      Specified by:
      addUnbindFilter in interface DynamicConfiguration
      Parameters:
      unbindFilter - This filter will be added to the list of filters that this configuration object will use to determine which descriptors to unbind from the system. May not be null
      Throws:
      IllegalArgumentException - if unbindFilter is null

    • addIdempotentFilter

      public void addIdempotentFilter(Filter... idempotentFilter) throws IllegalArgumentException
      Description copied from interface: DynamicConfiguration
      At commit time all idempotent filters in this dynamic configuration will be run against all validation-visible descriptors. If any of the idempotent filters are a match then the commit will FAIL and none of the descriptors in this DynamicConfiguration will be added or removed. The idempotent filters will be run under the same lock as the commit, and hence can guarantee true idempotency of the transaction.

      The normal use case for the use of this filter is to ensure that a service is only added once to the ServiceLocator, even when multiple threads may be attempting to add the same service

      The filter passed in should not do any change to the set of descriptors itself, any attempt to do so will leave the system in an inconsistent state. IndexedFilter is supported and is the normal use of an idempotent filter, though it is not required

      Specified by:
      addIdempotentFilter in interface DynamicConfiguration
      Parameters:
      idempotentFilter - A non-null idempotent filter to use during commit. If any descriptors match the filter, the commit will fail
      Throws:
      IllegalArgumentException - If any of the filters are null

    • registerTwoPhaseResources

      public void registerTwoPhaseResources(TwoPhaseResource... resources)
      Description copied from interface: DynamicConfiguration
      Registers two-phase resources in the order in which they are to run. Subsequent calls to this method will add resources at the end of the existing list
      Specified by:
      registerTwoPhaseResources in interface DynamicConfiguration
      Parameters:
      resources - A list of resources to add to this dynamic configuration

    • commit

      public void commit() throws MultiException
      Description copied from interface: DynamicConfiguration
      This causes the configuration to get committed. This method may only be called once
      Specified by:
      commit in interface DynamicConfiguration
      Throws:
      MultiException - If errors were found in the commit process

    • checkState

      private void checkState()

    • checkDescriptor

      private static void checkDescriptor(Descriptor d)

    • checkReifiedDescriptor

      private static void checkReifiedDescriptor(ActiveDescriptor<?> d)

    • getAllDescriptors

      LinkedList<SystemDescriptor<?>> getAllDescriptors()
      Returns:
      the allDescriptors

    • getUnbindFilters

      LinkedList<Filter> getUnbindFilters()

    • getIdempotentFilters

      LinkedList<Filter> getIdempotentFilters()

    • getResources

      LinkedList<TwoPhaseResource> getResources()

    • toString

      public String toString()
      Overrides:
      toString in class Object