DeviceComponentConfiguration Data Type

Describes the configuration of an OSGi Component. The Component configuration groups all the information related to the configuration of a Component. It provides access to parsed ObjectClassDefintion associated to this Component. The configuration does not reuse the OSGi ObjectClassDefinition as the latter does not provide access to certain aspects such as the required attribute, the min and max values. Instead it returns the raw ObjectClassDefintion as parsed from the MetaType Information XML resource associated to this Component.

Properties
name data type description
pid string The PID (service's persistent identity) of the OSGi Component associated to this configuration. The service's persistent identity is defined as the name attribute of the Component Descriptor XML file; at runtime, the same value is also available in the component.name and in the service.pid attributes of the Component Configuration.
OCD Tocd The raw ObjectClassDefinition as parsed from the MetaType Information XML resource associated to this Component.
properties XmlConfigPropertiesAdapted The Dictionary of properties currently used by this component.

Example

{
  "pid" : "...",
  "OCD" : {
    "AD" : [ {
      "Option" : [ { }, { } ],
      "any" : [ { }, { } ],
      "id" : "...",
      "max" : "...",
      "min" : "...",
      "name" : "...",
      "type" : "Float",
      "default" : "...",
      "required" : true,
      "otherAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "cardinality" : 12345,
      "description" : "..."
    }, {
      "Option" : [ { }, { } ],
      "any" : [ { }, { } ],
      "id" : "...",
      "max" : "...",
      "min" : "...",
      "name" : "...",
      "type" : "Integer",
      "default" : "...",
      "required" : true,
      "otherAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "cardinality" : 12345,
      "description" : "..."
    } ],
    "Icon" : [ {
      "any" : [ { }, { } ],
      "size" : 12345,
      "resource" : "...",
      "otherAttributes" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "any" : [ { }, { } ],
      "size" : 12345,
      "resource" : "...",
      "otherAttributes" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "any" : [ { }, { } ],
    "id" : "...",
    "name" : "...",
    "otherAttributes" : {
      "property1" : "...",
      "property2" : "..."
    },
    "description" : "..."
  },
  "properties" : {
    "property" : [ {
      "name" : "...",
      "array" : true,
      "encrypted" : true,
      "type" : "Password",
      "value" : [ "...", "..." ]
    }, {
      "name" : "...",
      "array" : true,
      "encrypted" : true,
      "type" : "Integer",
      "value" : [ "...", "..." ]
    } ]
  }
}