Page History

...

• Implement QMF protocol via QPID Map messages

• Improve thread safety by simplifying minimizing the callback notification mechanism.

• Reorganize QMF code into common API, Console API, and Agent API modules.

Common Object Classes

Object classes that are used by Agent and Console components.

Schema

Schemas are used by QMF to describe the structure of management data.

Schema Types

There are two classes (or types) of Schema - those that describe QmfData objects, and those that describe QmfEvent objects.

SchemaTypeData:
SchemaTypeEvent:

These types may be represented by the strings "data" and "event", respectively.

Schema Identifier

Schema are identified by a combination of their package name and class name. A hash value over the body of the schema provides a revision identifier. The class SchemaClassId represents this Schema identifier.

class SchemaClassId:
      <constructor>( package=<package-name-str>, 
                     class=<class-name-str>,
                     type=<SchemaTypeData|SchemaTypeEvent>)
                     hash=<hash-str, format="%08x-%08x-%08x-%08x">, 
      .getPackageName(): returns <package-name-str>
      .getClassName(): returns <class-name-str>
      .getHashString(): returns <hash-str, "%08x-%08x-%08x-%08x">
      .getType(): returns SchemaTypeObject or SchemaTypeEvent
      .mapEncode(): returns a map encoding of the instance.

If the hash is not supplied, then the default value "00000000-00000000-00000000-00000000" will be supplied. This may be the case when a SchemaClass is being dynamically constructed, and a proper hash is not yet available.

The map encoding of a SchemaClassId:

Schema for describing data Properties

The SchemaProperty class represents the description of a property datum. Once instantiated, the SchemaProperty is immutable.

• Move to a work-queue based event model.

Component Addressing

QMF uses AMQP messaging as the means for communications between Console and Agent components. Thus instances of Agents and Consoles must have addresses which uniquely identify them within the AMQP messaging domain.

QMF uses AMQP string types to represent Agent and Console addresses. These strings are assigned by the application, and their contents are opaque to the QMF implementation.

A QMF address is composed of two parts - an optional domain string, and a mandatory name string. The domain string is used to construct the name of the AMQP exchange to which the component's name string will be bound. If not supplied, the value of the domain defaults to "default". Both Agents and Components must belong to the same domain in order to communicate.

When a Console or Agent is instantiated, it will create a receiving endpoint (source) on the AMQP message domain. The endpoint's address will be sent as the reply_to field for all messages originating from that Console or Agent. The address of the endpoint is created from the value of the domain and name strings, using the following format:

    "qmf.<domain-string>.direct/<name-string>"

Data Model

Representation of Managment Data

The QMF data model supports two methods for representing management data:

1. arbitrarily structured data
2. data with a formally defined structure

Arbitrarily structured data is the simpliest method for representing data under QMF. It consists of a set of named data values. Each data value is represented by a primitive AMQP data type. The data is accessed using the data's name as a key. QMF represents arbitrarily structured data as a map of AMQP data types indexed by a name string.

Data that has a formally defined structure extends the data representation by associating the data with a Schema. The Schema describes the structure of all instances of data that are based on that Schema. This is akin to a record type in database design.

Both types of data representations can be managed by an agent. Managed data includes:

1. an object identifier
2. object lifecycle state

An object identifier uniquely addresses a data object within the domain of its managing agent. QMF represents the object identifier as an opaque string. An object identifier can be assigned to the object by the agent when the object is instantiated. Alternatively, a schema can define an object identifier by defining an ordered list of names of data items. In this case, the object identifier string is built by concatenating the string representations of the value of each named data item. This approach is similar to defining index fields within a database record.

For example, assume a managed object with the following map of data item values:

{"field1" : "foo",
 "field2" : "bar",
 "field3" : 42,
 "field4" : "baz"}

and assume the data item list defined by the managed object's schema is:

["field1", "field3"]

The identifier for this data object would be:

"foo42"

QmfData Class

QMF defines the QmfData class to represent an atomic unit of managment data. The QmfData class defines a collection of named data values. Optionally, a string tag, or "sub-type" may be associated with each data item. This tag may be used by an application to annotate the data item.

When representing formally defined data, a QmfData instance is assigned a Schema.

When representing managed data, a QmfData instance is assigned an object identifier (either explicitly, or via the Schema).

class QmfData:
      <constructor>( _values=map of "name"=<AMQP Type> pairs,
                     _subtypes=optional map of "name"=<AMQP String> pairs for subtype information,
                     _tag=optional, application-specific tag applied to this QmfData instance

class SchemaProperty:
      <constructor>( name=<name-value>, 
                     type=<type-value>,
                     ...)
      .getName(): name of property (string)
      .getType(): typecode for property data
      .getAccess(): "RC"=read/create, "RW"=read/write, "RO"=read only (default)
      .isIndex(): True if this property is an index.
      .isOptional(): True if this property is optional
      .getUnit(): string describing units (optional)
      .getMin(): minimum value (optional)
      .getMax(): maximum value (optional)
      .getMaxLen(): maximum length for string values (optional)
      .getDesc(): optional string description of this Property
      .getReference(): if type==objId, name (str) of referenced class
                       (_object_id=optional) 
AMQP string that uniquely   .isParentRef(): True if identifies this property references an object inQmfData instance.
                     _schema=optional <class whichSchemaClass> thisreference
 object is in a child-parent
                _const=False )
      relationship.<constructor>( _map=map representation of QmfData, as generated by mapEncode() method,
                     _schema=optional <class SchemaClass> reference
                     _const=False)
      .mapEncodeis_managed(): returns True aif object mapidentifier encodingstring ofassigned, theelse instance.

The map encoding of a SchemaProperty:

Schema for describing a Statistic

The SchemaStatistic class represents the description of a statistic datum. Once instantiated, the SchemaStatistic is immutable.

class SchemaStatistic:
      <constructor>( name=<name-value>, 
                     type=<type-value>,
                     ... )
      .getName(): name of the statistic (string)
      .getType(): typecode for statistic
      .getUnit(): string describing units (optional)False.
      .is_described(): returns True if schema is associated with this instance
      .get_tag(): return this object's tag if present, else None
      .get_value(name): return the value of the named data item, returns None if named property is not present.
      .has_value(name): returns True if the named data item is present in the map, else False.
      .set_value(name, value, subType=None): set the value of the named data item. Creates a new item if the named data does not exist. Raises an exception if _const is True.
      .get_subtype(name): returns the sub type description string, else None if not present.
      .set_subtype(name, subType): set or modify the subtype associated with name.
      .get_object_id(): returns the object id string associated with the object instance, or None if no id assigned.
      .get_schema_class_id: returns the identifier of the Schema that describes the structure of the data, or None if no schema.
      .getDescmap_encode(): string descriptionreturns a map representation of thisthe statistic (optional)
      .mapEncode(): returns a map encoding of the instance.
QmfData instance, suitable for use by the constructor.

QMF uses a map encoding to represent a QmfData class in an AMQP message. The map encoding of an instance of the QmfData Class is made up of the following elementsThe map encoding of a SchemaStatistic:

Schema for describing Method Calls

The Schema for describing a method call involves two classes. The SchemaMethod class describes the method's structure, and contains a SchemaArgument class for each argument declared by the method. An Agent may construct a SchemaMethod's argument list.

QmfEvent Class

QMF supports event management functionality. An event is a notification that is sent by an Agent to alert Console(s) of a change in some aspect of the system under management. Like QMF Data, Events may be formally defined by a Schema or not. Unlike QMF Data, Events are not manageable entities - they have no lifecycle. Events simply indicate a point in time where some interesting action occurred.

An instance of an event is represented by the QmfEvent class.

An AMQP timestamp value is associated with each QmfEvent instance. It indicates the moment in time the event occurred. This timestamp is mandatory.

A severity level may be associated with each QmfEvent instance. The following severity levels are supported:

• "emerg" - system is unusable
• "alert" - action must be taken immediately
• "crit" - the system is in a critical condition
• "err" - there is an error condition
• "warning" - there is a warning condition
• "notice" - a normal but significant condition
• "info" - a purely informational message
• "debug" - messages generated to debug the application

The default severity is "notice".

class QmfEvent(QmfData):

