ComponentConfigurationDTO (OSGi Compendium Release 8)

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 Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTIVE` The component configuration is active.
`ComponentDescriptionDTO`	`description` The representation of the component configuration's component description.
`static int`	`FAILED_ACTIVATION` The component configuration failed to activate.
`String`	`failure` The failure information if the component configuration state is `FAILED_ACTIVATION`.
`long`	`id` The id of the component configuration.
`Map<String,Object>`	`properties` The component properties for the component configuration.
`static int`	`SATISFIED` The component configuration is satisfied.
`SatisfiedReferenceDTO[]`	`satisfiedReferences` The satisfied references.
`ServiceReferenceDTO`	`service` The registered service of the component configuration.
`int`	`state` The current state of the component configuration.
`static int`	`UNSATISFIED_CONFIGURATION` The component configuration is unsatisfied due to a missing required configuration.
`static int`	`UNSATISFIED_REFERENCE` The component configuration is unsatisfied due to an unsatisfied reference.
`UnsatisfiedReferenceDTO[]`	`unsatisfiedReferences` The unsatisfied references.

Constructor Summary

Constructors
Constructor and Description

ComponentConfigurationDTO()

Constructors
Constructor and Description
`ComponentConfigurationDTO()`

Method Summary
- Methods inherited from class org.osgi.dto.DTO
  toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNSATISFIED_CONFIGURATION
```
public static final int UNSATISFIED_CONFIGURATION
```
    The component configuration is unsatisfied due to a missing required configuration.
    
    See Also:
    
    Constant Field Values
  - UNSATISFIED_REFERENCE
```
public static final int UNSATISFIED_REFERENCE
```
    The component configuration is unsatisfied due to an unsatisfied reference.
    
    See Also:
    
    Constant Field Values
  - SATISFIED
```
public static final int SATISFIED
```
    The component configuration is satisfied.
    Any services declared by the component description are registered.
    
    See Also:
    
    Constant Field Values
  - ACTIVE
```
public static final int ACTIVE
```
    The component configuration is active.
    This is the normal operational state of a component configuration.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    ComponentContext.getProperties()
  - 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 Detail
  - ComponentConfigurationDTO
```
public ComponentConfigurationDTO()
```

Class ComponentConfigurationDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.osgi.dto.DTO

Methods inherited from class java.lang.Object

Field Detail

UNSATISFIED_CONFIGURATION

UNSATISFIED_REFERENCE

SATISFIED

ACTIVE

FAILED_ACTIVATION

description

state

id

properties

satisfiedReferences

unsatisfiedReferences

failure

service

Constructor Detail

ComponentConfigurationDTO