Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

qmf.content field

Data Type

Description

_schema_package

STRING

Schema package name

_schema_id

SCHEMA_ID

Schema class identifier

_schema_class

SCHEMA_CLASS

Schema class definition

_object_id

OBJECT_ID

Managed object identifier

_data

QMF_DATA

Data, managed and/or described or free-form

_event

QMF_EVENT

Event

_query

QMF_QUERY

Query

...

No Format
  SCHEMA_ID := { _package_name: STRING,
                 _class_name:   STRING,
                 _type:         '_data' | '_event',
                 _hash:         UUID
               }

Field

Optional

Description

_package_name

no

Package name (namespace) for the described class

_class_name

no

Name of the described class

_type

no

Class type: data or event

_hash

yes

Hash (uuid) to distinguish different versions of a class

...

No Format
  SCHEMA_CLASS := { _schema_id:        SCHEMA_ID,
                    _valuesdesc:      { EACH_ATTR_NAME: SCHEMA_PROPERTY | SCHEMA_METHOD }       STRING,
                    _subtypes:default_severity: NUMBER,
   { EACH_ATTR_NAME: qmfProperty | qmfMethod }
            _properties:      }

Field

Optional

Description

_schema_id

no

Identifier for this schema class

_values

no

Map of schema attribute names and either their property or method descriptions. The subtype defines whether an attribute is a property or a method.

_subtypes

no

Map of subtype names ('qmfProperty' or 'qmfMethod') for each attribute

SCHEMA_PROPERTY

 [SCHEMA_PROPERTY, ...],
                    _methods:          [SCHEMA_METHOD, ...]
                  }

Field

Optional

Description

_schema_id

no

Identifier for this schema class

_desc

yes

Description of the schema class

_default_severity

yes

Default severity for an event class

_properties

no

List of SCHEMA_PROPERTY elements describing the properties of the class

_methods

no

List of SCHEMA_METHOD elements describing the methods of the class

SCHEMA_PROPERTY

No Format

  SCHEMA_PROPERTY := { _name:       STRING,
                       _type:       QMF_TYPE,
                       _index
No Format

  SCHEMA_PROPERTY := { _type:       QMF_TYPEBOOL,
                       _access:     'RO' | 'RC' | 'RW',
                       _unit:       STRING,
                       _min:        NUMBER,
                       _max:        NUMBER,
                       _maxlen:     NUMBER,
                       _dir:        'I' | 'O' | 'IO',
                       _desc:       STRING,
                       _references: SCHEMA_ID,
                       _subtype:    QMF_SUBTYPE
                     }

Field

Optional

Description

_name

no

The name of the property

_type

no

The QMF data type of this property this property

_index

yes

True iff this property is an index of an object. Default is False.

_access

yes

The remote access rules for this property:
RO => Read Only (default if not specified)
RC => Read Create
RW => Read Write

_unit

yes

Annotation. Units of measure for numeric values

_min

yes

Minimum numeric value

_max

yes

Maximum numeric value

_maxlen

yes

Maximum length of a variable length value (in octets)

_dir

yes

Used only for method arguments. Direction of transfer:
I => Input (caller to callee)
O => Output (callee to caller)
IO => Both

_desc

yes

Annotation. Description of the property

_references

yes

If the type is a reference to another managed object, this field may be used to specify the required class for that object

_subtype

yes

May be used to further specify the meaning of the value of this field. For example, a number may actually be a timestamp or a duration. A string may be a reference to another object, or a URL.

QMF_TYPE

No Format
  QMF_TYPE := 'TYPE_VOID'   |
              'TYPE_BOOL'   |
              'TYPE_INT'    |
              'TYPE_FLOAT'  |
              'TYPE_STRING' |
              'TYPE_MAP'    |
              'TYPE_LIST'   |
              'TYPE_UUID'

QMF_SUBTYPE

No Format
  QMF_SUBTYPE := 'reference' |
                 'url'       |
                 'timestamp' |
                 'duration'

SCHEMA_METHOD

No Format
  SCHEMA_METHOD := { _descname:      STRING,
                     _argumentsdesc: { EACH_ARG_NAME:       STRING,
                     _arguments: [SCHEMA_PROPERTY, }...]
                   }

Field

Optional

Description

_name

no

The name of the method

_desc

yes

Annotation. Description of this method

_arguments

no

Map List of argument names and SCHEMA_PROPERTY data to describe them elements that describe the method's arguments

QMF_METHOD_CALL

No Format
  QMF_METHOD_CALL := { _object_id:   OBJECT_ID,
                       _method_name: STRING,
                       _arguments:   { EACH_KEY: VALUE },
                       _subtypes:    { EACH_KEY: STRING }
                     }

...

No Format
  QMF_QUERY := { _what:      QMF_CONTENTQUERY_TYPETARGET,
                 _where:     QMF_QUERY_PREDICATE,
                 _object_id: OBJECT_ID,
         STRING | SCHEMA_ID | OBJECT        _schema_id: SCHEMA_ID
               }

Field

Optional

Description

_what

no

Identifies the kind of data being queried

_where

yes

Query predicate to limit the number of results of the query

_object_id

yes

(Alternative to _where) This identifier indicates which single item the query is looking for. If the content-type in _what is:
an Object => _id is the OBJECT_ID of the object;
a Schema => _id is the SCHEMA_ID of the schema;
an Agent => _id is the name of the agent.

QMF_CONTENT_TYPE

Identifier of a single object being queried

_schema_id

yes

Identifier of a single schema being queried

QMF_QUERY_TARGET

No Format

  QMF_QUERY_TARGET := 'SCHEMA_ID' |
No Format

  QMF_CONTENT_TYPE := { _agent:     VOID }
                   := { _schema_id: VOID }
                   := { _schema: 'SCHEMA'   VOID }|
                   := { _object_id: VOID | SCHEMA 'OBJECT_ID' }|
                   := { _object:    VOID | SCHEMA_ID } 'OBJECT'

QMF_QUERY_PREDICATE

QMF_SUBSCRIBE

...