<properties> Element

3 min read

The properties element is used in three situations:

as a named property set if the id attribute is specified
as a reference to a named property set if the refid attribute is specified
as an unnamed property set if the id or refid attributes are not specified.

A property set is useful for defining a set of properties (a named property set) in application or node descriptors. Named property sets can be included in named or unnamed property sets with property set references.

Each form of the element takes the attribute shown, if any, and may only be a child of the listed elements:

Form	Attribute	Allowed parents
Named property set	`id`	application, node
Unnamed property set	None	server, icebox, service, server-instance, service-instance
Unnamed property set of an IceBox service	`service`	server-instance
Reference to a named property set	`refid`	A named or unnamed property set

The following attributes are supported; a properties element takes at most one of them:

Attribute	Description	Required
`id`	Defines a new named property set with the given identifier. The identifier must be unique among all named property sets defined in the same scope. If not specified, the properties element refers to an unnamed property set or a property set reference.	No
`refid`	Defines a reference to the named property set with the given identifier. If not specified, the element refers to an unnamed or named property set.	No
`service`	Specifies the name of an IceBox service that is defined in the enclosing `server-instance` descriptor. The server instance must be an IceBox server that includes a service with the given name. An unnamed property set with this attribute defined extends the properties of the service. If not specified, the unnamed property set extends the properties of the server instance.	No

Here is an example to demonstrate the use of this element:

XML

<application name="Simple">
    <properties id="Debug">
        <property name="Ice.Trace.Network" value="1"/>
    </properties>

    <node name="Node1">
        <server id="MyServer" exe="./server">
            <properties>
                <properties refid="Debug"/>
                <property name="AppProperty" value="1"/>
            </properties>
        </server>
    </node>
</application>

See Also