Page History

...

Arbitrarily structured data is the simplest 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.

...

class QmfData:
      <constructor>( _values=map of "name"=<AMQP Type> pairs, 
                     _subtypes=optional map of "name"=<AMQP String> pairs for subtype information,
                     _desctag=optional, AMQPapplication-specific stringtag containing a human-readable description for this data object.applied to this QmfData instance
                     _object_id=optional AMQP string that uniquely identifies this QmfData instance.
                     _schema=optional <class SchemaClass> reference
                     _const=False )
      <constructor>( _map=map representation of QmfData, as generated by mapEncode() method, 
                     _schema=optional <class SchemaClass> reference
                     _const=False)
      .isManagedis_managed(): returns True if object identifier string assigned, else False.
      .isDescribedis_described(): returns True if schema is associated with this instance
      .getDescget_tag(): return the description of this object's tag if present, else None
      .getValueget_value(name): return the value of the named data item, returns None if named property is not present.
      .hasValuehas_value(name): returns True if the named data item is present in the map, else False.
      .setValueset_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. 
      .getSubTypeget_subtype(name): returns the sub type description string, else None if not present. 
      .setSubTypeset_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.
      .mapEncodemap_encode(): returns a map representation of the QmfData instance, suitable for use by the constructor.

...

...

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 QmfEvent(QmfData):
      <constructor>( timestamp,
                     _severity=<string>,
                     _values=map of "name"=<AMQP Type> pairs,
                     _subtypes=optional map of "name"=<AMQP String> pairs for subtype information,
                     _desctag=optional, AMQPapplication-specific stringtag containingapplied ato human-readablethis description for this data object.QmfEvent instance
                     _schema=optional <class SchemaEventClass> )
       <constructor>( _map= map encoding of a QmfEvent instance, 
                     _schema=optional <class SchemaEventClass> )
      .getTimestampget_timestamp(): return a timestamp indicating when the Event occurred.
      .get_severity(): return the severity associated with the Event.
      .map_encode(): return a map encoding of the Event.

The map encoding of an instance of the QmfEvent class extends the map of the parent class with the following class properites:

Schema

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

...

class SchemaClassId:
      <constructor>( package=<package-name-str>, 
                     class=<class-name-str>,
                     type=<SchemaTypeData|SchemaTypeEvent>)
                     hash=<hash-str, format="%08x-%08x-%08x-%08x">, 
      .getPackageNameget_package_name(): returns <package-name-str>
      .getClassNameget_class_name(): returns <class-name-str>
      .getHashStringget_hash_string(): returns <hash-str, "%08x-%08x-%08x-%08x">
      .getTypeget_type(): returns SchemaTypeObject or SchemaTypeEvent
      .mapEncodemap_encode(): returns a map encoding of the instance.

...

class SchemaProperty:
      <constructor>( name=<name-value>, 
                     type=<type-value>,
                     ...)
      .getTypeget_type(): AMQP typecode for encoding/decoding the property data
      .getAccessget_access(): "RC"=read/create, "RW"=read/write, "RO"=read only (default)
      .isOptionalis_optional(): True if this property is optional
      .getUnitget_unit(): string describing units (optional)
      .getMinget_min(): minimum value (optional)
      .getMaxget_max(): maximum value (optional)
      .getMaxLenget_max_len(): maximum length for string values (optional)
      .getDescget_desc(): optional string description of this Property
      .getDirectionget_direction(): "I"=input, "O"=output, or "IO"=input/output
                       (required for method arguments, otherwise
                       optional)
      .getSubtypeget_subtype(): string indicating the formal application type 
                     for the data, example: "URL", "Telephone number",
                     etc.
      .isPolledis_polled(): True if changes to the data cannot be practically 
                   monitored by an Agent.  Such a data item can only
                   be queried or polled - not published on change.
      .getReferenceget_reference(): if type==objId, name (str) of referenced class
                       (optional) 
      .isParentRefis_parent_ref(): True if this property references an object in
                       which this object is in a child-parent
                       relationship.
      .getAttributeget_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 prefix "x-"
      .mapEncodemap_encode(): returns a map encoding of the instance.

