public class ComponentConfigurationDTO
extends DTO
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.
|
java.lang.String |
failure
The failure information if the component configuration state is
FAILED_ACTIVATION . |
long |
id
The id of the component configuration.
|
java.util.Map<java.lang.String,java.lang.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 and Description |
---|
ComponentConfigurationDTO() |
public static final int UNSATISFIED_CONFIGURATION
public static final int UNSATISFIED_REFERENCE
public static final int SATISFIED
Any services
declared
by the component description are registered.
public static final int ACTIVE
This is the normal operational state of a component configuration.
public static final int FAILED_ACTIVATION
This means the component configuration is satisfied but that either:
failure
.public ComponentDescriptionDTO description
public int state
This is one of UNSATISFIED_CONFIGURATION
,
UNSATISFIED_REFERENCE
, SATISFIED
, ACTIVE
, or
FAILED_ACTIVATION
.
public long id
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.
public java.util.Map<java.lang.String,java.lang.Object> properties
ComponentContext.getProperties()
public SatisfiedReferenceDTO[] satisfiedReferences
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.
public UnsatisfiedReferenceDTO[] unsatisfiedReferences
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.
public java.lang.String failure
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
.public ServiceReferenceDTO service
This must be non-null
if the component configuration is
registered as a service. Otherwise it must be null
.
"Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"