bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift<xsd:schema targetNamespace="http://www.opends.org/admin"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift elementFormDefault="qualified"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:import namespace="http://www.opends.org/admin-ldap"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift schemaLocation="admin-ldap.xsd" />
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:import namespace="http://www.opends.org/admin-preprocessor"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift schemaLocation="admin-preprocessor.xsd" />
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift This schema defines the XML schema elements and attributes which
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should be used to specify the server's configuration model.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Broadly speaking, there are three main components to this schema:
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed objects, properties, and relations. Using these components
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift it is possible to model the server's configuration based on its
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift configurable components (managed objects), their configurable
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift attributes (properties), and their relationships with other
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift configurable components (relations).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines the structure of a configurable component within the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift configuration. A managed object comprises of zero or more
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift properties, and zero or more relations with other managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift objects. A managed object can be abstract, indicating that it
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift cannot be instantiated directly, and that it is intended as a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift base definition from which other child managed objects inherit
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift their behavior. Conversely, a managed object can be derived from
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift a parent managed object definition. In this case, the managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift object will inherit the properties and relations defined by the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift parent. Multiple levels of inheritance are supported, but
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift multiple inheritance is not.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="TODO" minOccurs="0" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation specifying remaining work or unsolved problems
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift relating to this managed object definition. Its use is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift primarily for development purposes and should not be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift processed by applications.
2e334e4f58d7760ed0788f5db5524d87934d6869matthew_swift <xsd:element name="user-friendly-name" minOccurs="0"
2e334e4f58d7760ed0788f5db5524d87934d6869matthew_swift type="tns:description-type">
2e334e4f58d7760ed0788f5db5524d87934d6869matthew_swift The user friendly name of this managed object. This element
2e334e4f58d7760ed0788f5db5524d87934d6869matthew_swift is optional and by default the user friendly name is derived
2e334e4f58d7760ed0788f5db5524d87934d6869matthew_swift from the definition's name attribute.
2e334e4f58d7760ed0788f5db5524d87934d6869matthew_swift <xsd:element name="user-friendly-plural-name" minOccurs="0"
2e334e4f58d7760ed0788f5db5524d87934d6869matthew_swift type="tns:description-type">
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift The user friendly plural name of this managed object. This
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift element is optional and by default the user friendly plural
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift name is derived from the definition's plural-name attribute.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="synopsis" type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A brief description of this managed object. The description
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should describe, preferably in one sentence, the purpose of
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift this managed object. The synopsis should be suitable for use
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift in applications such as tool-tips, CLI help, and the summary
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description in Javadoc. It is possible to embed rich content
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift including XHTML markup (this will only be used where
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A detailed description of this managed object. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should describe in detail the purpose of this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed object. The description should be suitable for use
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift in applications such as manual pages or detailed help. It
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift does not need to repeat anything described in the synopsis
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift as applications should normally display the two together. It
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift is possible to embed rich content including XHTML markup
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift (this will only be used where supported).
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift <xsd:element name="tag" minOccurs="0" maxOccurs="unbounded">
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift The name of a tag defined in the root configuration
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift definition. Tags can be used to group related managed object
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift definitions together. For example, all managed objects that
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift are associated with password management might be tagged with
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift "password" (assuming that there is a "password" tag defined
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift in the root configuration). Tags are inherited by derived
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift managed object definitions.
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift <xsd:attribute name="name" type="tns:name-type"
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift use="required">
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift The name of the referenced tag. There must be an
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift accompanying tag definition in the root configuration
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift maxOccurs="unbounded">
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift A constraint on the properties of this managed object. A
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift constraint comprises of a condition which must always
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift evaluate to true before a modification is permitted.
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift type="tns:rich-description-type">
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift A brief description of this constraint. The
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift description should describe, preferably in one
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift sentence, the purpose the condition associated with
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift this constraint. The synopsis should be suitable for
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift use in applications such as tool-tips, CLI help, and
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift the summary description in Javadoc. It is possible to
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift embed rich content including XHTML markup (this will
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift only be used where supported).
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift The condition associated with this constraint. The
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift condition must evaluate to true before modifications
0c45338572f2f6593fea8fc9e70bcb9ef3a6d2f8matthew_swift are permitted.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="profile" type="tns:profile-type" minOccurs="0"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation relating to this managed object. Annotations
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift can define additional information which cannot be directly
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift represented using this XML schema. The additional
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift information can relate to specific applications such as LDAP
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift (e.g. LDAP object classes), CLIs (e.g. sub-command name),
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift GUIs (e.g. how properties should be arranged and grouped in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="relation" maxOccurs="unbounded" minOccurs="0"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:relation-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies a composition relationship between this managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift object and other "child" managed objects. The relationship
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift can be a singleton relationship (i.e. one to one), an
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift optional relationship (i.e. one to zero or one), or a one to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift many relationship.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:choice minOccurs="0" maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="property" type="tns:property-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines a configurable property of this managed object. A
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift property's value or values affects the behavior of this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed object. Various different types of properties are
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift supported, for example, strings, integers, etc. A property
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift definition must not override a property defined elsewhere
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift in this managed object or property inherited from a parent
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift type="tns:property-override-type">
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift Overrides a property definition inherited from a parent
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift managed object definition. Using a property override it is
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift possible to modify the behavior of an inherited property
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift definition in a non-critical way. For example, a managed
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift object definition might override the default behavior of
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift an inherited Java implementation class property so that
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift new instances are created with the correct default
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift implementation class.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:property-reference-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A reference to a common property definition defined in a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift package, which should be part of this managed object's
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:complexType name="rich-description-type" mixed="true">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An internationalized description string which can contain XHTML
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:choice minOccurs="0" maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:any namespace="http://www.w3.org/1999/xhtml"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift processContents="lax" />
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of the product associated with this definition.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of the managed object associated with this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="user-friendly-plural-name">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The plural name of the managed object associated with this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An internationalized description string which cannot contain
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift XHTML markup.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines a configurable property of a managed object. A
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift property's value or values affects the behavior of the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift associated managed object. Various different types of properties
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift are supported, for example, strings, integers, etc. A property
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift definition must not override a property defined elsewhere in the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed object or property inherited from a parent managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="TODO" minOccurs="0" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation specifying remaining work or unsolved problems
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift relating to this property definition. Its use is primarily
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift for development purposes and should not be processed by
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applications.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="synopsis" type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A brief description of this property. The description should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift describe, preferably in one sentence, the purpose of this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift property. It does not need to provide details regarding
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default behavior, syntax, nor how changes take effect (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift immediately, post-restart, etc). The synopsis should be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift suitable for use in applications such as tool-tips, CLI
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift help, and the summary description in Javadoc. It is possible
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift to embed rich content including XHTML markup (this will only
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A detailed description of this property. The description
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should describe in detail the purpose of this property. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should be suitable for use in applications such
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift as manual pages or detailed help. It does not need to repeat
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift anything described in the synopsis as applications should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift normally display the two together. In addition, it does not
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift need to provide details regarding default behavior, syntax,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift nor how changes take effect (e.g. immediately, post-restart,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift etc). It is possible to embed rich content including XHTML
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift markup (this will only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines an optional action which administators must perform
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift after they have modified this property. By default
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift modifications to properties are assumed to take effect
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift immediately and require no additional administrative action.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Developers should be aware that, where feasible, they should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift implement components such that property modifications
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift require no additional administrative action. This is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift required in order to minimize server downtime during
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift administration and provide a more user-friendly experience.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="default-behavior" type="tns:default-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift minOccurs="0">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines a default behavior for the property when it has no
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift values specified. All properties must have a default
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift behavior defined unless they are mandatory.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="syntax" type="tns:syntax-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines the syntax of this property. This includes the data
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type used for the property and additional constraints (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="profile" type="tns:profile-type" minOccurs="0"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation relating to this property. Annotations can
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift define additional information which cannot be directly
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift represented using this XML schema. The additional
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift information can relate to specific applications such as LDAP
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift (e.g. LDAP attributes), CLIs (e.g. operand name), GUIs (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift how properties should be arranged and grouped in a window).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="name" type="tns:name-type" use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of this property. The name should describe as
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift concisely as possible the purpose of this property and should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift be suitable for use in Java method names (e.g. getters and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift setters). The property name should be a string comprising of
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift short lower-case words joined with hyphens "-". For example,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="multi-valued" type="xsd:boolean" use="optional"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default="false">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this property is multi-valued. By
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default, properties are single-valued.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="read-only" type="xsd:boolean" use="optional"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default="false">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this property is read-only. By
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift default, properties are not read-only. Read-only properties
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift can only be initialized during construction of the associated
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift managed object and cannot be modified once the managed object
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift has been created.
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift <xsd:attribute name="monitoring" type="xsd:boolean" use="optional"
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift default="false">
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift Indicates whether or not this property is read-only and
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift generated automatically by the server as monitoring
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift information. By default, properties are not for monitoring.
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift Monitoring properties are always read-only because their
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift values are generated by the server. During construction of a
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift managed object their values are undefined.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="mandatory" type="xsd:boolean" use="optional"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default="false">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this property is mandatory. Mandatory
71b64b6e7ff616e542de7e3fa1680fe9ca640712matthew_swift properties are usually those properties which have no sensible
71b64b6e7ff616e542de7e3fa1680fe9ca640712matthew_swift default behavior and must, therefore, be specified by
71b64b6e7ff616e542de7e3fa1680fe9ca640712matthew_swift administrators. If a mandatory property has default values
71b64b6e7ff616e542de7e3fa1680fe9ca640712matthew_swift these will be used as the values for the property if none are
71b64b6e7ff616e542de7e3fa1680fe9ca640712matthew_swift specified by the user.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="hidden" type="xsd:boolean" use="optional"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default="false">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this property should be hidden from
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift client applications. Hidden properties should rarely be used
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift but are sometimes required in order to provide functionality
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift that needs to be exposed in management APIs but not in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift front-ends such as CLIs.
ce307551b126a6b551358fb063614b80b9355907matthew_swift <xsd:attribute name="advanced" type="xsd:boolean" use="optional"
ce307551b126a6b551358fb063614b80b9355907matthew_swift default="false">
ce307551b126a6b551358fb063614b80b9355907matthew_swift Indicates whether or not this property should be treated as an
ce307551b126a6b551358fb063614b80b9355907matthew_swift advanced property and hidden by default in client
ce307551b126a6b551358fb063614b80b9355907matthew_swift applications. Advanced properties should either be optional
ce307551b126a6b551358fb063614b80b9355907matthew_swift (i.e. not mandatory) or be mandatory with default values. This
ce307551b126a6b551358fb063614b80b9355907matthew_swift constraint is required so that users do not have to specify
ce307551b126a6b551358fb063614b80b9355907matthew_swift values for advanced properties.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:complexType name="property-reference-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A reference to a common property definition defined in a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift package, which should be part of a managed object's definition.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Optionally override the administrative action defined in the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift referenced property definition. An administrative action
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift defines an optional action which administators must perform
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift after they have modified this property. By default
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift modifications to properties are assumed to take effect
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift immediately and require no additional administrative action.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Developers should be aware that, where feasible, they should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift implement components such that property modifications
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift require no additional administrative action. This is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift required in order to minimize server downtime during
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift administration and provide a more user-friendly experience.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="default-behavior" type="tns:default-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift minOccurs="0">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Optionally override the default behavior defined in the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift referenced property definition. The default behavior is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applicable when the property has no values specified. All
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift properties must have a default behavior defined unless they
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift are mandatory.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="name" type="tns:name-type" use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of the referenced property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="package" type="tns:package-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The package containing the referenced property. By default,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the package in which this managed object is defined will be
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift <xsd:complexType name="property-override-type">
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift Overrides a property definition inherited from a parent managed
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift object definition. Using a property override it is possible to
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift modify the behavior of an inherited property definition in a
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift non-critical way. For example, a managed object definition might
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift override the default behavior of an inherited Java
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift implementation class property so that new instances are created
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift with the correct default implementation class.
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift Optionally override the administrative action defined in the
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift overridden property definition. An administrative action
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift defines an optional action which administators must perform
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift after they have modified this property. By default
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift modifications to properties are assumed to take effect
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift immediately and require no additional administrative action.
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift Developers should be aware that, where feasible, they should
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift implement components such that property modifications
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift require no additional administrative action. This is
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift required in order to minimize server downtime during
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift administration and provide a more user-friendly experience.
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift <xsd:element name="default-behavior" type="tns:default-type"
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift minOccurs="0">
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift Optionally override the default behavior defined in the
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift overridden property definition. The default behavior is
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift applicable when the property has no values specified. All
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift properties must have a default behavior defined unless they
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift are mandatory.
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift <xsd:attribute name="name" type="tns:name-type" use="required">
91940c5122d22be4fd20bc41db2ffc4a9ba4ce59matthew_swift The name of the overridden property.
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift <xsd:attribute name="advanced" type="xsd:boolean" use="optional"
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift default="false">
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift Optionally override the advanced option defined in the
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift overridden property definition. Indicates whether or not this
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift property should be treated as an advanced property and hidden
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift by default in client applications. Advanced properties should
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift either be optional (i.e. not mandatory) or be mandatory with
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift default values. This constraint is required so that users do
188a85993cf1cf9925338176e5f27b95a5891c50matthew_swift not have to specify values for advanced properties.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift <xsd:complexType name="default-managed-object-type">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift Specifies the configuration of a default managed object which
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift should be created when a parent managed object is created. For
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift example, creation of a back-end could result in default indexes
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift being created.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift maxOccurs="unbounded">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift Specifies one or more initial values for a property in the
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift default managed object.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift The string representation of a value of this property.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift <xsd:attribute name="name" type="tns:name-type"
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift use="required">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift The name of the property.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift <xsd:attribute name="managed-object-name" type="tns:name-type"
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift use="optional">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift The type of default managed object to be created. This must be
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift either the type of the managed object referenced by this
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift relation (this is the default behavior) or a sub-type.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift <xsd:attribute name="managed-object-package" type="tns:package-type"
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift use="optional">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift The package containing the default managed object definition
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift if it is not the same as this managed object's package.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies a relationship between a managed object and other
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed objects. The relationship can be a singleton
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift relationship (i.e. one to one), an optional relationship (i.e.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift one to zero or one), or a one to many relationship. Both
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift compositions (the default) and aggregations are supported.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Aggregations are defined by specifying the path to the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift referenced managed objects in the aggregation attribute.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="TODO" minOccurs="0" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation specifying remaining work or unsolved problems
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift relating to this relation definition. Its use is primarily
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift for development purposes and should not be processed by
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applications.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="synopsis" type="tns:rich-description-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift minOccurs="0">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An optional brief description of this relation. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should describe, preferably in one sentence, the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift purpose of this relation. If a synopsis is not defined this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift relation will inherit the synopsis of the referenced managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift object. If present, the synopsis should be suitable for use
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift in applications such as tool-tips, CLI help, and the summary
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description in Javadoc. It is possible to embed rich content
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift including XHTML markup (this will only be used where
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An optional detailed description of this relation. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should describe in detail the purpose of this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift relation. The description should be suitable for use in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applications such as manual pages or detailed help. It does
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift not need to repeat anything described in the synopsis as
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applications should normally display the two together. If a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description is not defined this relation will inherit the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description of the referenced managed object. It is possible
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift to embed rich content including XHTML markup (this will only
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies a one to one (singleton) relationship with
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift another type of managed object.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift type="tns:default-managed-object-type" minOccurs="0">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift Defines a default managed object configuration which
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift should be automatically created when the parent
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift managed object is created.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies a one to zero or one (optional) relationship
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift with another type of managed object.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift type="tns:default-managed-object-type" minOccurs="0">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift Defines a default managed object configuration which
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift should be automatically created when the parent
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift managed object is created.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies a one to many (instantiable) relationship with
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift another type of managed object.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift <xsd:element name="default-managed-object" minOccurs="0"
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift maxOccurs="unbounded">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift Defines one or more default managed object
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift configurations which should be automatically created
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift when the parent managed object is created.
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift base="tns:default-managed-object-type">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift use="required">
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift Specifies the name that should be used to
7edb1a6332a5678c67bfa236b629d47cab1525c1matthew_swift identify this default managed object
abb16d70d9d4b5daf29b49db1e78676d4609276amatthew_swift <xsd:attribute name="unique" type="xsd:boolean"
abb16d70d9d4b5daf29b49db1e78676d4609276amatthew_swift Indicates whether or not this relation contains
abb16d70d9d4b5daf29b49db1e78676d4609276amatthew_swift unique members. If set to true then each
abb16d70d9d4b5daf29b49db1e78676d4609276amatthew_swift referenced managed object must have a distinct type.
abb16d70d9d4b5daf29b49db1e78676d4609276amatthew_swift In other words, there must not be more than one
abb16d70d9d4b5daf29b49db1e78676d4609276amatthew_swift referenced managed object having the same type. By
abb16d70d9d4b5daf29b49db1e78676d4609276amatthew_swift default, properties are single-valued.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="plural-name" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies the plural name of this relation if
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift different from the plural name of the referenced
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed object type.
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift <xsd:attribute name="naming-property" type="tns:name-type"
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift use="optional">
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift Specifies the name of a property in the referenced
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift managed object which should be used for naming
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift instances. For example, an attribute index managed
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift object could be named according to the attribute that
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift it indexes. If present, the naming property must
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift reference a single-valued, mandatory, read-only
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift property. If it is not present, the administration
c9020c301eada7085bb81da1821cac5533a1f20fmatthew_swift framework will use the default naming mechanism.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="profile" type="tns:profile-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation relating to this relation. Annotations can
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift define additional information which cannot be directly
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift represented using this XML schema. The additional
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift information can relate to specific applications such as
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift LDAP (e.g. an LDAP RDN representing the entry beneath
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift which managed objects should be located).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="name" type="tns:name-type" use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of this relation. The name should describe as
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift concisely as possible the purpose of this relation and should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift be suitable for use in Java method names (e.g. getters and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift setters). The property name should be a string comprising of
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift short lower-case words joined with hyphens "-". For example,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift "key-manager-provider". Usually the name will correspond to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the name of the referenced type of managed object. If it this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift is not the case, then the type of referenced managed object
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should be specified using the "managed-object-name" attribute.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="managed-object-name" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The type of managed object referenced by this relation if
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift different from this relation's name.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="managed-object-package" type="tns:package-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The package containing the referenced managed object
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift definition if it is not the same as this managed object's
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift <xsd:attribute name="advanced" type="xsd:boolean" use="optional"
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift default="false">
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift Indicates whether or not managed objects referenced by this
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift relation should be treated as advanced and be hidden by
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift default in client applications.
cd827d0bd7c904782575c994f30982ffe6e696d5matthew_swift <xsd:attribute name="hidden" type="xsd:boolean" use="optional"
cd827d0bd7c904782575c994f30982ffe6e696d5matthew_swift default="false">
cd827d0bd7c904782575c994f30982ffe6e696d5matthew_swift Indicates whether or not this relation should be hidden from
cd827d0bd7c904782575c994f30982ffe6e696d5matthew_swift client applications. Hidden relations should rarely be used
cd827d0bd7c904782575c994f30982ffe6e696d5matthew_swift but are sometimes required in order to provide functionality
cd827d0bd7c904782575c994f30982ffe6e696d5matthew_swift that needs to be exposed in management APIs but not in
cd827d0bd7c904782575c994f30982ffe6e696d5matthew_swift front-ends such as CLIs.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines an optional action which administators must perform
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift after they have modified a property. By default modifications to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift properties are assumed to take effect immediately and require no
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift additional administrative action. Developers should be aware
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift that, where feasible, they should implement components such that
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift property modifications require no additional administrative
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift action. This is required in order to minimize server downtime
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift during administration and provide a more user-friendly
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift Used when modifications to a property take effect
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift immediately, and no additional administrator action is
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift type="tns:rich-description-type" minOccurs="0">
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift An optional description which can be used to describe
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift how changes to the modified property will take effect.
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift If present, the synopsis should be suitable for use in
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift applications such as tool-tips, CLI help, and the
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift summary description in Javadoc. It is possible to
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift embed rich content including XHTML markup (this will
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when modifications to a property require a server
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift restart in order to take effect.
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift type="tns:rich-description-type" minOccurs="0">
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift An optional description of this required
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift administrative action. The description should
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift describe, preferably in one sentence, what additional
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift administrator action is required when the server is
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift restarted. If present, the synopsis should be suitable
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift for use in applications such as tool-tips, CLI help,
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift and the summary description in Javadoc. It is possible
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift to embed rich content including XHTML markup (this
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift will only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when modifications to a property require a component
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift restart in order to take effect (usually by disabling and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift re-enabling the component).
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift type="tns:rich-description-type" minOccurs="0">
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift An optional description of this required
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift administrative action. The description should
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift describe, preferably in one sentence, what additional
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift administrator action is required when the component is
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift restarted. If present, the synopsis should be suitable
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift for use in applications such as tool-tips, CLI help,
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift and the summary description in Javadoc. It is possible
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift to embed rich content including XHTML markup (this
3cbc49fe5e6d8a00a69fe1859874ed5dcff85aebmatthew_swift will only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when modifications to a property require an additional
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift administrative action in order to take effect. This should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift be used when neither a server restart nor a component
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift restart are applicable.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A brief description of this required administrative
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift action. The description should describe, preferably in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift one sentence, what additional administrator action is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift required when this property is modified. If present,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the synopsis should be suitable for use in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applications such as tool-tips, CLI help, and the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift summary description in Javadoc. It is possible to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift embed rich content including XHTML markup (this will
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines a default behavior for a property when it has no values
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift specified. All properties must have a default behavior defined
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift unless they are mandatory.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when a property has no tangible default behavior - its
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default behavior is undefined.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when a property defaults to some special behavior that
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift cannot be represented using property values.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A brief description of this default behavior. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should describe, preferably in one
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift sentence, the default behavior. If present, the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift synopsis should be suitable for use in applications
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift such as tool-tips, CLI help, and the summary
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description in Javadoc. It is possible to embed rich
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift content including XHTML markup (this will only be used
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="profile" type="tns:profile-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation relating to this default behavior.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Annotations can define additional information which
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift cannot be directly represented using this XML schema.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The additional information can relate to specific
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applications.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when a property defaults to one or more real values of
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The string representation of a value of this property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when a property defaults one or more values taken from
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift a property in another managed object.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when the managed object providing the default
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift values is located relative to this managed object.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The relative location of the managed object (where
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift 0 is this managed object, 1 is the parent, and 2
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift is the grand-parent).
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift The type of managed object providing the default
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift The package containing the managed object
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift definition if it is not the same as this managed
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift object's package.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="property-name" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of the property containing the default
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used when the managed object providing the default
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift values is in a known absolute location.
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift <xsd:attribute name="path" type="tns:path-type"
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift use="required">
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift The location of the managed object containing the
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift default values.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="property-name" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of the property containing the default
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines the syntax of a property. This includes the data type
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift used for the property and additional constraints on the values
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift An aggregation property names one or more managed objects
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift which are required by the managed object associated with
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift this property. An aggregation property definition takes care
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift to perform referential integrity checks: referenced managed
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift objects cannot be deleted. Nor can an aggregation reference
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift non-existent managed objects. Referential integrity checks
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift are not performed during value validation. Instead they are
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift performed when changes to the managed object are committed.
0e257bee0e980f6154794bac527df8101afecf18matthew_swift An optional constraint on the relationship between
0e257bee0e980f6154794bac527df8101afecf18matthew_swift this managed object and referenced managed objects.
0e257bee0e980f6154794bac527df8101afecf18matthew_swift The constraint specifies when and how referenced
0e257bee0e980f6154794bac527df8101afecf18matthew_swift managed objects must be enabled.
0e257bee0e980f6154794bac527df8101afecf18matthew_swift type="tns:rich-description-type">
0e257bee0e980f6154794bac527df8101afecf18matthew_swift A brief description of the constraints
0e257bee0e980f6154794bac527df8101afecf18matthew_swift applicable to referenced managed objects. The
0e257bee0e980f6154794bac527df8101afecf18matthew_swift description should describe, preferably in one
0e257bee0e980f6154794bac527df8101afecf18matthew_swift sentence, when referenced should be enabled and
0e257bee0e980f6154794bac527df8101afecf18matthew_swift how they should be enabled. The synopsis should
0e257bee0e980f6154794bac527df8101afecf18matthew_swift be suitable for use in applications such as
0e257bee0e980f6154794bac527df8101afecf18matthew_swift tool-tips, CLI help, and the summary description
0e257bee0e980f6154794bac527df8101afecf18matthew_swift in Javadoc. It is possible to embed rich content
0e257bee0e980f6154794bac527df8101afecf18matthew_swift including XHTML markup (this will only be used
0e257bee0e980f6154794bac527df8101afecf18matthew_swift where supported).
0e257bee0e980f6154794bac527df8101afecf18matthew_swift <xsd:element name="target-needs-enabling-condition"
0e257bee0e980f6154794bac527df8101afecf18matthew_swift minOccurs="0">
0e257bee0e980f6154794bac527df8101afecf18matthew_swift A condition which indicates whether or not
0e257bee0e980f6154794bac527df8101afecf18matthew_swift referenced managed objects must be enabled. The
0e257bee0e980f6154794bac527df8101afecf18matthew_swift default behavior is that all referenced managed
0e257bee0e980f6154794bac527df8101afecf18matthew_swift objects must be enabled.
0e257bee0e980f6154794bac527df8101afecf18matthew_swift <xsd:element name="target-is-enabled-condition"
0e257bee0e980f6154794bac527df8101afecf18matthew_swift minOccurs="0">
0e257bee0e980f6154794bac527df8101afecf18matthew_swift A condition which indicates whether or not
0e257bee0e980f6154794bac527df8101afecf18matthew_swift referenced managed objects are enabled. Managed
0e257bee0e980f6154794bac527df8101afecf18matthew_swift objects are assumed to be enabled by default.
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift <xsd:attribute name="parent-path" type="tns:path-type"
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift use="required">
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift The name of the managed object which is the parent of
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift the aggregated managed objects.
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift <xsd:attribute name="relation-name" type="tns:name-type"
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift use="required">
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift The relation in the parent managed object which contains
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift the aggregated managed objects.
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift <xsd:attribute name="managed-object-name" type="tns:name-type"
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift use="optional">
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift The type of managed object referenced by this
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift aggregation if different from this relation's name.
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift The package containing the referenced managed object
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift definition if it is not the same as this managed
6268e3d1b165bc72bbab62862e9b3b30e8883c97matthew_swift object's package.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain LDAP attribute type names.
cf318da46ef082557ca9fb3fd19268c80e8dfc2csin Used for properties which contain Extensible matching rule type names.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which are best represented using boolean
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain LDAP distinguished names.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="base" minOccurs="0" type="xsd:string">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates that values of this property must be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift immediately subordinate to the specified base DN.
6df5dcb0909ce8efb1aefa7a237a705e14de1f0bdugan Used for properties which contain dseecompat ACIs.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which reference a Java class. These are
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift typically used in plugins where the java class property
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift identifies a class implementing the plugin's functionality.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift It is possible to restrict the values of this property using
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the instance-of attribute. Note that it is only possible to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift validate values on the server, since client applications
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift don't necessarily have the same classes on their class-path.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates that values of this property must implement
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the specified Java interface. Note that it is only
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift possible to perform validation on the server, since
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift client applications don't necessarily have the same
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift classes on their class-path.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift value="([A-Za-z][A-Za-z0-9_]*\.)*[A-Za-z][A-Za-z0-9_]*" />
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain integer values. Where
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift appropriate it is possible to provide a description of the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift units for values of this property (e.g. "number of
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="unit-synopsis" minOccurs="0"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An optional description of the units for this value of
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift this property (e.g. "number of threads"). The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should describe the unit, preferably in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift one sentence. If present, the description should be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift suitable for use in applications such as tool-tips,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift CLI help, and the summary description in Javadoc. It
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift is possible to embed rich content including XHTML
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift markup (this will only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="allow-unlimited" type="xsd:boolean"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this property supports a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift special value representing infinity. This is useful
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift where properties are used to constrain some behavior and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the administrator wishes to remove the constraint (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift number of simultaneous client connections).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="lower-limit" type="xsd:integer"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates a lower limit for this integer property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="upper-limit" type="xsd:integer"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates an upper limit for this integer property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain IP addresses. IPv4 and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift IPv6 address forms are supported. In addition name
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift resolution is performed when non-numeric addresses are
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain IP address masks. IPv4 and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift IPv6 address mask forms are supported.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which represent a computer storage size.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Sizes can be specified using both decimal and binary units.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift For example, "1kb" represents 1000 bytes, and "1kib"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift represents 1024 bytes. Values must always specify the unit
29b1cca745810ca5f054aace99379ba6af427e6bcoulbeck and can include a fractional part (e.g. 1.5mb). Both short
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift and long unit names are supported (e.g. "kb" and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift "kilobytes").
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="allow-unlimited" type="xsd:boolean"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this property supports a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift special value representing infinity. This is useful
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift where properties are used to constrain some behavior and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the administrator wishes to remove the constraint (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maximum log size).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="lower-limit" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates a lower limit for this size property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="upper-limit" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates an upper limit for this size property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain a time duration.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="base-unit" use="optional" default="s">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies the minimum granularity which can be used to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift specify duration property values. For example, if the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift base unit is in seconds then values represented in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift milliseconds will not be permitted. The default base
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift unit is seconds.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="maximum-unit" use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Specifies the biggest duration unit which can be used to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift specify duration property values. Values presented in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift units greater than this unit will not be permitted.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift There is no default maximum unit.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="allow-unlimited" type="xsd:boolean"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this property supports a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift special value representing infinity. This is useful
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift where properties are used to constrain some behavior and
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift the administrator wishes to remove the constraint (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift connection time-out).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="lower-limit" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates a lower limit for this duration property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="upper-limit" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates an upper limit for this duration property.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain passwords. Values will be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift represented using strings which are then encrypted.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Typically password properties are write-only and should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift never be displayed in client applications (even during
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain values taken from a finite
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift set of values. There must be at least one possible value
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines one of the possible values that this property
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A description of this enumeration value. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should describe the behavior
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift indicated by the value preferably in one
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift sentence. The description should be suitable for
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use in applications such as tool-tips, CLI help,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift and the summary description in Javadoc. It is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift possible to embed rich content including XHTML
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift markup (this will only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:name-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of this enumeration value. The name
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should describe as concisely as possible the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift behavior indicated by this value and should be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift suitable for use in Java source code (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift enumerations). The enumeration value name should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift be a string comprising of short lower-case words
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift joined with hyphens "-". For example, "optional".
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Used for properties which contain string values. It is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift possible to contrain the permitted set of values using a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift regular expression.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Constrains the permitted set of values using a regular
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift expression. All values of this property must match the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift provided regular expression.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The regular expression conforming to the syntax
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift supported by the Java "java.util.regex.Pattern"
b9a443e043c3d5c58c76dac2891abe1b71afa9d5matthew_swift The usage string which should be displayed in
b9a443e043c3d5c58c76dac2891abe1b71afa9d5matthew_swift help relating to this string based property. For
b9a443e043c3d5c58c76dac2891abe1b71afa9d5matthew_swift example, a pattern which is used to match a
b9a443e043c3d5c58c76dac2891abe1b71afa9d5matthew_swift host/port string could have the usage HOST:PORT.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An description of the regular expression (e.g.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift "email address"). The description should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift describe the type of string represented by the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift regular expression, preferably in one sentence.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift If present, the description should be suitable
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift for use in applications such as tool-tips, CLI
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift help, and the summary description in Javadoc. It
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift is possible to embed rich content including
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift XHTML markup (this will only be used where
eb327f48ab993685cc144c4855d17a1fae0fdef5neil_a_wilson <xsd:attribute name="case-insensitive" type="xsd:boolean"
eb327f48ab993685cc144c4855d17a1fae0fdef5neil_a_wilson Indicates whether or not values of this property should
eb327f48ab993685cc144c4855d17a1fae0fdef5neil_a_wilson be treated in a case-insensitive manner.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An identifier name comprising of a 1 or more sequences of lower
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift case letters or digits separated by a single hyphen '-'. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift first sequence must begin with a letter.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:pattern value="[a-z][a-z0-9]*(-[a-z0-9]+)*" />
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An identifier name comprising of a 1 or more sequences of lower
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift case letters or digits separated by a single dot '.'. The first
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift sequence must begin with a letter.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:pattern value="[a-z][a-z0-9]*(\.[a-z0-9]+)*" />
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A managed object path which can be used to specify the location
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift of referenced managed objects. A managed object path has a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift similar syntax to unix file system paths, and comprises of zero
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift or more path elements separated by a forward slash "/". The root
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift configuration is referenced using the path "/". Subsequent path
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift elements identify subordinate managed objects. Each path element
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift is comprised of the relation name, an optional definition name,
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift and the name of the managed object instance if the relation is
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift one-to-many. The path "/relation=connection-handler+name=my
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift handler" identifies a connection handler called "my handler"
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift where "my handler" can be any type of connection handler. If "my
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift handler" must be an LDAP connection handler then the type needs
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift to be specified in the path:
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift "/relation=connection-handler+type=ldap-connection-handler+name=my
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift handler". The global configuration is identified by the path
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift "/relation=global-configuration" (no name is required because
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift the relation is one-to-one).
e32b0f1464ea290b749a43d5ee7a6085b14532c9matthew_swift value="/|(/relation=[^/+]+(\+type=[^/+]+)?(\+name=[^/]+)?)+">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation relating to the associated element. Annotations
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift can define additional information which cannot be directly
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift represented using this XML schema. The additional information
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift can relate to specific applications such as CLIs, GUIs, etc.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:any processContents="strict" maxOccurs="unbounded" />
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="name" type="tns:name-type" use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of this profile e.g. "ldap".
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines the root managed object and its relationships with
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift top-level managed objects. The root managed object serves as a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift single point of access to the rest of the configuration. It is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift essentially a virtual managed object and has no properties of
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift its own, just relationships. There can only be a single root
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed object defined per configuration model.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:extension base="tns:managed-object-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of the product associated with this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift configuration model.
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift <xsd:element name="tag-definition" minOccurs="0"
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift maxOccurs="unbounded">
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift Defines a tag which can be used to group related types
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift of managed object. Administration tools can take
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift advantage of managed object tags to make it easier for
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift users to discover related components.
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift A brief description of this tag. The description
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift should describe, preferably in one sentence, the
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift types of managed object that this tag applies
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift to. The synopsis should be suitable for use in
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift applications such as tool-tips, CLI help, and
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift the summary description in Javadoc. It is
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift possible to embed rich content including XHTML
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift markup (this will only be used where supported).
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift <xsd:choice minOccurs="0" maxOccurs="unbounded">
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift processContents="lax" />
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift The name of the product associated with
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift this definition.
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift <xsd:attribute name="name" type="tns:name-type"
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift use="required">
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift The name of this tag. The name should describe as
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift concisely as possible the purpose of this tag and
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift should be suitable for use in Java method names
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift (e.g. getters and setters). The property name
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift should be a string comprising of short lower-case
408b8eb145348cb8f251a8abfec96e7e4e80f630matthew_swift words joined with hyphens "-". For example,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="name" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift fixed="root">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of this root managed object, which is always
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="package" type="tns:package-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The package containing this root managed object, which
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines the structure of a configurable component within the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift configuration. A managed object comprises of zero or more
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift properties, and zero or more relations with other managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift objects. A managed object can be abstract, indicating that it
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift cannot be instantiated directly, and that it is intended as a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift base definition from which other child managed objects inherit
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift their behavior. Conversely, a managed object can be derived from
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift a parent managed object definition. In this case, the managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift object will inherit the properties and relations defined by the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift parent. Multiple levels of inheritance are supported, but
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift multiple inheritance is not.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:extension base="tns:managed-object-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="name" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The name of this managed object. The name should
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift describe as concisely as possible the role of this
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift managed object and should be suitable for use in Java
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift method names (e.g. class names). The managed object name
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should be a string comprising of short lower-case words
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift joined with hyphens "-". For example,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift "ldap-connection-handler". NOTE: a managed object name
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift must end in the name of the definition's uppermost
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift super-type. For example, "ldap-connection-handler" is a
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift sub-type of "connection-handler" and therefore ends in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift "-connection-handler".
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="plural-name" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The plural name of this managed object. The plural name
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should correspond to the singular name defined in the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift "name" attribute and it should be suitable for use in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Java method names (e.g. getters). The managed object
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift plural name should be a string comprising of short
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift lower-case words joined with hyphens "-". For example,
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift "ldap-connection-handlers".
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="package" type="tns:package-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The package containing this managed object.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="abstract" type="xsd:boolean"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Indicates whether or not this managed object is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift abstract. Abstract managed objects cannot be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift instantiated directly and are intended for use as base
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift definitions for inheritance.
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift <xsd:attribute name="advanced" type="xsd:boolean"
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift Indicates whether or not this managed object should be
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift treated as advanced and therefore should be hidden by
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift default in client applications. This feature is not
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift inherited by child managed objects.
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift <xsd:attribute name="hidden" type="xsd:boolean" use="optional"
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift default="false">
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift Indicates whether or not this managed object should be
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift hidden from client applications. Hidden managed objects
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift should rarely be used but are sometimes required in
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift order to provide functionality that needs to be exposed
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift in management APIs but not in front-ends such as CLIs.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="extends" type="tns:name-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
9355c1819517672f3cfe09356402fe0257c96facmatthew_swift Indicates whether or not this managed object inherits
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift from a parent managed object and, if so, the name of the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift parent. If specified, this managed object will inherit
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift all of the properties and relations defined in the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift parent managed object.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="parent-package" type="tns:package-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="optional">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The package containing the parent managed object. By
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift default, the package in which this managed object is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift defined will be used.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines a common information associated with all managed objects
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift defined in the containing package. A package definition
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift comprises of a description of the package together with common
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift property definitions which can be referenced from within managed
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift objects using "property-reference" elements. Sharing property
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift definitions in this way makes maintenance easier in situations
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift where the property definition needs modifying, since all
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift referencing managed objects will automatically inherit the
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="TODO" minOccurs="0" type="xsd:string"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift maxOccurs="unbounded">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift An annotation specifying remaining work or unsolved
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift problems relating to this package definition. Its use is
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift primarily for development purposes and should not be
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift processed by applications.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="synopsis" type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A brief description of this package. The description
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should describe, preferably in one sentence, the purpose
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift of this package, for example, the type of managed objects
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift it defines. The synopsis should be suitable for use in
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift applications such as tool-tips, CLI help, and the summary
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description in Javadoc. It is possible to embed rich
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift content including XHTML markup (this will only be used
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:rich-description-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift A detailed description of this package. The description
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should describe in detail the purpose of this package. The
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift description should be suitable for use in applications
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift such as manual pages or detailed help. It does not need to
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift repeat anything described in the synopsis as applications
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift should normally display the two together. It is possible
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift to embed rich content including XHTML markup (this will
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift only be used where supported).
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:element name="property" minOccurs="0" maxOccurs="unbounded"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift type="tns:property-type">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Defines a common configurable property for this package.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift Managed objects can inherit this property definition by
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift referencing it using a "property-reference" element.
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift <xsd:attribute name="name" type="tns:package-type"
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift use="required">
bb8874d71cdd8e5288297b9727703437c6dfcfedmatthew_swift The package containing this package definition.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift A condition which evaluates to true if the sub-condition is
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift false, or false if the sub-condition is true.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift A condition which evaluates to true if and only if all of
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift its sub-conditions are true.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift <xsd:group ref="tns:condition-group" maxOccurs="unbounded" />
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift A condition which evaluates to false if and only if none of
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift its sub-conditions are true.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift <xsd:group ref="tns:condition-group" maxOccurs="unbounded" />
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift Creates a condition which evaluates to false if and only if
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift the first sub-condition evaluates to true and the second
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift sub-condition evaluates to false. This can be used to
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift represent if-then relationships.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift A condition which evaluates to true if and only if a
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift property contains a particular value.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift <xsd:attribute name="property" type="tns:name-type"
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift use="required">
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift The name of the property to be tested.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift use="required">
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift <xsd:documentation>The property value.</xsd:documentation>
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift Creates a condition which evaluates to true if and only if a
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift particular property has any values specified.
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift <xsd:attribute name="property" type="tns:name-type"
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift use="required">
f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24matthew_swift The name of the property to be tested.