...

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

class SchemaMethod:
      <constructor>( [args=<map of "name":<SchemaProperty> entries>],
                     desc="description of the method")
      .getDescget_desc(): return human-readable description of the method.
      .getArgumentCountget_argument_count(): return the number of arguments
      .getArgumentsget_arguments(): returns a copy of the map of "name":<SchemaProperty>
      .getArgumentget_argument("name"): return the SchemaProperty for the parameter "name"

      .addArgumentadd_argument("name", SchemaProperty): adds an additional argument to
 the parameter list.
               the parameter list.
      .mapEncode.map_encode(): returns a map encoding of the SchemaMethod instance

...

...

class SchemaClass(QmfData):
      <constructor>( classId=<class SchemaClassId>, 
                     _desc=optional AMQP string containing a human-readable description for this schema)
      .getClassIdget_class_id(): return the SchemaClassId that identifies this Schema instance.
      .generateHashgenerate_hash(): generate a hash over the body of the schema, and return a string representation of the hash in format  "%08x-%08x-%08x-%08x"

...

class SchemaObjectClass(SchemaClass):
      <constructor>( classId=<class SchemaClassId>, 
                     _desc=optional AMQP string containing a human-readable description for this schema,
                     _props=map of "name"=<SchemaProperty> instances,
                     _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
                     for identifying unique instances of this class.  Returns None if no list defined.
      .getPropertyCountget_property_count(): return the count of SchemaProperty's in this instance.
      .getPropertiesget_properties(): return a map of "name":<SchemaProperty> entries for each value in the object.
      .getPropertyget_property("name"): return the SchemaProperty associated with "name", else None if "name" value
 does not exist.

      .get_method_count(): return the count                does not exist.

      .getMethodCount(): return the count SchemaMethod's SchemaMethod's in this instance.
      .getMethodsget_methods(): return a map of "name":<SchemaMethod> entries for each method associated with the
                     object.
      .getMethodget_method("name"): return the SchemaMethod associated with the "name", else None if "name" does
                          not exist or is not a method.

      .addPropertyadd_property("name", SchemaProperty): add a new property.
      .addMethodadd_method("name", SchemaMethod): add a new method.
      .set_id_names([name-list]): set the value of the order list of names to use when 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>,
                     _desc=optional AMQP string containing a human-readable description for this event,
                     _props=map of "name":SchemaProperty instances)
      .getPropertyCountget_property_count(): return the number of properties.
      .getPropertiesget_properties(): return a map of "name":<SchemaProperty> entries for each property in the event.
      .getPropertyget_property("name"): return the SchemaProperty associated with "name".

      .addPropertyadd_property("name", SchemaProperty): add a new property.

...

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 objectsyntax:

{"query": {"what":<target>},
           {"where":<predicate>}
          ...future selectors....
<selector_type>:<selector_params>}
}

Where:

The value of the "what" key indicates the set of desired objects to match against. The value of the "where" key is an optional predicate to use as the match criteria. If the "where" key is not present, then the query matches against all members of the target set. The agent processes a received query, and returns a 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.

...

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

<predicate> describes a logical match expression that is applied to the target. The expression can be built up from the following syntax:

  binary_cmp=["eq", "ne", "lt", "le", "gt", "ge", "re_match"]
  unary_cmp=["exists"]

  compare_exp = [binary_cmp, <name>, <value>] | 
                [unary_cmp, <name>]

  n_ary_logic = ["and", "or", "not"]

  logic_exp = [n_ary_logic, <expression>, <expression>, ... ] 

  expression = compare_exp | logic_exp

