Package org.osgi.service.component.runtime.dto

Class ComponentConfigurationDTO

java.lang.Object
org.osgi.dto.DTO
org.osgi.service.component.runtime.dto.ComponentConfigurationDTO
public class ComponentConfigurationDTO extends DTO
A representation of an actual instance of a declared component description parameterized by component properties.
Since:
1.3
"NotThreadSafe"

  • Field Details

    • UNSATISFIED_CONFIGURATION

      public static final int UNSATISFIED_CONFIGURATION
      The component configuration is unsatisfied due to a missing required configuration.
      See Also:

    • UNSATISFIED_REFERENCE

      public static final int UNSATISFIED_REFERENCE
      The component configuration is unsatisfied due to an unsatisfied reference.
      See Also:

    • SATISFIED

      public static final int SATISFIED
      The component configuration is satisfied.

      Any services declared by the component description are registered.

      See Also:

    • ACTIVE

      public static final int ACTIVE
      The component configuration is active.

      This is the normal operational state of a component configuration.

      See Also:

    • FAILED_ACTIVATION

      public static final int FAILED_ACTIVATION
      The component configuration failed to activate.

      This means the component configuration is satisfied but that either:

      • an exception occurred loading the implementation class,
      • the static initializer threw an exception,
      • the constructor threw an exception, or
      • the activate method threw an exception.
      The failure information from the exception is available from failure.
      Since:
      1.4
      See Also:

    • description

      public ComponentDescriptionDTO description
      The representation of the component configuration's component description.

    • state

      public int state
      The current state of the component configuration.

      This is one of UNSATISFIED_CONFIGURATION, UNSATISFIED_REFERENCE, SATISFIED, ACTIVE, or FAILED_ACTIVATION.

    • id

      public long id
      The id of the component configuration.

      The id is a non-persistent, unique value assigned at runtime. The id is also available as the component.id component property. The value of this field is unspecified if the state of this component configuration is unsatisfied.

    • properties

      public Map<String,Object> properties
      The component properties for the component configuration.
      See Also:

    • satisfiedReferences

      public SatisfiedReferenceDTO[] satisfiedReferences
      The satisfied references.

      Each SatisfiedReferenceDTO in the array represents a satisfied reference of the component configuration. The array must be empty if the component configuration has no satisfied references.

    • unsatisfiedReferences

      public UnsatisfiedReferenceDTO[] unsatisfiedReferences
      The unsatisfied references.

      Each UnsatisfiedReferenceDTO in the array represents an unsatisfied reference of the component configuration. The array must be empty if the component configuration has no unsatisfied references.

    • failure

      public String failure
      The failure information if the component configuration state is FAILED_ACTIVATION.

      This is the failure exception converted to a String using: 

       StringWriter sw = new StringWriter();
 exception.printStackTrace(new PrintWriter(sw));
 sw.toString();
      This must be null if the component configuration state is not FAILED_ACTIVATION.
      Since:
      1.4

    • service

      public ServiceReferenceDTO service
      The registered service of the component configuration.

      This must be non-null if the component configuration is registered as a service. Otherwise it must be null.

      Since:
      1.4

  • Constructor Details

    • ComponentConfigurationDTO

      public ComponentConfigurationDTO()