ContainerDescriptor sub-elements

A ContainerDescriptor element can contain the following sub-elements:

container_type_id

The ID of this ContainerDescriptor and the corresponding container (required). You must refer to this ID to request a container from the attribute retrieval service. It is generated the following way, if the namespace is present:

If the namespace is not present, it is equal to the container_name. The container_type_id must be unique.

container_name

The name of this container descriptor (required). Within a particular namespace, the container_name must be unique. The container_name must not contain a colon (":") character.

namespace_prefix

The URL of the namespace in which the container_name is valid (required). The namespace tag can be empty. If this is the case, the container_type_id equals the container_name.

cost

The per retrieval cost of a attribute retrieval service container corresponding to this descriptor. Don't forget the currency type.

protocol_id

This ID (required) refers to the unique protocol ID of one of the attribute retrieval service protocols. The protocol given with this ID is used to retrieve the container from the provider. This element has to match an ID known to the service.

provider_id

This ID (required) refers to the attribute retrieval service provider that is capable of sending a container corresponding to the descriptor. The service connects to this provider when this container is requested.

properties

General client and protocol dependent properties. You add a property setting in the following way:

Add an element called property with an attribute named key. The attribute contains the name or key of the property, the content of the element, and the corresponding value. Consider the client_init_properties in the example code below.

client_init_properties

Properties specific to the initialization of the attribute retrieval service clients. One property used by different protocols is the attribute mapping described below.

ContainerPayloadFormat

This element (required) describes the structure and contents of the containers corresponding to this descriptor. The content of this element is protocol dependent. The DynAdiProtocols currently available provides a list of elements named with the attribute names to be retrieved from the provider in this element. The containers are wrapped by a element named with the container_name.