class SchemaMethod:
      <constructor>( name=<name-value>,
                     [args=<list of SchemaArguments>]
      .getName(): name of method
      .getArgCount(): count of arguments
      .getArguments(): returns a list of SchemaArgument instances, one
      <constructor>( timestamp,
                for each argument.
   _severity=<string>,
   .getArg(index): return the SchemaArgument at index 
      .addArgument(SchemaArgument): adds a SchemaArgument 
  _values=map of   .mapEncode(): returns a map encoding of the instance.

class SchemaArgument:
"name"=<AMQP Type> pairs,
                     _subtypes=optional map <constructor>(of "name=<name-value>"=<AMQP String> pairs for subtype information,
                     type=<type-value>,
_tag=optional, application-specific tag applied to this QmfEvent instance
                      ..._schema=optional <class SchemaEventClass> )
       .getName(): name<constructor>( _map= map encoding of argument
a QmfEvent instance,
       .getType():  type of argument
      .getDirection(): "I"=input, "O"=output, or "IO"=input/output
      .getUnit(): string describing units (optional_schema=optional <class SchemaEventClass> )
      .getMinget_timestamp(): minimumreturn value (optional)
      .getMax(): maximum value (optional)a timestamp indicating when the Event occurred.
      .getMaxLenget_severity(): maximumreturn lengththe forseverity stringassociated values (optional)
      .getDesc(): string description of this argument (optional)with the Event.
      .getDefaultmap_encode(): defaultreturn value.
a map encoding of the  .getRefPackage(): return name of the package referenced by this argument
      .getRefClass(): return name of the class referenced by this argument
      .mapEncode(): returns a map encoding of the instance.
Event.

The map encoding of an instance of the QmfEvent class extends the map of the parent class with the following class properitesThe map encoding of a SchemaArgument:

The map encoding of a SchemaMethod:

Schema for Data Objects and Events

A top-level data object in QMF is a collection of statistics, properties, and methods. Data objects are described by the class SchemaObjectClass. Data objects may be managed (owned) by an Agent.

Events describe a change within the underlying management system. Unlike data objects, events do not correspond to a managable entity. They are composed of a list of arguments that apply to the event. Event objects are described by the class SchemaEventClass.

Both of these classes derive from the virtual base SchemaClass.

Agent applications may dynamically construct instances of these objects by adding properties/statistics/methods/etc. at run time.However, once the Schema is published, it must be considered immutable, as the hash value must be constant once the Schema is in use.

Schema

Schemas are used by QMF to describe the structure of management data and events. The use of Schemas is optional.

Schema Types

There are two classes (or types) of Schema - those that describe data objects, and those that describe event objects.

SchemaTypeData:
SchemaTypeEvent:

These types may be represented by the strings "_data" and "_event",
respectively.

Schema Identifier

Schema are identified by a combination of their package name and class
name. A hash value over the body of the schema provides a revision
identifier. The class SchemaClassId represents this Schema
identifier.

class SchemaClassId:
      <constructor>( package=<package-name-str>,
                     class=<class-name-str>,
                     type=<SchemaTypeData|SchemaTypeEvent>)
                     hash=<hash-str, format="%08x-%08x-%08x-%08x">,
      .get_package_name(): returns <package-name-str>
      .get_class_name(): returns <class-name-str>
      .get_hash_string(): returns <hash-str, "%08x-%08x-%08x-%08x">
      .get_type(): returns SchemaTypeObject or SchemaTypeEvent

class SchemaClass:
      <constructor>( package=<package-name-str>, 
                     class=<class-name-str>,
                     type=<SchemaTypeData|SchemaTypeEvent>)
                     hash=<hash-str, format="%08x-%08x-%08x-%08x">)
      .getClassIdmap_encode(): returns returna themap SchemaClassIdencoding thatof identifiesthe this
                      Schema instance.
      .generateHash(): generate a hash over the body of the schema,
                       and return a string representation of the hash
                       in format  instance.

If the hash value is not supplied, then the value of the hash string will be set to None. This will be the case when a SchemaClass is being dynamically constructed, and a proper hash is not yet available.

The map encoding of a SchemaClassId:

Schema For Describing The Properties of a Data Item

The SchemaProperty class describes a single data item in a QmfData object. A SchemaProperty is a list of named attributes and their values. QMF defines a set of primitive attributes. An application can extend this set of attributes with application-specific attributes.

QMF reserved attribute names all start with the underscore character ("_"). Do not create an application-specific attribute with a name starting with an underscore.

Once instantiated, the SchemaProperty is immutable.

class SchemaProperty
      .mapEncode(): returns a map encoding of the instance.


class SchemaObjectClass(SchemaClass):
      <constructor>( packagename=<package<name-name-str>value>, 
                     classtype=<class<type-name-str>value>,
                     type=<SchemaTypeData|SchemaTypeEvent>...)
      .get_type(): AMQP typecode for encoding/decoding the property data
        hash=<hash-str, format="%08x-%08x-%08x-%08x">,
   .get_access(): "RC"=read/create, "RW"=read/write, "RO"=read only (default)
      .is_optional(): True if this property is optional
      _properties=[list of SchemaProperty instances],.get_unit(): string describing units (optional)
      .get_min(): minimum value (optional)
            _stats=[list of SchemaStatistics instances],.get_max(): maximum value (optional)
      .get_max_len(): maximum length for string values (optional)
         _methods=[list.get_desc(): optional string description of SchemaMethodthis instances])Property
      .getPropertyCountget_direction(): return the number of properties. "I"=input, "O"=output, or "IO"=input/output (required for method arguments, otherwise optional)
      .getStatisticCountget_subtype(): string returnindicating the numberformal ofapplication statistics.
type for the    .getMethodCount(): return the number of methodsdata, example: "URL", "Telephone number", etc.
      .getPropertyis_polled(index): return True if changes to the index'th SchemaProperty.
      .getStatistic(index): return the index'th SchemaStatistic.
      .getMethod(index): return the index'th SchemaMethod

      .addProperty(SchemaProperty): append a new propertydata cannot be practically monitored by an Agent.  Such a data item can only
          be queried or polled - not published on change.
      .addStatisticget_reference(SchemaStatistic): append a new statistic
      .addMethod(SchemaMethod): append a new method.


class SchemaEventClass(SchemaClass):if type==objId, name (str) of referenced class (optional)
      <constructor>( package=<package-name-str>, 
              .is_parent_ref(): True if this property references an object in which this object is in a child-parent relationship.
       class=<class-name-str>,
                     type=<SchemaTypeData|SchemaTypeEvent>).get_attribute("name"): get the value of the attribute named "name". This method can be used to retrieve
          application-specific attributes.  "name" should start with the    hash=<hash-str, format="%08x-%08x-%08x-%08x">,prefix "x-"
                     _arguments=[list of SchemaArgument instances])
      .getArgCount(): return the count of arguments.
      .getArgument(index): return the index'th SchemaArgument.

      .addArgument(SchemaArgument): append a new argument.
.map_encode(): returns a map encoding of the instance.

The map encoding of a SchemaProperty's bodyThe map encoding of a SchemaObjectClass:

The map encoding of a SchemaEventClass:

Data Model

The QMF defines three layers of data representation:

1. arbitrarily structured data
2. structured data
3. managed structured data

Arbitrarily structured data is represented by a map of named data items. There is no schema associated with this data, as its structure is arbitrary. This class of data is represented by the QmfData class.

Data that has a formally defined structure is represented by the QmfDescribed class. This class extends the QmfData class by associating the data with a formal schema.

Managed structured data extends the concept of structured data by providing an owner for the data. In QMF, this owner is an Agent.This class of data extends the QmfDescribed class by adding an identifier of the owning Agent.

QmfData Class

Schema For Describing Method Calls

The SchemaMethod class describes a method call's parameter list. The parameter list is represented by an unordered map of SchemaProperty entries indexed by parameter name.

class SchemaMethod

class QmfData:
      <constructor>( map[args=<map of "name=value" pairs )

QmfDescribed Class

class QmfDescribed(QmfData):
:<SchemaProperty> entries>],
       <constructor>( class QmfData, class SchemaClassId )
      .getSchemaClassId(): returns the identifierdesc="description of the Schema thatmethod")
      .get_desc(): return human-readable description of the method.
      .get_argument_count():          describes return the structurenumber of the data.arguments
      .getIndexget_arguments(): returnreturns a string composed fromcopy of the map of "indexname" property:<SchemaProperty>
      .get_argument("name"): return the SchemaProperty for the parameter "name"

      values. 
      .getProperties(): return a list of (SchemaProperty, value) pairs
                        for each of the object's properties.add_argument("name", SchemaProperty): adds an additional argument to the parameter list.
      .getStatisticsmap_encode(): returnreturns a list of (SchemaStatistics, value)
                        pairs for each map encoding of the object's statistics.

QmfManaged Class

The QmfManaged class represents a data object that is owned by a particular Agent. All QmfManaged objects contain a unique object identifier.

The QmfManaged class extends the QmfDescribed class:

class QmfManaged(QmfDescribed):
      .getObjectId(): return ObjectId for this object.

Object Identification

An instance of managed object must be uniquely identified within the management system. Each managed object is given a name that is unique within the domain of the object's managing Agent. Note that these names are not unique across Agents. Therefore, a globally unique name
for an instance of a managed object is the concatenation of the object's name and the managing Agent's name. This unique object identifier is represented by the ObjectId class.

ObjectIds are considered hashable. That is, it is a requirement that ObjectIds are deterministically sortable.

SchemaMethod instance

The map encoding of a SchemaMethod:

Note that the "dir" SchemaProperty attribute applies to each
argument. If "dir" is not specified, it is assumed to be "I".

Schema for Data Objects and Events

The structure of QmfData objects is formally defined by the class SchemaObjectClass.

The structure of QmfEvent objects is formally defined by the class SchemaEventClass.

Both of these classes derive from the virtual base SchemaClass.

Agent applications may dynamically construct instances of these objects by adding properties and methods at run time. However, once the Schema is made public, it must be considered immutable, as the hash value must be constant once the Schema is in use.

QMF defines the following classes to represent data and event schema:

class SchemaClass(QmfData)

class ObjectId:
      <constructor>(agent classId="agent<class name"SchemaClassId>,
 
                    name="object name"_desc=optional AMQP string containing a human-readable description for this schema)
      .getAgentNameget_class_id(): returns <agent name> string return the SchemaClassId that identifies this Schema instance.
      .getObjectNamegenerate_hash(): returnsgenerate a <objecthash name>over string.
the body of the schema,  .operators(==, !=, <, >) supported.

QmfEvent Class

A QMF Event is a type of QmfDescribed data that is not managed.
Events are notifications that are sent by Agents. Unlike QmfManaged objects, events do not correspond to managed data on the Agent. Instead, an event notifies a Console of a change in some
aspect of the system under managment. For example, an event may indicate that a threshold was exceeded, or a resource was returned. The structure of an event is described by the SchemaEventClass. An instance of an event is represented by the QmfEvent class.

and return a string representation of the hash in format  "%08x-%08x-%08x-%08x"

The map encoding of an instance of the SchemaClass class extends the map of its parent class with elements for the following class properties.

class SchemaObjectClass(SchemaClass

class QmfEvent(QmfDescribed):
      <constructor>( classId=<class timestampSchemaClassId>,
 argument_list )
      .getTimestamp(): return a timestamp indicating when the Event
      _desc=optional AMQP string containing a human-readable description for this schema,
        triggered.
      .getArguments(): return a list of (SchemaArgument, value) pairs
    _props=map of "name"=<SchemaProperty> instances,
   .getArgument(<name>): return the value of argument <name>
      ?tbd? do we need to identify the originating Agent?

Data Management

The role of a QMF component determines how it will interact with managment data. Therefore the QmfManaged class is subclassed to provide an Agent specific implementation and a Console specific
implementation.

The Console application represents a managed data object by the QmfConsoleData class. The Console has "read only" access to the statistics and properties in the data object via this class. The Console can also invoke the methods defined by the object via this class. The actual data stored in this object is cached from the Agent. In order to update the cached values, the Console invokes the refresh() method.

Note that the refresh() and invokeMethod() methods require communication with the remote Agent. As such, they may block. For these two methods, the Console has the option of blocking in the call until the call completes. Optionally, the Console can receive a notification asynchronously when the operation is complete. See below for more detail regarding synchronous and asynchronous API calls.

class QmfConsoleData(QmfManaged):
      <constructor>(?tbd?)_meths=map of "name"=<SchemaMethod> instances,
                     _id_names=(optional) ordered list of "name"s used to identify the properties whose values are used to construct the object identifier)

      .get_id_names(): return an ordered list of names of the values that are used to construct the key for identifying
          unique instances of this class.  Returns None if no list defined.
      .get_property_count(): return the count of SchemaProperty's in this instance.
      .getTimestampsget_properties(): returnsreturn a listmap of timestamps describing the
     "name":<SchemaProperty> entries for each value in the object.
      .get_property("name"): return the SchemaProperty associated with "name", else None if "name" value does lifecycle of the object:
not exist.

      .get_method_count(): return the count SchemaMethod's in this instance.
      .get_methods(): return a map of "name":<SchemaMethod> entries [0]for =each timemethod ofassociated lastwith update from Agent,the object.
      .get_method("name"): return the SchemaMethod associated with the "name", else None if "name" does not exist or is not [1] = creation timestamp a method.

                        [2] = deletion timestamp, or zero if not deleted.add_property("name", SchemaProperty): add a new property.
      .isDeleted(add_method("name", SchemaMethod): Trueadd ifa deletion timestamp not zeronew method.
      .refreshset_id_names([reply-handle | timeoutname-list]): requestset that the Agent
value of the order list of names to use when           update the value of this object's contents.
      .invokeMethod(name, inArgs[], [[reply-handle] | [timeout]]): constructing the object identifier.

The map encoding of an instance of the SchemaObjectClass class extends the map of its parent class with elements for the following class properties.

class SchemaEventClass(SchemaClass):
      <constructor>( classId=<class SchemaClassId>,
                  invoke the named method.
      .getStatistic(name): return the value of the named statistic
 _desc=optional AMQP string containing a human-readable description for this event,
          .getProperty(name): return the value of the named property.

The Agent that manages the data represents it by the QmfAgentData class. The Agent is responsible for managing the values of the properties and statistics within the object, as well as
servicing the object's method calls. Unlike the Console, the Agent has full control of the state of the object.

class QmfAgentObject(QmfObject):
   _props=map of  <constructor>( ObjectId, ?tbd?"name":SchemaProperty instances)
      .destroyget_property_count(): markreturn the objectnumber asof deletedproperties.
 by setting the deletion
  .get_properties(): return a map of "name":<SchemaProperty> entries for each property       timestamp to the current timein the event.
      .setObjectId(ObjectIdget_property("name"): setreturn the valueSchemaProperty ofassociated thewith ObjectId"name".

      .setPropertyadd_property("name", valueSchemaProperty): updateadd the value of thea new property.
      .setStatistic(name, value): set the value of a statistic.
      .incStatistic(name, delta): add the delta to the statistic.
      .decStatistic(name, delta): subtract the delta from the statistic.
      ?tbd?

Note that some languages will allow properties, statistics, and methods to act as attributes of the QmfObject itself. As an example, assume an QmfConsoleObject exists with a property named "state". In python, it will be possible to access the value of "state" as if it where an attribute of the QmfConsoleObject. The following two statements are equivalent:

The map encoding of a SchemaEventClass instance uses the same format as the map for the SchemaClass.

Data Management

QMF allows data managment via the Query, Subscription, and Method Call actions.

Queries

A Query is a mechanism for interrogating the management database. A Query represents a selector which is sent to an Agent. The Agent applies the Query against its management database, and returns those objects which meet the constraints described in the query.

A Query must specify the class of information it is selecting. This class of information is considered the target of the query. Any data objects selected by the query will be of the type indicated by the target.

A Query may also specify a selector which is used as a filter against the set of all target instances. Only those instances accepted by the filter will be returned in response to the query.

Queries are expressed using the following map syntax:

{"query": {"what":<target>,

           print("My state is '%s'" %
                 myQmfConsoleObject.getProperty("state"))

           print("My state is '%s'" %
                 myQmfConsoleObject.state)

Be aware - a QmfConsoleObject provides read-only access, so the
following statement would be illegal:

           myQmfConsoleObject.state = "up"

Invoking Methods

A managed object's methods provide a mechanisms for a Console application to perform a "remote procedure call" against the object. The method actually executes on the Agent, and the result is passed back to the Console on completion.

The value(s) returned to the Console when the method call completes are represented by the MethodResult class. The MethodResult class indicates whether the method call succeeded or not, and, on success, provides access to all data returned by the method call.

Should a method call result in a failure, this failure is indicated by the presence of a QmfData object in the MethodResult. This object is described as an "exception", and contains a description of the reason for the failure. There are no returned arguments when a method call fails.

A successful method invokation is indicated by the absence of an exception in the MethodResult. In addition, a map of returned argument values may be present. The structure of the returned
arguments is described by the SchemaArgument list associated with the MethodSchema that defines the method. The map contains only those arguments that the SchemaArgument marks with an "output" direction.

class MethodResult:
      <constructor>( QmfData <exception> | <argument-map> )
      .getException(): returns exception data if method fails.
      .getArgumentCount(): returns number of arguments.
      .getArguments(): returns a list of (SchemaArgument, value) pairs
                       for each returned argument.
      .getArgument(<name>): returns value of argument named "name".

Queries

A Query is a mechanism for interrogating the management database. A Query represents a selector which is sent to an Agent. The Agent applies the Query against the management database, and returns those objects which meet the constraints contained in the query.

class Query:
      <constructor>(<SchemaClassId> | 
                    <ObjectId> | 
                    <package-name>[, <class-name>])
      .getSchemaClassId()
      .getObjectId()
      .getPackageName()
      .getClassName()

The target for a Query is determined by the constructor. When a Query is created using a SchemaClassId, it will match against the SchemaClass identified by that key. When a Query is created using an ObjectId, it will match against the QmfObject or Event identified by
that ObjectId. When a Query is created with only a package name, it will return all class names that belong to that package. If both the package and class names are provided, the Query will match against the SchemaClassId identified by the combination of those names.

Subscriptions

A subscription is a mechanism for monitoring management data for changes in its state. A Console creates a subscription with an Agent based on a Query. The Query specifies the set of management data that is to be monitored. When the Agent detects changes to the selected set, a notification is sent to the subscribing Console(s). A Subscription is represented by the SubscriptionId class. A Console must cancel the subscription when the console no longer needs to monitor the data.

class SubscriptionId:
      ?tbd?

Agent Identifiers

An Agent is uniquely identified by an AgentId. An AgentId is a three-tuple containing:

• the name of the vendor that produced the agent
• the name of the product using the agent
• the name of the agent component within the product.

This naming convention allows for a single product to host multiple distinct Agents. The Agent identifier is represented by the AgentId class. An AgentId is considered hashable. That is, it is a requirement that AgentIds are deterministically sortable.

class AgentId:
      <constructor>( vendor, product, name )
      .getVendor(): return the vendor name string
      .getProduct(): return the product name string
      .getName(): return agent component name string

By convention, AgentIds are specified as a string containing the vendor, product, and name strings separated by colons ":", in that order. For example: "company.com:OurProduct:AnAgent"

Console application model

A QMF console component is represented by a Console class. This class is the topmost object of the console application's object model.

A Console is composed of the following objects:

• a connection to the AMQP bus
• a queue of inbound work items
• a collection of all known schemas
• a list of all known remote Agents
• a cache of QmfConsoleObject proxies

The connection to the AMQP bus is used to communicate with remote Agents. The queue is used as a source for notifications coming from remote Agents.

Asychronous event model.

The original QMF API defined a set of callback methods that a Console application needed to provide in order to process asynchronous QMF events. Each asynchonous event defined its own callback method.

The new API replaces this callback model with a work-queue approach. All asynchronous events are represented by a WorkItem object. When a QMF event occurs it is translated into a WorkItem object and placed in a FIFO queue. It is left to the console application to drain this queue as needed.

This new API does require the console application to provide a single callback. The callback is used to notify the console application that WorkItem object(s) are pending on the work queue. This callback is invoked by QMF when the work queue transitions from the empty to the non-empty state. To avoid any potential threading issues, the console application is not allowed to call any QMF API from within the callback context. The purpose of the callback is to allow the console
application to schedule itself to drain the work queue at the next available opportunity.

For example, a console application may be designed using a select() loop. The application waits in the select() for any of a number of different descriptors to become ready. In this case, the callback could be written to simply make one of the descriptors ready, and then
return. This would cause the application to exit the wait state, and start processing pending events.

The callback is represented by the Notifier virtual base class. This base class contains a single method. A console application derives a custom handler from this class, and makes it available to the Console object.

class Notifier:
    .indication():  Called when the internal work queue becomes
    non-empty due to the arrival of one or more WorkItems. This method
    will be called by the internal QMF management thread - it is
    illegal to invoke any QMF APIs from within this callback.  The
    purpose of this callback is to indicate that the application
    should schedule itself to process the work items.  

The WorkItem class represents a single notification event that is read
from the work queue:

class WorkItem:
    #
    # Enumeration of the types of WorkItems produced by the Console
    #
    AGENT_ADDED = 1
    AGENT_DELETED = 2
    NEW_PACKAGE = 3
    NEW_CLASS = 4
    OBJECT_UPDATE = 5
    EVENT_RECEIVED = 7
    AGENT_HEARTBEAT = 8

    .getType(): Identifies the type of work item by returning one of
    the above type codes. 

    .getHandle(): return the handle for an asynchronous operation, if present.

    .getParams(): Returns the data payload of the work item.  The type
    of this object is determined by the type of the workitem (?TBD?). 

Local representation of a remote Agent.

The console application maintains a list of all known remote Agents. Each Agent is represented by the Agent class:

class Agent:
      <constructor>( AgentId )
      .getName(): returns the AgentId
      ?tbd?

The Console Object.

The Console class is the top-level object used by a console application. All QMF console functionality is made available by this object. A console application must instatiate one of these objects.

As noted below, some Console methods require contacting a remote Agent. For these methods, the caller has the option to either block for a (non-infinite) timeout waiting for a reply, or to allow the method to complete asynchonously. When the asynchronous approach is used, the caller must provide a unique handle that identifies the request. When the method eventually completes, a WorkItem will be placed on the work queue. The WorkItem will contain the handle that was provided to the corresponding method call.

All blocking calls are considered thread safe - it is possible to have a multi-threaded implementation have multiple blocking calls in flight simultaineously.

If a name is supplied, it must be unique across all Consoles attached to the AMQP bus. If no name is supplied, a unique name will be synthesized in the format: "qmfc-<hostname>.<pid>"

<selector_type>:<selector_params>}
}

Where:

The value of the "what" key is a map that specifies the target for the Query. The Agent will return a list of instances of target types that match the query.

<target> is implemented as a map with a single element in the format:

{"<target name string>": <optional map of target qualifiers>}

QMF defines the following values for <target name string>:

The value of the <target name string> map entry is ignored for now, its use is TBD.

The selector_type is optional. If it is not present, then the Query has no filter. The Agent will return every instance of type target it has. If selector_type is present, it may be one of the following supported values:

• "id" - an exact match against the target's unique identifier.
• "where" - a logical expression to apply to the target.
• ...more tbd...

Only one selector_type is allowed in the Query at a time.

"id" Selector

A Query with an id selector is used to find one particular instance of a given target type. The value of the "id" keyword is a type that suitably represents an exact identifier for the target type. The Agent will return the first instance that matches the identifier.

id selectors are only valid for the following subset of targets:

The Agent will return no matches should a Query using an id selector specify a target name not in the above subset.

"Where" Selector

A Query with a where selector describes a logical expression that is used to filter the target set. This logical expression is built from a set of boolean operations that are applied against the target's data. These boolean operations may be combined using logical operations.

The Agent will apply the logical expression against every instance of the target type, and return the set of instances for which the expression evaluates as True.

The value of the "where" keyword is a list representation of a predicate expression. QMF will support the following syntax for predicate expressions:

PREDICATE-EXP: [LOGIC-OP LOGIC-ARG]
LOGIC-ARG: PREDICATE-EXP
LOGIC-ARG: BOOL-EXP LOGIC-ARG
LOGIC-ARG: BOOL-EXP

BOOL-EXP: [BOOL-OP BOOL-ARG]
BOOL-ARG: VARIABLE BOOL-ARG
BOOL-ARG: CONST BOOL-ARG
BOOL-ARG:

CONST: [QUOTE NAME]
CONST: [QUOTE ATOMIC]
CONST: ATOMIC

VARIABLE: [UNQUOTE NAME]
VARIABLE: NAME

ATOMIC: any non-string type
NAME: string

QUOTE: "quote"
UNQUOTE: "unquote"

LOGIC-OP: string
BOOL-OP: string

In the above expressions, the left and right braces indicate lists. For example, BOOL-EXP is a list containing a BOOL-OP followed by BOOL-ARG.

A BOOL-EXP is a boolean test that is applied against the target. BOOL-OP defines the boolean operation that is performed on the arguments. QMF will define a set of string literals representing the supported boolean operations. At minimum, the following boolean operators are defined:

• "eq" - equality
• "ne" - inequality
• "lt" - arithmetical/lexical less-than
• "le" - arithmetical/lexical less-than-or-equal
• "gt" - arithmetical/lexical greater-than
• "ge" - arithmetical/lexical greater-than-or-equal
• "re_match" - string regular expression match (one argument)
• "exists" - True if named value is present in target, else False (one argument)
• "true" - always true (no arguments)
• "false" - always false (no arguments)
• <more tbd>

All operators are binary unless otherwise noted.

LOGIC-OP defines the logical operation that is applied to its arguments. QMF will define a set of string literals representing supported logical operations. At minimum, the following logical operators will be defined:

• "and" - logical AND, all arguments must evaluate to True.
• "or" - logical OR, at least one argument must evaluate to True
• "not" - logical NOT, all arguments must evaluate to False
• <more tbd>

Logic operations are "short-circuiting". That is, evaluation ceases as soon as the truth value of the expression is determined. For example, the evaluation of an "and" expression stops when the first argument that evaluates as False is found.

QMF considers string arguments in boolean expressions to be names of data values in the target object. When evaluating a predicate expression, QMF will fetch the value of the named data item from each candidate target object. The value is then used in the boolean expression. In other words, QMF considers string arguments to be variables in the expression. In order to indicate that a string should be treated as a literal instead, the string must be quoted using the "quote" expression.

For example, the following boolean expression contains the data item named "employee" against the string literal "Joey Jojo":

        ["eq" "employee" ["quote" "Joey Jojo"]]

In implementation, predicate expressions are nested lists. The first element of all lists is the operator keyword string. The remaining list elements are arguments to the operator.

Examples:

Assume a QmfData type defines fields named "name", "address" and "town". The following predicate expression matches any instance with a name field set to "tross", or any instance where the name field is "jross", the address field is "1313 Spudboy Lane" and the town field is "Utopia":

 ["or" ["eq" "name" ["quote" "tross"]]
       ["and" ["eq" "name" ["quote" "jross"]]
              ["eq" "address" ["quote" "1313 Spudboy Lane"]]
              ["eq" ["quote" "Utopia"] "town"]
       ]
]

Assume a QmfData type with fields "name" and "age". A predicate to find all instances with name matching the regular expression "?ross" with an optional age field that is greater than the value 29 or less than 12 would be:

["and" ["re_match" "name" ["quote" "?ross"]]
       ["and" ["exists" "age"]
              ["or" ["gt" "age" 27] ["lt" "age" 12]]
       ]
]

The valid set of <name> values in an predicate expression is determined by the target of the Query. QMF reserves a set of <name> values it recognizes. The tables below list the set of name strings allowed for each type of target, and what these names evaluate to from the target instance.

QMF reserved <name> values all start with the underscore character "_". Do not create value or method names starting with an underscore.

The QmfQuery class represents a query:

class QmfQuery:
      <constructor>(target=<target name>,
                    _target_params=None,
                    _predicate=(optional)<predicate map>,
                    _id=(optional)<target-identifier>)
      <constructor>(map=Map representation of a QmfQuery, as generated by .map_encode())
      .get_target(): return target name
      .get_target_param(): return params.
      .get_selector(): returns QmfQuery.ID or QmfQuery.PREDICATE
      .get_id(): return identifier if selector type is QmfQuery.ID, else None
      .get_predicate(): return predicate expression if selector type is QmfQuery.PREDICATE
      .evaluate(QmfData): evaluate query against a QmfData instance.  Returns True if query matches the instance, else false.
      .map_encode(): returns a map encoding of the QmfQuery instance

The map encoding of a QmfQuery:

Example Queries

With the above syntax, QMF queries can be constructed using AMQP maps and lists. For example, a query for all known schema identifiers:

{"query": {"what": {"schema_id":None}}}

Note that the absence of a "where" clause acts as a "match all"
directive. This query will return a list of all known SchemaId's.

A query for all schema identifiers whose package names are equal to the string "myPackage":

{"query": {"where": ["eq" "_package_name" ["quote" "myPackage"]],
           "what": {"schema_id": None}
          }
}

Query for the particular QmfData data object with the identifier "Agent007":

{"query": {"what": {"object":None},
           "id": "Agent007"}
}

Query for the particular SchemaObjectClass instance that has the package name "MyPackage", class name "MyClass", that has a hash string of 'b49cda2d-bbe53b97-9f6ee5d1-485ea3da':

{"query": {"what": {"schema":None},
           "id": {"_package_name": "MyPackage",
                  "_class_name": "MyClass",
                  "_type": "_data",
                  "_hash_str": "b49cda2d-bbe53b97-9f6ee5d1-485ea3da"}}
}

Query for all SchemaClass objects that match a given package and class
name:

{"query": {"what": {"schema": None}
           "where": ["and" ["eq" "_package_name" ["quote" "myPackage"]]
                           ["eq" "_class_name" ["quote" "someClass"]]]
          }
}

Query all managed objects belonging to the "myPackage" package, of the class "myClass", whose object_id matches a given regular expression. Return a list of matching object identifiers:

{"query": {"what": {"object_id": None},
           "where": ["and" ["eq" "_package_name" ["quote" "myPackage]]
                           ["eq" ["quote" "myClass"] "_class_name"]
                           ["re_match" "_primary_key" ["quote" "foo*"]]
                    ]
          }
}

Query for all QmfData objects from a particular schema, whose "temperature" property is greater or equal to 50:

{"query": {"what": {"object": None},
           "where": ["and" ["eq" "_package_name" ["quote" "aPackage]]
                           ["eq" ["quote" "someClass"] "_class_name"]
                           ["ge" "temperature" 50]
                    ]
          }
}

In the previous example, the agent will convert the value 50 to a type compatible with the type given by the "temperature" property's schema in order to do the comparison.

Query for all objects that match the given schema, which have a property named "state" which does not match the regular expression "$Error*", or whose "owner" property is not set to "Cartman".

{"query": {"what": {"object": None},
           "where": ["and" ["eq" "_package_name" ["quote" "aPackage]]
                           ["eq" ["quote" "someClass"] "_class_name"]
                           ["or" ["not" ["re_match" "state" ["quote" "$Error"]]]
                                 ["ne" "owner" ["quote" "Cartman"]]
                           ]
                    ]
          }
}

Subscriptions

A subscription allows a Console application to monitor specific management data for changes in state. A Console creates a subscription with an Agent based on a Query. The Query specifies the set of management data that is to be monitored. The Agent will periodically publish updates to the subscribing Console(s).  The update contains a snapshot of the of the monitored data. 

A subscription remains in effect for a predetermined amount of time.  Once the subscription expires, no further updates are published.  A console may elect to refresh a subscription prior to its expiration.   Alternatively, a Console may explicitly cancel the subscription when the data no longer needs to be monitored.

Invoking Methods

QMF allows a Console application to perform a "remote procedure call" on the Agent. The procedure - or method - call executes on the Agent. On completion a result is passed back to the Console. Method calls can be associated with an instance of a data object, or applied to the Agent as a whole.

The structure of a method call may be described by the schema associated with the object. The schema can define a name for the method and a description of its input and output parameters. The SchemaMethod class is used for this purpose.

The value(s) returned to the Console when the method call completes are represented by the MethodResult class. The MethodResult class indicates whether the method call succeeded or not, and, on success, provides access to all data returned by the method call. Returned data is provided in a map indexed by the name of the parameter. The map contains only those parameters that are classified as "output" by the SchemaMethod.

Should a method call result in a failure, this failure is indicated by the presence of an error object in the MethodResult. This object is represented by a QmfData object. The structure of this QmfData object is application-defined, but should contain a description of the reason for the failure. There are no returned parameters when a method call fails.

A successful method invokation is indicated by the absence of the QmfData error object in the MethodResult.

class MethodResult:
      <constructor>( QmfData <exception> | <map of properties> )
      .succeeded(): returns True if the method call executed without error.
      .get_exception(): returns the QmfData error object if method fails, else None
      .get_arguments(): returns a map of "name"=<value> pairs of all returned arguments.
      .get_argument(<name>): returns value of argument named "name".

Management Events

An event is a notification that is sent by an Agent to alert Console(s) of a change in some aspect of the system under management. Agents publish events asynchronously. Consoles have the option of receiving events from a given Agent.

To publish an event, the Agent application must call the raise_event() method, passing an instance of a QmfEvent object. The Agent publishes the QmfEvent instance.

To receive events, the Console application must enable event reception on a per-agent basis. The Console application does this by calling the enable_events() method on the desired Agent instance. Published events from the Agent will then appear on the Console's work-queue. The Console application may disable events by invoking the Agent's disable_events() method.

Work-Queue Event Model.

The original QMF API defined a set of callback methods that a Console or Agent application needed to provide in order to process asynchronous QMF events. Each asynchonous event defined its own callback method.

The new API replaces this callback model with a work-queue approach. All asynchronous events are represented by a WorkItem object. When a QMF event occurs it is translated into a WorkItem object and placed in a FIFO queue. It is left to the application to drain this queue as needed.

This new API does require the application to provide a single callback. The callback is used to notify the application that WorkItem object(s) are pending on the work queue. This callback is invoked by QMF when one or more new WorkItem objects are added to the queue. To avoid any potential threading issues, the application is not allowed to call any QMF API from within the context of the callback. The purpose of the callback is to notify the application to schedule itself to drain the work queue at the next available opportunity.

For example, a console application may be designed using a select() loop. The application waits in the select() for any of a number of different descriptors to become ready. In this case, the callback could be written to simply make one of the descriptors ready, and then return. This would cause the application to exit the wait state, and start processing pending events.

The callback is represented by the Notifier virtual base class. This base class contains a single method. An application derives a custom notification handler from this class, and makes it available to the Console or Agent object.

class Notifier:
    .indication():  Called when the internal work queue becomes non-empty due to the arrival of one or more WorkItems.
        This method will be called by the internal QMF management thread - it is illegal to invoke any QMF APIs from
        within this callback.  The purpose of this callback is to indicate that the application should schedule itself
        to process the work items.

The WorkItem class represents a single notification event that is read from the work queue:

class WorkItem:
    .get_type(): Identifies the type of work item.
    .get_handle(): returns the reply handle for an asynchronous operation, if present.
    .get_params(): Returns the payload of the work item.  The type of this object is determined by the type of the workitem.

Console and Agent-specific WorkItem types are defined.

Console Application Model

This section describes the API that is specific to Console components.

A QMF console component is represented by a Console class. This class is the topmost object of the console application's object model.

A Console is composed of the following objects:

• a connection to the AMQP bus
• a queue of inbound work items
• a collection of all known schemas
• a list of all known remote Agents
• a cache of known data object proxies

The connection to the AMQP bus is used to communicate with remote Agents. The queue is used as a source for notifications coming from remote Agents.

QmfConsoleData Class

The QmfData class is subclassed to provide a Console specific representation of management data.

The Console application represents a managed data object by the QmfConsoleData class. The Console has "read only" access to the data values in the data object via this class. The Console can also invoke the methods defined by the object via this class. The actual data stored in this object is cached from the Agent. In order to update the cached values, the Console invokes the instance's refresh() method.

Note that the refresh() and invoke_method() methods require communication with the remote Agent. As such, they may block. For these two methods, the Console has the option of blocking in the call until the call completes. Optionally, the Console can receive a notification asynchronously when the operation is complete. See below for more detail regarding synchronous and asynchronous API calls.

class QmfConsoleData(QmfData):
      .get_timestamps(): returns a list of timestamps describing the
                        lifecycle of the object.  All timestamps are
                        represented by the AMQP timestamp type.
                        [0] = time of last update from Agent,
                        [1] = creation timestamp
                        [2] = deletion timestamp, or zero if not deleted.
      .get_create_time(): returns the creation timestamp
      .get_update_time(): returns the update timestamp
      .get_delete_time(): returns the deletion timestamp, or zero if not yet deleted.
      .is_deleted(): True if deletion timestamp not zero.

      .refresh([reply-handle | timeout]): request that the Agent update the value of this object's contents.
      .invoke_method(name, inArgs{}, [[reply-handle] | [timeout]]): invoke the named method on this instance.

Asychronous Event Model.

The Console application must support the following WorkItem types:

• AGENT_ADDED
• AGENT_DELETED
• NEW_PACKAGE
• NEW_CLASS
• OBJECT_UPDATE
• EVENT_RECEIVED
• AGENT_HEARTBEAT
• SUBSCRIBE_RESPONSE
• RESUBSCRIBE_RESPONSE
• SUBSCRIPTION_INDICATION

These WorkItem types are described in detail below:

AGENT_ADDED

When the QMF Console receives the first heartbeat from an Agent, an AGENT_ADDED WorkItem is pushed onto the work-queue. The WorkItem's get_param() call returns a map which contains a reference to the new Console Agent instance. The reference is indexed from the map using the key string "agent". There is no handle associated with this WorkItem.

Note: If a new Agent is discovered as a result of the Console find_agent() method, then no AGENT_ADDED WorkItem is generated for that Agent.

AGENT_DELETED

When a known Agent stops sending heartbeat messages, the Console will time out that Agent. On Agent timeout, an AGENT_DELETED WorkItem is pushed onto the work-queue. The WorkItem's get_param() call returns a map which contains a reference to the Agent instance that has been deleted. The reference is indexed from the map using the key string "agent". There is no handle associated with this WorkItem.

The Console application must release all saved references to the Agent before returning the WorkItem.

NEW_PACKAGE

TBD.

NEW_CLASS

TBD.

OBJECT_UPDATE

TBD.

EVENT_RECEIVED

TBD

SUBSCRIBE_RESPONSE

The SUBSCRIBE_RESPONSE WorkItem returns the result of a subscription request made by this Console.  This WorkItem is generated when the Console's create_subscription() is called in an asychronous manner, rather than pending for the result. 

The get_params() method of a SUBSCRIBE_RESPONSE  WorkItem will return an instance of the following object:

class SubscribeParams:
      .get_subscription_id(): If the subscription is successful, this method returns a SubscriptionId object.
          Should the subscription fail, this method returns None, and get_error() can be used to obtain an
          application-specific QmfData error object.
      .get_publish_interval(): returns the time interval in seconds on which the Agent will publish updates
          for this subscription.
      .get_lifetime(): returns the time interval in seconds for the subscription. The subscription will automatically
          expire after this interval if not renewed by the console.
      .get_error(): (optional) returns an application-specific QmfData object indicating why the subscription
          request failed.  Returns None if not supported.
      .get_console_handle(): returns the console handle as passed to the create_subscription() call.

The SubscriptionId object must be used when the subscription is refreshed or cancelled - it must be passed to the Console's refresh_subscription() and cancel_subscription() methods.  The value of the SubscriptionId does not change over the lifetime of the subscription.

The console handle will be provided by the Agent on each data indication event that corresponds to this subscription.  It should not change for the lifetime of the subscription.

The get_handle() method returns the reply handle provided to the create_subscription() method call.  This handle is merely the handle used for the asynchronous response, it is not associated with the subscription in any other way.

Once a subscription is created, the Agent that maintains the subscription will periodically issue updates for the subscribed data.  This update will contain the current values of the subscribed data, and will appear as the first SUBSCRIPTION_INDICATION WorkItem for this subscription.

SUBSCRIPTION_INDICATION

The SUBSCRIPTION_INDICATION WorkItem signals the arrival of an update to subscribed data from the Agent. 

The get_params() method of a SUBSCRIPTION_INDICATION  WorkItem will return an instance of the following object:

class SubscribeIndication:
      .get_console_handle(): returns the console handle as passed to the create_subscription() call.
      .get_data(): returns a list containing all updated data objects associated with the subscripion.

The get_handle() method returns None.

RESUBSCRIBE_RESPONSE

The RESUBSCRIBE_RESPONSE WorkItem is generated in response to a subscription refresh request made by this Console.  This WorkItem is generated when the Console's refresh_subscription() is called in an asychronous manner, rather than pending for the result. 

The get_params() method of a RESUBSCRIBE_RESPONSE  WorkItem will return an instance of the following object:

class SubscribeParams:
      .get_subscription_id(): If the re-subscription is successful, this method returns an instance of
          the original SubscriptionId object.  Should the subscription fail, this method returns None,
          and get_error() can be used to obtain an application-specific QmfData error object.
      .get_publish_interval(): returns the time interval in seconds on which the Agent will publish updates
          for this subscription.
      .get_lifetime(): returns the time interval in seconds for the subscription. The subscription will automatically
          expire after this interval if not renewed by the console.
      .get_error(): (optional) returns an application-specific QmfData object indicating why the re-subscription
          request failed.  Returns None on successful resubscribe.
      .get_console_handle(): returns the console handle as passed to the create_subscription() call, if available.
          Note: if the Agent failed the resubscribe request due to an unrecognized subscription, this call may
          return None.

The get_handle() method returns the reply handle provided to the refresh_subscription() method call.  This handle is merely the handle used for the asynchronous response, it is not associated with the subscription in any other way.

Local representation of a remote Agent.

The console application maintains a list of all known remote Agents. Each Agent is represented by the Agent class:

class Agent:
      .get_name(): returns the identifying name string of the agent.  This name is used to send AMQP messages directly to this agent.
      .is_active(): returns True if the agent is alive (heartbeats have not timed out)
      .invoke_method(name, inArgs{}, [[reply-handle] | [timeout]]): invoke the named method against the agent.
      .enable_events(): allows reception of events from this agent.
      .disable_events(): prevents reception of events from this agent.
      .destroy(): releases this Agent instance.  Once called, the console application should not reference this instance again.
      ?tbd?

The Console Object.

The Console class is the top-level object used by a console application. All QMF console functionality is made available by this object. A console application must instatiate one of these objects.

As noted below, some Console methods require contacting a remote Agent. For these methods, the caller has the option to either block for a (non-infinite) timeout waiting for a reply, or to allow the method to complete asynchonously. When the asynchronous approach is used, the caller must provide a unique handle that identifies the request. When the method eventually completes, a WorkItem will be placed on the work queue. The WorkItem will contain the handle that was provided to the corresponding method call.

All blocking calls are considered thread safe - it is possible to have a multi-threaded implementation have multiple blocking calls in flight simultaineously.

If a name is supplied, it must be unique across all Consoles attached to the AMQP bus under the given domain. If no name is supplied, a unique name will be synthesized in the format: "qmfc-<hostname>.<pid>"

class Console:
      <constructor>(name=<name-str>,
                    domain=(optional) domain string for console's AMQP address,
                    notifier=<class Notifier>,
                    reply_timeout=<default for all blocking calls>,
                    agent_timeout=<default timeout for agent heartbeat>,
                    subscription_duration=<default lifetime of a subscription>)

      .destroy(timeout=None): Must be called to release Console's resources.

      .add_connection(QPID Connection): Connect the console to the AMQP cloud.

      .remove_connection(conn): Remove the AMQP connection from the console.  Un-does the add_connection() operation, and
          releases any agents associated with the connection.  All blocking methods are unblocked and given a failure status.
          All outstanding asynchronous operations are cancelled without producing WorkItems.

      .get_address():
          Get the AMQP address this Console is listening to (type str).

      .find_agent( name string, [timeout] ): Query for the presence of a specific agent in the QMF domain. Returns a
          class Agent if the agent is present.  If the agent is not already known to the console, this call will send
          a query for the agent and block (with default timeout override) waiting for a response.

      .enable_agent_discovery( [Query] ): Called to enable the asynchronous Agent Discovery process. Once enabled, AGENT_ADDED
          and AGENT_DELETED work items can arrive on the WorkQueue.  If a query is supplied, it will be used to filter agent
          notifications.

      .disable_agent_discovery(): Called to disable the async Agent Discovery process enabled by calling enable_agent_discovery().

      .get_workitem_count(): Returns the count of pending WorkItems that can be retrieved.

      .get_next_workitem([timeout=0]): Obtains the next pending work item, or None if none available.

      .release_workitem(wi): Releases a WorkItem instance obtained by getNextWorkItem(). Called when the application has finished
          processing the WorkItem.

      .get_agents(): Returns a list of available agents (class Agent)

      .get_agent( name string ): Return the class Agent for the named agent, if known.

      .get_packages( [class Agent] ): Returns a list of the names of all known packages.  If an optional Agent is provided, then
          only those packages available from that Agent are returned.

      .get_classes( [class Agent] ):  Returns a list of SchemaClassIds for all available Schema.  If an optional Agent is provided,
          then the returned SchemaClassIds are limited to those Schema known to the given Agent.

      .get_schema( class SchemaClassId [, class Agent]): Return a list of all available class SchemaClass across all known agents.
          If an optional Agent is provided, restrict the returned schema to those supported by that Agent.

      .get_objects( _SchemaClassId= | _package=, _class= |
                    _object_identifier=,
                   [timeout=],
                   [list-of-class-Agent] ): perform a blocking query for QmfConsoleObjects.  Returns a list (possibly empty) of matching
           objects. The selector for the query may be either:
           * class SchemaClassId - all objects whose schema match the schema identified by _SchemaClassId parameter.
           * package/class name - all objects whose schema are contained by the named package and class.
           * the object identified by _object_identifier
           This method will block until all known agents reply, or the timeout expires. Once the timeout expires, all
           data retrieved to date is returned. If a list of agents is supplied, then the query is sent to only those agents.

      .create_subscription( agent, class Query, console_handle [, reply_handle] [, timeout],
                            [, publish_interval] [, lifetime] ):  creates a subscription to the agent
          using the given Query.  The console_handle is an application-provided handle that will accompany each subscription update
          send from the Agent.  Subscription updates will appear as SUBSCRIPTION_INDICATION WorkItems on the Console's work queue.
          The publish_interval is the requested time interval in seconds on which the Agent should publish updates.  The lifetime
          parameter is the requested time interval in seconds for which this subscription should remain in effect.  Both

class Console:
      <constructor>(name=<name-str>, 
                    notifier=<class Notifier>,
                    timeout=<default for all blocking calls>,
                    subscription_duration=<default lifetime of a subscription>)

      .destroy(timeout=None): Must be called to release Console's resources.

      .addConnection(QPID Connection): Connect the console to the AMQP cloud.

      .removeConnection(conn): Remove the AMQP connection from the
          console.  Un-does the addConnection() operation, and
          releases any agents associated with the connection.  All
          blocking methods are unblocked and given a failure status.
          All outstanding asynchronous operations are cancelled
          without producing WorkItems.

      .getAddress():
          Get the AMQP address this Console is listening to (type str).

      .findAgent( class AgentId, [timeout | handle] ): Query for the
      presence of a specific agent. Returns a class Agent if the agent
      is present.  May be called blocking (with default timeout
      override), or may allow asynchronous completion (producing a
      WorkItem with the given handle).

      .enableAgentDiscovery(): Called to enable the asynchronous
          Agent Discovery process. Once enabled, AGENT_ADD work items
          can arrive on the WorkQueue.

      .disableAgentDiscovery(): Called to disable the async Agent
      Discovery process enabled by calling enableAgentDiscovery().  

      .getWorkItemCount(): Returns the count of pending WorkItems that
      can be retrieved. 

      .getNextWorkItem([timeout=0]): Obtains the next pending work
      item, or None if none available. 

      .releaseWorkItem(wi): Releases a WorkItem instance obtained by
      getNextWorkItem(). Called when the application has finished
      processing the WorkItem. 

      .getAgents(): Returns a list of available agents (class Agent)

      .getAgent( class AgentId ): Return the class Agent for the
          named agent, if known. 

      .getPackages( [class Agent] ): Returns a list of the names of
          all known packages.  If an optional Agent is provided, then
          only those packages available from that Agent are returned.

      .getClasses( [class Agent] ):  Returns a list of SchemaClassIds
          for all available Schema.  If an optional Agent is provided,
          then the returned SchemaClassIds are limited to those
          Schema known to the given Agent.

      .getSchema( class SchemaClassId [, class Agent]): Return a list
          of all available class SchemaClass across all known agents.
          If an optional Agent is provided, restrict the returned
          schema to those supported by that Agent.

      .makeObject( SchemaClassId, **kwargs ): returns an uninitialized
      instance of a QmfDescribed data object.

      .getObjects( _SchemaClassId= | _package=, _class= |
                    _objectId=,
                   [timeout=],
                   [list-of-class-Agent] ): perform a blocking query
           for QmfConsoleObjects.  Returns a list (possibly empty) of matching
           objects. The selector for the query may be either:
           * class SchemaClassId - all objects whose schema match the
          requested lifetime         schema identified by _SchemaClassId parameter.
      and publish_interval may be overridden by the Agent, as indicated in the subscription response.
     * package/class name - all objectsThis whosemethod schemamay are
be called asynchronously by providing a reply_handle argument.  When called asynchronously, the result
       contained by the namedof packagethis andmethod class.
call is returned in a SUBSCRIBE_RESPONSE WorkItem with a handle  *matching the objectvalue identifiedof by reply_objectIdhandle.
          Timeout Thiscan methodbe willused blockto untiloverride allthe knownconsole's agentsdefault reply, timeout. or the
When called synchronously, this method returns a class
          SubscribeParams object containing timeoutthe expires.result Onceof the timeout expires, all
subscription request.

      .refresh_subscription( SubscriptionId [, lifetime] [,reply_handle] [, timeout] ): renews a subscription identified by
   data retrieved to date is returned.  
SubscriptionId.  The Console may request a new subscription duration by Ifproviding a listrequested oflifetime. agentsThis
 is supplied, then the query is sent to
  method may be called asynchronously by providing a reply_handle argument. When called asynchronously, the result
    only those agents.  


  of this method call .createSubscription(is classreturned Queryin [, duration=<secs> [, list of agents] ): creates a
    a SUBSCRIBE_RESPONSE WorkItem.  Timeout can be used to override the console's
        subscription using thedefault givenreply Querytimeout.  IfWhen acalled listsynchronously, ofthis agents
method returns a class SubscribeParams object containing
      is provided, the Query willthe applyresult onlyof tothe thosesubscription agentsrequest.

      .cancel_subscription( SubscriptionId ): terminates the  Otherwise it will apply to all active agents, including
            those discovered during the lifetime of the subscription.
            The duration argument can be used to override the
            console's default subscription lifetime for thisgiven subscription.

Example Console Application

The following pseudo-code performs a blocking query for a particular agent.

logging.info( "Starting Connection" )
conn = Connection("localhost")
conn.connect()

logging.info( "Starting Console" )
myConsole = Console()
myConsole.add_connection( conn )

logging.info( "Finding Agent" )
myAgent = myConsole.find_agent( "com.aCompany.Examples.anAgent", _timeout=5 )

if myAgent:
   logging.info( "Agent Found: %s" % myAgent )
else:
   logging.info( "No Agent Found!")

logging.info( "Removing connection" )
myConsole.remove_connection( conn )

logging.info( "Destroying console:" )
myConsole.destroy( _timeout=10 )

The following pseudo-code performs a non-blocking query for all
agents. It completes when at least one agent is found.

class MyNotifier(Notifier):
    def __init__(self, context):
        self._myContext = context
            subscriptionself.WorkAvailable  Returns a class SubscriptionId.= False

    def  .refreshSubscription( SubscriptionId [, duration=<secs>] indication(self):
      (re)activates a subscription.  Uses the console default durationprint("Indication received! context=%d" % self._myContext)
      unless the durationself.WorkAvailable is explicitly specified.= True

noteMe = MyNotifier(    .cancelSubscription( SubscriptionId ): terminates the
      subscription. 

Example Console Application

The following pseudo-code performs a blocking query for a particular agent.

logging.info( "Starting Connection" )
conn = Connection("localhost")
conn.connect()

logging.info( "Starting Console" )
myConsole = Console()
myConsole.addConnection( conn )

logging.info( "Finding Agent" )
myAgent = myConsole.findAgent( AgentId( "aCompany.com", "Examples", "anAgent" ), _timeout=5 )

if myAgent:
   logging.info( "Agent Found: %s" % myAgent )
else:
   logging.info( "No Agent Found!")

logging.info( "Removing connection" )
myConsole.removeConnection( conn )

logging.info( "Destroying console:" )
myConsole.destroy( _timeout=10 )

The following pseudo-code performs a non-blocking query for all agents. It completes when at least one agent is found.

class MyNotifier(Notifier):
    def __init__(self, context):
        self._myContext = context
        self.WorkAvailable = False

    def indication(self):
        print("Indication received! context=%d" % self._myContext)
        self.WorkAvailable = True

noteMe = MyNotifier( 668 )

logging.info( "Starting Connection" )
conn = Connection("localhost")
conn.connect()

myConsole = Console(notifier=noteMe)
myConsole.addConnection( conn )

myConsole.enableAgentDiscovery()
logging.info("Waiting...")


while not noteMe.WorkAvailable:
    print("No work yet...sleeping!")
    time.sleep(1)


print("Work available = %d items!" % myConsole.getWorkItemCount())
wi = myConsole.getNextWorkitem(timeout=0)
while wi:
    print("work item %d:%s" % (wi.getType(), str(wi.getParams())))
    wi = myConsole.getNextWorkitem(timeout=0)


logging.info( "Removing connection" )
myConsole.remove_connection( conn )

logging.info( "Destroying console:" )
myConsole.destroy( 10 )

Agent Application Model

A QMF agent component is represented by a instance of the Agent class. This class is the topmost object of the agent application's object model. Associated with a particular agent are

• the set of objects managed by that agent
• a collection of consoles that are interfacing with the agent

The Agent class communicates with the application using the same notification-based model as the console. The agent maintains a work-queue of pending requests. Each pending request is
associated with a handle. When the application is done servicing the work request, it passes the response to the agent along with the handle associated with the originating request.

An agent can support one of two different models for managing its object database: internal or external store.

Internal Object Store

An agent that implements internal object store takes full responsibility for managing its associated objects. In this model, the application passes a reference for each managed objects to the agent. The agent manages the set of objects internally, directly accessing the contents of the object in order to service console requests.

With this model, the application's complexity is reduced. The application needs to instantiate the object and register it with the agent. The application also maintains a reference to the object, as the application is responsible for updating the object's properties and the statistics as necessary.

The application must also service method calls invoked on the object. The agent notifies the application when a method call has been requested by a console. The application services the method call, passing the result of the method back to the agent. The agent then relays the response to the originating console.

The application may decide to delete an object instance. The application does this by invoking the destroy() method on the object. This notifies the agent, which will mark the object as deleted in its database. Once the application invokes the destroy() method on an object, it must no longer access the object. The agent will clean up the object at a later point in time.

Internal object store is the default model for agent object managment.

Data Consistency

The internal object store requires sharing of the managed data between the agent and the application. The application is responsible for keeping the data up to date, while the agent is responsible for providing the data to client consoles. It is likely that these components may be implemented in separate execution contexts. This raises the possibility that a data item could be in the process of being written to by the application at the same moment the agent attempts to read it. This would result in invalid data being read.

To prevent this from occuring, the QmfAgentObject class provides accessors for all property and statistic data in the object. These accessors provide atomic access to the underlying data. Therefore, both the agent and the application code must use these accessors to manipulate a shared object's data.

External Object Store

An alternate agent implementation allows the application to take full responsibility for managing the objects. With this model, all instances of managed objects exist external to the agent. When a console requests an action against an object, that action is transferred from the agent to the application. The application then must process the request, and send the result to the agent. The agent then sends a reply to the requesting console.

The model gives full control of the managed objects to the application, but usually requires more application development work.

Agent Class

The base class for the agent object is the Agent class. This base class represents a single agent implementing internal store.

668 )

logging.info( "Starting Connection" )
conn = Connection("localhost")
conn.connect()

myConsole = Console(notifier=noteMe)
myConsole.add_connection( conn )

myConsole.enable_agent_discovery()
logging.info("Waiting...")


while not noteMe.WorkAvailable:
    print("No work yet...sleeping!")
    time.sleep(1)


print("Work available = %d items!" % myConsole.getWorkItemCount())
wi = myConsole.get_next_workitem(timeout=0)
while wi:
    print("work item %d:%s" % (wi.getType(), str(wi.getParams())))
    wi = myConsole.get_next_workitem(timeout=0)


logging.info( "Removing connection" )
myConsole.remove_connection( conn )

logging.info( "Destroying console:" )
myConsole.destroy( 10 )

Agent Application Model

This section describes the API that is specific to Agent components.

A QMF agent component is represented by a instance of the Agent class. This class is the topmost object of the agent application's object model. Associated with a particular agent are:

• the set of objects managed by that agent
• the set of schema that describes the structured objects owned by the agent
• a collection of consoles that are interfacing with the agent

The Agent class communicates with the application using the same work-queue model as the console. The agent maintains a work-queue of pending requests. Each pending request is associated with a handle. When the application is done servicing the work request, it passes the response to the agent along with the handle associated with the originating request.

QmfAgentData Class

The Agent manages the data it represents by the QmfAgentData class - a derivative of the QmfData class. The Agent is responsible for managing the values of the properties within the object, as well as servicing the object's method calls. Unlike the Console, the Agent has full control of the state of the object.

class QmfAgentData(QmfData):
      .destroy(): mark the object as deleted by setting the deletion timestamp to the current time.
      .set_value(name, value): update the value of the property.
      .inc_value(name, delta): add the delta to the property
      .dec_value(name, delta): subtract the delta from the property
      ?tbd?

An agent can support one of two different models for managing its database of QmfAgentData objects: internal or external store.

Internal Object Store

An agent that implements internal object store gives full responsibility for managing its data objects to the QMF infrastructure. In this model, the application passes a reference for each managed object to the QMF agent. The agent manages the set of objects internally, directly accessing the contents of the object in order to service console requests.

With this model, the application's complexity is reduced. The application needs to instantiate the object and register it with the agent. The application also maintains a reference to the object, as the application is responsible for updating the object's properties as necessary.

However, the application must still service method calls. The agent notifies the application when a method call has been requested by a console. The application services the method call, passing the result of the method back to the agent. The agent then relays the response to the originating console.

The application may decide to delete an object instance. The application does this by invoking the destroy() method on the object. This notifies the agent, which will mark the object as deleted in its database. Once the application invokes the destroy() method on an object, it must no longer access the object. The agent will clean up the object at a later point in time.

Internal object store is the default model for agent object managment.

Data Consistency

The internal object store requires sharing of the managed data between the agent and the application. The application is responsible for keeping the data up to date, while the agent is responsible for providing the data to client consoles. It is likely that these components may be implemented in separate execution contexts. This raises the possibility that a data item could be in the process of being written to by the application at the same moment the agent attempts to read it. This could result in invalid data being read.

To prevent this from occuring, the QmfAgentObject class provides accessors for all data in the object. These accessors provide atomic access to the underlying data. Therefore, both the agent and the application code must use these accessors to manipulate a shared object's data.

External Object Store

An alternate agent implementation allows the application to take full responsibility for managing the objects. With this model, all instances of managed objects exist external to the agent. When a console requests an action against an object, that action is transferred from the agent to the application. The application then must process the request, and send the result to the agent. The agent then sends a reply to the requesting console.

The model gives full control of the managed objects to the application, but usually requires more application development work.

Agent Class

The base class for the agent object is the Agent class. This base
class represents a single agent implementing internal store.

class Agent:
      <constructor>( name=<name-string>,
                     domain=(optional) domain string for agent's AMQP address,
                     notifier=class Notifier,
                     heartbeat_interval=30,
                     max_msg_size=0)
      .get_name(): return the name string of the agent.
      .set_connection( QPID Connection ): connect the agent to the AMQP cloud.
      .register_object_class( class SchemaObjectClass ): Register a schema for an object class with the agent.  The agent must
            have a registered schema for an object class before it can handle objects of that class.
      .register_event_class( class SchemaEventClass ) : Register a schema for an event class with the agent.  The agent must
            have a registered schema for an event class before it can handle events of that class.
      .raise_event( class QmfEvent ): Cause the agent to raise the given event.
      .add_object( class QmfAgentData ): passes a reference to an instance of a managed QMF object to the agent. The object's
          name must uniquely identify this object among all objects known to this agent.
      .get_workitem_count(): Returns the count of pending WorkItems that can be retrieved.
      .get_next_workitem([timeout=0]): Obtains the next pending work item, or None if none available.
      .release_workitem(wi): Releases a WorkItem instance obtained by get_next_workitem(). Called when the application has finished

class Agent:
      <constructor>( vendor=<vendor-string>,
                     product=<product-string>,
             processing the WorkItem.
      .method_response(name=<name-string>"method name",
                     class Notifier ): the vendor/product/namehandle=<handle from WorkItem>,
            combination must uniquely identify this agent instance
     out_args={output       within the QMF domain.  The Notifier is used to alert the
 argument map}
           application to incoming method requests.
      .setConnection( QPID Connectionerror=<QmfData> ): Indicate connectto the agent tothat the AMQPapplication cloud.
has completed processing a method
  .registerObjectClass( class SchemaObjectClass ): Register a
            schema for an object classrequest. withSee the agent.description of Thethe METHOD_CALL WorkItem.

AgentExternal Class

The AgentExternal class must be used by those applications that implement the external store model. The AgentExternal class extends the Agent class by adding interfaces that notify the application when it needs to service a request for management operations from the agent.

class AgentExternal(Agent):agent must
            have a registered schema for an object class before it can
            handle objects of that class.<constructor>(name=<name-string>,
      .registerEventClass( class SchemaEventClass ) : Register a
        domain=(optional) domain string  schema for an event class with the agent.  The agent must
agent's AMQP address,
              have a registered schema for an eventnotifier= class before it canNotifier,
            handle events of that class.
    heartbeat_interval=30,
  .raiseEvent( class QmfEvent ): Cause the agent to raise the
            given event.max_msg_size=65535)
      .addObjectalloc_object_id( class QmfManaged, object_name=<object"object name str> "):
 indicate to QMF that the named object is    passes a reference available to anbe instancemanaged. of aOnce managedthis QMFmethod objectreturns,
            to the agent. Thewill objectservice namerequests mustfrom uniquelyconsoles identifyreferencing this data.
            object among all objects known to this agent.  Returns a
       .free_object_id( name="object name" ): indicate to QMF that the named object is no longer available to be managed.
     class ObjectId containing the object identifier. .query_response( handle=<handle from WorkItem>,
      .getWorkItemCount(): Returns the count of pending WorkItems that
         class QmfAgentObject): send cana bemanaged retrieved.
object in reply to a received .getNextWorkItem([timeout=0]): Obtainsquery. Note that ownership of the nextobject
  pending work
       instance is returned to the item,caller oron Nonereturn iffrom nonethis availablecall. 
      .releaseWorkItem(wi): Releases a WorkItem instance obtained byquery_complete( handle=<handle from WorkItem>,
            getNextWorkItem(). Called when the application has finished
    result=<status code> ):  Indicate to the agent processingthat the WorkItem.application 
      .methodResponse( handle=<handle from WorkItem>,has completed processing a query request.
          Zero or more calls to the queryResponse() method should be invoked before  [output argument list],
   calling query_complete().  If the query should
          fail - for example, due to authentication error - the result=<status code>,
should be set to a non-zero error code ?TBD?.

      .subscription_response( handle=<handle from WorkItem>,
      exception=<QmfData> ): Indicate to the agent
            that the application has completed processing a method
        console_handle=<handle provided by Console for this subscription>,
    request. A result code of zero indicates success.  If the
            result code is non-zero, exception may optionally be set to a
subscription_handle=<agent-provided context>,
                     QmfData object that describes the failure.  On successlifetime=<seconds>, zero orpublish_interval=<seconds>,
            more output arguments may be supplied as defined by the method's
       error=<QmfData>): Indicate the result of schema. 

AgentExternal Class

The AgentExternal class must be used by those applications that implement the external store model. The AgentExternal class extends the Agent class by adding interfaces that notify the application when it needs to service a request for management operations from the agent.

class AgentExternal(Agent):a SUBSCRIBE_REQUEST WorkItem.
      <constructor>(vendor, product, name, class Notifier)
      .allocObjectId( name="object name"): create a class ObjectId    If the subscription request is successful, the Agent application must provide a unique subscription_handle.  If replying
          to  usinga sucessful subscription refresh, the object name provided original subscription_handle must be supplied.  The objectlifetime nameparameter mustshould be
          set to the duration of  unique across all objects knownthe subscription in seconds.  The publish_interval should be set to thisthe agent.time interval Returnsin aseconds
          between successive publications on classthis ObjectIdsubscription.  If the Oncesubscription thisor methodrefresh returnsfails, the agent willsubscription_handle
          should be serviceset requeststo fromNone consolesand referencingerror thismay ObjectId.
be set to an application-specific QmfData .freeObjectId(instance classthat ObjectIddescribes ):the releaseserror. the ObjectIdShould
          a refresh  previously allocated by allocObjectId() method.  Oncerequest fail, the console_handle may be set to None if unknown.

      .subscription_indicate(console_handle, [list of subscribed data]):  this call is complete,Send a list of updated subscribed data to the agentConsole.

 will reject all further
  .subscription_cancel(handle=<handle from WorkItem>, console_handle): Acknowledge a Subscription    requests from consoles referencing this ObjectId.
      .queryResponse( handle=<handle from WorkItem>,
                      class QmfAgentObject,
                      prop=<True | False>,
                      stat=<True | False>): send a managed object in
            reply to a received query.  If (prop), send object's
Cancel WorkItem.

Asychronous Event Model.

The Agent uses the same notification driven work-queue model as the Console. In the Agent case, the following set of WorkItem types are supported:

• METHOD_CALL
• QUERY
• SUBSCRIBE_REQUEST
• RESUBSCRIBE_REQUEST
• UNSUBSCRIBE_REQUEST

Note Well: In the case of an internal store agent implementation, only the METHOD_CALL work item is generated. An external store agent must support all work item types.

METHOD_CALL

The METHOD_CALL WorkItem describes a method call that must be serviced by the application on behalf of this agent.

The get_params() method of a METHOD_CALL WorkItem will return an instance of the following object:

class MethodCallParams:
      .get_name(): returns a string containing the name of the method call.
      .get_object_id(): returns the identifier for the object on which this
          method needs to be propertiesinvoked. If (stat), send object's statistics.  Note Returns None iff there is no associated
          object (a thatmethod ownershipcall ofagainst the object instance is returned to the
            caller on return from this call.
agent itself).
      .get_args(): returns a map of input arguments for the method. Arguments
          are .queryComplete( handle=<handle from WorkItem>, 
      in "name"=<value> pairs.  Returns None if no arguments are supplied.
      .get_user_id(): returns authenticated user id of caller if present, else None.

On completion of the method call, the application must provide the result of the call to the Agent. This is done by invoking the Agent's method_response() method. The method_response() method must be passed the handle from the METHOD_CALL WorkItem.

On successful completion of a method call, any output arguments from the method call must be passed in the out_args map parameter, in name=<value> pairs. The error parameter must be set to None.

If the method call fails the application must indicate the failure by passing a QmfData instance via the error parameter. The structure of this QmfData is application-specific, and meant to provide a description of the failure to the console.

QUERY

  QUERY parameters: ( class Query,
        =<status code> ):  Indicate to the agent
            that the application has completed processing a query request.
            Zero or more calls to the queryResponse() method should be
            invoked before calling queryComplete().  If the query should
            fail - for example, dueuser_id=<authenticated id of the user> )

The QUERY WorkItem describes a query that the application must service. The application should call the query_response() method for each object that satisfies the query. When complete, the application must call the query_complete() method. If a failure occurs, the application should indicate the error to the agent by calling the query_complete() method with a description of the error.

SUBSCRIBE_REQUEST

The SUBSCRIBE_REQUEST WorkItem provides a query that the agent application must periodically publish until the subscription is cancelled or expires. On receipt of this WorkItem, the application should call the Agent::subscription_response() method to acknowledge the request. On each publish interval, the application should call Agent::subscription_indicate(), passing a list of the objects that satisfy the query. The subscription remains in effect until an UNSUBSCRIBE_REQUEST WorkItem for the subscription is received, or the subscription expires.

The get_params() method call of the SUBSCRIBE_REQUEST WorkItem returns an instance of the following object:

class SubscriptionParams:
      .get_console_handle(): returns the handle that the console uses to identify this subscription.
  to authentication error - the result
            should be set to a non-zero error code ?TBD?.
      .subscriptionResponse( handle=<handle from WorkItem>,
                             result=<status code>,
                             subscription_handle=<application context>):
            Indicate the status of a subscription request.  If result
            is zero, the subscription is accepted by the application,
            and an subscription handle is provided.  This handle must
         This handle must be passed to the application when the agent unsubscribes.

Asychronous event model.

The Agent uses the same notification driven work queue model as the Console. In the Agent case, the WorkItem supports the following set of work types:

• METHOD_CALL
• QUERY
• SUBSCRIBE
• UNSUBSCRIBE

In the case of an internal store agent implementation, only the METHOD_CALL work item is generated. An external store agent must support all work item types.

  METHOD_CALL parameters: ( name=<method name>,  along with every published update from the Agent.
      .get_query(): returns the QmfQuery object associated with the subscription.
      .get_publish_interval(): returns the requested time interval in seconds for updates. [argument list],Returns
          zero if the Agent's default interval should be used.
      .get_lifetime(): returns the requested classlifetime ObjectId,
for the subscription.  Zero if the Agent's
          default subscription lifetime should be used.
      .get_user_id=<authenticated id of the user> )

The METHOD_CALL WorkItem describes a method call that must be serviced by the application on behalf of this agent. On completion of the method call, the application must invoke the agent's
methodResponse() method.

  QUERY parameters: ( class Query, 
                      user_id=<authenticated id of the user> )

The QUERY WorkItem describes a query that the application must service. The application should call the queryResponse() method for each object that satisfies the query. When complete, the application must call the queryComplete() method. If a failure occurs, the application should indicate the error to the agent by calling the queryComplete() method with a description of the error.

(): returns authenticated user id of Console if present, else None.

The Agent application must call the AgentExternal::subscription_response() method in response to this WorkItem.

The get_handle() WorkItem method returns the reply handle which should be passed to the Agent's subscription_response() method.

RESUBSCRIBE_REQUEST

The RESUBSCRIBE_REQUEST is sent by a Console to renew an existing subscription.  The Console may request a new duration for the subscription, otherwise the previous lifetime interval is repeated.

The get_params() method call of the RESUBSCRIBE_REQUEST WorkItem returns an instance of the following object:

class ResubscribeParams:
    .get_subscription_id(): returns the subscription identifier provided by the Agent.
    .get_lifetime(): returns the requested lifetime for the subscription.  Zero if the previous

  SUBSCRIBE parameters: ( class Query, 
               interval should be used.
    .get_user_id(): returns the authenticated user_id=<authenticated id of the user> )Console if present, else None.

The SUBSCRIBE WorkItem provides a query that the application should monitor until the subscription is cancelled. On receipt of this WorkItem, the application should call the subscriptionResponse() agent method to acknowledge the response. Whenever the matching objects are updated, the application should call queryResponse() for each updated object, followed by a call to queryComplete() when done. The subscription remains in effect until an UNSUBSCRIBE WorkItem for the subscription is received.

  UNSUBSCRIBE parameters: ( <handle associated with subscription> )

Alerts the application that the corresponding subscription has been cancelled. The application should no longer supply query updates against the subscribed query.

Revision History

Agent application must call the AgentExternal:subscription_reponse method in response to this WorkItem.

The get_handle() WorkItem method returns the reply handle which should be passed to the Agent's subscription_reponse() method

UNSUBSCRIBE_REQUEST

The UNSUBSCRIBE_REQUEST is sent by a Console to terminate an existing subscription.

The get_params() method call returns the subscription identifier assigned by the Agent when the subscription is created.

The Agent application should terminate the given subscription if it exists, and cancel sending any further updates against it11/20/2009 - First Revision
11/24/2009 - Added agent classes
12/01/2009 - Cleaned up Schema api and added map definitions.