In implementation, predicate expressions are expressed as nested maps. Each map
element is indexed by the operator keyword. The value of the element
is an n-entry ordered list of the operands to the operator. The
format of a single operator expression would be:

    {operator: [operand1, operand2, ...]}

Examples:

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"]]

     the conditional:
    
         "name" == "tross" or ("name" == "jross" 
                                and "address" == "1313 Spudboy Lane"
                                and "town" == "Utopia")

     would be expressed in a python map as:
  
         {"or": [{"eq": ["name", "tross"]},
                 {"and": [{"eq": ["name", "jross"]},
                          {"eq": ["address", "1313 Spudboy Lane"]},
                          {"eq": ["town", "Utopia"]}]
                 }
                ]
         }


     the conditional:

         !(("name" matches regular expression "?ross") and 
           (("age" property is present) or ("status" is not "sleepy")))

     would be:

        {"not": [{"and": [{"re_match": ["name", "?ross"]},
                          {"or": [{"exists": ["age"]},
              ["eq" "address" ["quote" "1313 Spudboy Lane"]]
               {["neeq": ["statusquote", "sleepyUtopia"]} "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> supplied in the "what" qualifier 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 query target, and what these names evaluate to on from the target instance.

...

class QmfQuery:
      <constructor>(_target=<target map>name>,
                    _predicate=(optional)<predicate map>)
target_params=None,
           .get_target(): return target map
      .get_predicate=(optional):<predicate map>,
 return predicate map
      .evaluate(QmfData): evaluate query against a QmfData instance.  Returns True if query _id=(optional)<target-identifier>)
      <constructor>(map=Map representation of a QmfQuery, as generated by .map_encode())
      .get_target(): return target name
    matches the instance, else false .get_target_param(): return params.
      .mapEncodeget_selector(): returns a map encoding of the QmfQuery instance
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 SchemaMethodQmfQuery:

...

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}}}

...

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 all SchemaClass objects that match a given package and class
namethe particular QmfData data object with the identifier "Agent007":

    {"query": {"what": {"schemaobject": None},
               "whereid": {"and": [{"eq": [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},
"_package_name", "myPackage"]},
                  "id": {"_package_name": "MyPackage",
                {"eq":  ["_class_name",: "someClass"]}]}MyClass",
              }
    }

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

"_type": "_data",
    {"query": {"what              "_hash_str": "b49cda2d-bbe53b97-9f6ee5d1-485ea3da"}}
}

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

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

Query for all QmfData objects from a particular schema, whose
"temperature" property is greater or equal to 50managed 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": {"_package_name_id": "aPackageNone},
           "where": ["and" ["eq" "_package_name" ["quote" "myPackage]]
                   "_class_name": "someClass"}},
               "where": {"ge": ["temperature", 50]}
["eq" ["quote" "myClass"] "_class_name"]
                }
       }

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".

    {["queryre_match": {"what_primary_key": {["objectquote": {"_package_name": "aPackage,"foo*"]]
                    ]
          }
}

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

{"query": {"what": {"object": None},
     "_class_name": "someClass"}},
               "where": {["orand": [{"noteq": [{"re_package_matchname": ["statequote", "$Error"aPackage]}]},
                                {"ne":["eq" ["ownerquote", "CartmansomeClass"]} "_class_name"]
                         }
   ["ge" "temperature" 50]
                   } ]
          }

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?

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 parameters 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
parameter values may be present. The structure of the returned parameters is described by the SchemaMethod for the method. The map contains only those parameters that the SchemaMethod marks with an "output" direction.

}

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"]]]

class MethodResult:
      <constructor>( QmfData <exception> | <map of properties> )
      .getException(): returns exception data if method fails.
      .getArguments(): returns a map of "name"=<value> pairs["ne" "owner" ["quote" "Cartman"]]
                       of  all returned arguments.
  ]
                    ]
    .getArgument(<name>): returns value of argument named "name".

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.

 }
}

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

class QmfConsoleData(QmfData):
      .get_timestamps(): returns a list<constructor>( QmfData <exception> | <map of timestampsproperties> describing the)
      .succeeded(): returns True if the method call executed without error.
      .get_exception(): returns the lifecycleQmfData oferror theobject object.if method Allfails, timestampselse areNone
      .get_arguments(): returns a map of "name"=<value> pairs of all returned arguments.
        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.

Asychronous Event Model.

.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 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 stateone or more new WorkItem objects are added to the queue. To avoid any potential threading issues, the console application is not allowed to call any QMF API from within the context of the callback context. The purpose of the callback is to allow notify the console application to schedule itself to drain the work queue at the next available opportunity.

...

The callback is represented by the Notifier virtual base class. This base class contains a single method. A console 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
       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
     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.get_type(): Identifies the type of work item.
    .get_handle(): returns the reply handle for an asynchronous operation, if present.
    AGENT_DELETED = 2
    NEW_PACKAGE = 3
    NEW_CLASS = 4
    OBJECT_UPDATE = 5
    EVENT_RECEIVED = 7
    AGENT_HEARTBEAT = 8

    .getType(): Identifies the.get_params(): Returns the payload of the work item.  The type of workthis itemobject byis returning one of
    determined by 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.

...

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

class Agent:
      .get_name(): returns the identifying name string of the agent.  This name is
                   used to send AMQP messages directly to this agent.
      .isActive(): returns True if the agent is alive (heartbeats have not timed out)
      .invoke_method(name, inArgs{}, [[reply-handle] | [timeout]]): 
                          invoke the named methodrepresented againstby the AMQP timestamp agenttype.
                        [0] = time of last update from ?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>, 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    domain=(optional) domain string for consolethis object's AMQP address,contents.
      .invoke_method(name,              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.

      .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( name string, [timeout] ): Query for the presence of a specific
                agent in the QMF domain. Returns a class Agent if the agent isinArgs{}, [[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 present.returns None, If the agent is not already known to the console, thisand get_error() can be used to obtain an
          application-specific QmfData error object.
   call will send a query for .get_publish_interval(): returns the agenttime andinterval blockin (withseconds default
on which the Agent will publish updates
          timeout override) waiting for athis responsesubscription.

      .enableAgentDiscovery( [Query] get_lifetime(): Calledreturns tothe enabletime theinterval asynchronous
in seconds for the subscription. The subscription will automatically
  Agent Discovery process. Once enabled, AGENT_ADDED and AGENT_DELETED work
expire after this interval if not renewed by the console.
 items can arrive on the WorkQueue.get_error(): (optional) Ifreturns aan queryapplication-specific isQmfData supplied,object it
indicating          will be used to filter agent notifications.

      .disableAgentDiscovery(): Called to disable the async Agentwhy the subscription
      Discovery process enabled by callingrequest enableAgentDiscovery()failed.  

      .getWorkItemCount(): Returns theNone countif of pending WorkItems that
      can be retrieved. 
not supported.
      .getNextWorkItem([timeout=0]get_console_handle(): Obtainsreturns the nextconsole pendinghandle work
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:  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( name string ): 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] get_subscription_id(): If Returnsthe are-subscription listis ofsuccessful, SchemaClassIds
this method returns an instance of
     for all available Schema.  Ifthe anoriginal optionalSubscriptionId Agentobject. is provided,
Should the subscription fail, this method returns None,
   then the returned SchemaClassIds are limited to those
          Schema known to the given Agent.
and get_error() can be used to obtain an application-specific QmfData error object.
      .getSchema( class SchemaClassId [, class Agent]): Return a list
      get_publish_interval(): returns the time interval in seconds on which the Agent will publish updates
    of all available class SchemaClass across allfor knownthis agentssubscription.
      .get_lifetime(): returns the time Ifinterval anin optionalseconds Agentfor isthe provided, restrict the returned
subscription. The subscription will automatically
          expire schema to those supportedafter this interval if not renewed by thatthe Agentconsole.

      .getObjectsget_error( _SchemaClassId= | _package=, _class= |
     ): (optional) returns an application-specific QmfData object indicating why the re-subscription
          request failed.  Returns  _object_identifier=,
  None on successful resubscribe.
      .get_console_handle(): returns the console handle as passed to the   [timeout=],
  create_subscription() call, if available.
          Note: if the Agent failed the  [list-of-class-Agent] ): perform a blocking queryresubscribe request due to an unrecognized subscription, this call may
          return for QmfConsoleObjects.  Returns a list (possibly empty) of matchingNone.

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 objects.string Theof selector for the queryagent. may beThis either:
name is used to send AMQP messages directly to this agent.
 * class SchemaClassId - all objects whose schema match the
         .is_active(): returns True if the agent is alive (heartbeats have not timed out)
      .invoke_method(name, inArgs{}, [[reply-handle] | [timeout]]): invoke the schemanamed identifiedmethod byagainst _SchemaClassIdthe parameteragent.
      .enable_events(): allows reception of events *from package/class name - all objects whose schema are
       this agent.
      .disable_events(): prevents reception of events from this agent.
      .destroy(): releases this Agent instance.  Once contained bycalled, the namedconsole packageapplication andshould class.
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>,
 * the object identified by _object_identifier
           This method will block until all known agents reply, or the
                    timeout expires. Once the timeout expires, all
    domain=(optional) domain string for console's AMQP address,
          data retrieved to date is returned.  
   notifier=<class Notifier>,
       If a list of agents is supplied, then the query is sent to
 reply_timeout=<default for all blocking calls>,
               only those agents.  


      .createSubscription( class Query [, duration=<secs> [, list of agents] ): creates a
 agent_timeout=<default timeout for agent heartbeat>,
                    subscription_duration=<default usinglifetime theof given Query.a subscription>)

  If a list of agents
        .destroy(timeout=None): Must be called to release Console's resources.

     is provided, the Query will apply only to those agents. .add_connection(QPID Connection): Connect the console to the AMQP cloud.

      .remove_connection(conn): Remove the AMQP connection from Otherwisethe itconsole. will applyUn-does to all active agents, includingthe add_connection() operation, and
          releases any thoseagents discoveredassociated duringwith the lifetime of the subscription.
connection.  All blocking methods are unblocked and given a   The duration argument can be used to override the
failure status.
          All outstanding asynchronous operations are cancelled without producing  console's default subscription lifetime for thisWorkItems.

      .get_address():
          Get  subscription.  Returns a class SubscriptionIdthe AMQP address this Console is listening to (type str).

      .refreshSubscriptionfind_agent( SubscriptionIdname [string, duration=<secs>[timeout] ):
 Query for the presence  (re)activatesof a subscription.specific agent Usesin the QMF consoledomain. defaultReturns durationa
        unless  class Agent if the durationagent is explicitly specifiedpresent.

  If the agent is .cancelSubscription(not SubscriptionIdalready ):known terminatesto the console, this call will send
         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( "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.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

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.
      .setValue(name, value): update the value of the property.
      .incValue(name, delta): add the delta to the property
      .decValue(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.

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 the
          requested lifetime and publish_interval may be overridden by the Agent, as indicated in the subscription response.
          This method may be called asynchronously by providing a reply_handle argument.  When called asynchronously, the result
          of this method call is returned in a SUBSCRIBE_RESPONSE WorkItem with a handle matching the value of reply_handle.
          Timeout can be used to override the console's default reply timeout.  When called synchronously, this method returns a class
          SubscribeParams object containing the result of the subscription request.

      .refresh_subscription( SubscriptionId [, lifetime] [,reply_handle] [, timeout] ): renews a subscription identified by
          SubscriptionId.  The Console may request a new subscription duration by providing a requested lifetime. This
          method may be called asynchronously by providing a reply_handle argument. When called asynchronously, the result
          of this method call is returned in a SUBSCRIBE_RESPONSE WorkItem.  Timeout can be used to override the console's
          default reply timeout.  When called synchronously, this method returns a class SubscribeParams object containing
          the result of the subscription request.

      .cancel_subscription( SubscriptionId ): terminates the given 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
        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.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

class Agent:
      <constructor>( name=<name-string>,
                     domain=(optional) domain string for agent's AMQP address,
            have a registered schema for an object class  notifier=class Notifier,
    before it can handle objects of that class.
      .register_event_class( class SchemaEventClass ) : Register a schema for an  heartbeat_interval=30,
       event class with the agent.  The agent must
            have  max_msg_size=65535)
      .get_name(): return the name string of the agenta registered schema for an event class before it can handle events of that class.
      .setConnectionraise_event( QPIDclass ConnectionQmfEvent ): connectCause the agent to raise the AMQPgiven cloudevent.
      .registerObjectClassadd_object( class SchemaObjectClassQmfAgentData ): Registerpasses a
 reference to an instance of a      schema for an object class withmanaged QMF object to the agent.  The agent mustobject's
          name must haveuniquely aidentify registeredthis schemaobject foramong anall objectobjects classknown beforeto itthis canagent.
      .get_workitem_count(): Returns the count of pending handleWorkItems objectsthat ofcan thatbe classretrieved.
      .registerEventClass( class SchemaEventClass ) : Register a
  get_next_workitem([timeout=0]): Obtains the next pending work item, or None if none available.
      .release_workitem(wi): Releases a WorkItem schemainstance forobtained an event class withby get_next_workitem(). Called when the agent.application has The agent mustfinished
          processing the haveWorkItem.
 a registered schema for an event class before it can
 .method_response(name="method name",
               handle events of that class.
    handle=<handle  .raiseEvent( class QmfEvent ): Cause the agent to raise the
from WorkItem>,
                     given event.
    out_args={output argument map}
   .addObject( class QmfAgentData ):
            passes a reference to an instance of a managed QMF object
        error=<QmfData> ): Indicate to the agent that the application has completed processing a method
    to the agent. The object's name must uniquely identify this
          request. See objectthe amongdescription allof objectsthe 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):
 known to this agent.
      .getWorkItemCount(): Returns the count of pending WorkItems that
<constructor>(name=<name-string>,
                    domain=(optional) domain string for canagent's beAMQP retrieved.address,
       .getNextWorkItem([timeout=0]): Obtains the next pending work
        notifier= class Notifier,
  item, or None if none available. 
      .releaseWorkItem(wi): Releases a WorkItem instance obtained by heartbeat_interval=30,
            getNextWorkItem(). Called when the application has finished        max_msg_size=65535)
      .alloc_object_id( name="object name"): indicate to QMF processingthat the WorkItem. 
      .methodResponse( handle=<handle from WorkItem>named object is available to be managed.  Once this method returns,
          the agent will service requests from consoles referencing      [output argument list],this data.
      .free_object_id( name="object name" ): indicate to QMF that the named object is no longer available to  result=<status code>,be managed.
      .query_response( handle=<handle from WorkItem>,
              exception=<QmfData> ): Indicate to the agent
   class QmfAgentObject): send a managed object in reply to that the application has completed processing a methoda received query. Note that ownership of the object
          instance is request. A result code of zero indicates success.  If the
      returned to the caller on return from this call.
      .query_complete( handle=<handle from WorkItem>,
      result code is non-zero, exception may optionally be set to a
      result=<status code> ):  Indicate to QmfDatathe objectagent that describesthe theapplication failure.has completed Onprocessing success,a zeroquery orrequest.
          Zero or more output arguments may calls to the queryResponse() method should be supplied as defined by the method'sinvoked before calling query_complete().  If the query should
          fail  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):
      <constructor>(name=<name-string>,
        - for example, due to authentication error - the result should be set to a non-zero error code ?TBD?.

      .subscription_response( handle=<handle from WorkItem>,
   domain=(optional) domain string for agent's AMQP address,
                    notifier= class Notifier,
   console_handle=<handle provided by Console for this subscription>,
                 heartbeat_interval=30,
            subscription_handle=<agent-provided context>,
       max_msg_size=65535)
      .allocObjectId( name="object name"): indicate to QMF that the named
        lifetime=<seconds>, publish_interval=<seconds>,
    object is available to be managed.  Once this method returns,
             the agent will service requests from consoles referencing this dataerror=<QmfData>): Indicate the result of a SUBSCRIBE_REQUEST WorkItem.
      .freeObjectId( name="object name" ): indicate to QMF that the named
            If the subscription request is successful, the Agent application must provide a unique subscription_handle.  If replying
     object is no longer available to be managed.
      .queryResponse( handle=<handle from WorkItem>,a sucessful subscription refresh, the original subscription_handle must be supplied.  The lifetime parameter should be
          set to the duration of the subscription in seconds.  The publish_interval should classbe QmfAgentObject):set sendto athe managedtime objectinterval in seconds
          between successive publications on replythis tosubscription. a receivedIf query.the Notesubscription thator ownershiprefresh offails, the subscription_handle
          should be objectset instanceto isNone returnedand toerror themay callerbe onset returnto from
an application-specific QmfData instance that describes the error.  Should
   this call. 
     a .queryComplete( handle=<handle from WorkItem>, 
        refresh request fail, the console_handle may be set to None if unknown.

      .subscription_indicate(console_handle, [list of subscribed data]): Send a list result=<statusof code>updated ):subscribed data Indicate to the agentConsole.

      .subscription_cancel(handle=<handle from WorkItem>, console_handle): Acknowledge a Subscription   that the application has completed processing a query request.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 Zeroname or more calls to of the queryResponse() method should becall.
            invoked before calling queryComplete().  If the query should
     .get_object_id(): returns the identifier for the object on which this
       fail - for example,method dueneeds to authenticationbe errorinvoked. - theReturns result
None iff there          should be set to a non-zero error code ?TBD?.
is no associated
        .subscriptionResponse( handle=<handle from WorkItem>,
      object (a method call against the agent itself).
      .get_args(): returns a map of input arguments for the method. Arguments
       result=<status code>,
  are in "name"=<value> pairs.  Returns None if no arguments are supplied.
      .get_user_id(): returns authenticated user id of caller if present,  subscription_handle=<application context>):
            Indicate the status of a subscription request.  If result
            is zero, the subscription is 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 Queryaccepted by the application,
            and an subscription handle is provided.  This handle must
 user_id=<authenticated id of the        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.

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.

  METHOD_CALL parameters: ( name=<method name>, 
                  This handle must be passed along with every published update from [argument list],the Agent.
      .get_query(): returns the QmfQuery object associated with the subscription.
      .get_publish_interval(): returns the requested time interval in seconds for updates. object identifier,Returns
          zero if the Agent's default interval should be used.
      .get_lifetime(): returns the requested lifetime for the subscription.  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, 
        Zero if the Agent's
          default subscription lifetime should be used.
      .get_user_id(): returns authenticated      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.

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

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

11/20/2009 - First Revision
11/24/2009 - Added agent classes
12/01/2009 - Cleaned up Schema api and added map definitions.
12/04/2009 - Removed distinction between properties and statistics.
Object identification now based on Primary Key List.
Added more map definitions.
12/11/2009 - Formally define query implementation.
12/14/2009 - Update query implementation based on feedback.

Todo List

...

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
        interval should be used.
    .get_user_id(): returns the authenticated user id of the Console if present, else None.

The 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 it.

...