9.6. QMF Command Message Structure
QMF Command Message Content
QMF Command Messages are map messages. A QMF command message contains the keys _object_id, _method_name and _arguments.
The key
_object_id is mandatory. Its value is a nested map identifying the target of the command. For QMF commands that administer the broker and its resources, the _object_id map contains a single value with the key _object_name containing the value org.apache.qpid.broker:broker:amqp-broker. The _object_name value has the following syntax 'package:class:id'. The desired value may be obtained from the schema, using qpid-tool.
The key
_method_name has the name of the command as its value and the key _arguments contains a nested map of command arguments.
QMF Command Message Properties
Two message properties, x-amqp-0-10.app-id and qmf.opcode must be set. The property x-amqp-0-10.app-id should always have the value qmf2 and qmf.opcode contains the value _method_request.
QMF Command Response
To receive a response from the server, set the reply-to address of the QMF command message to an address where you can receive messages. After the command message is sent to the broker's QMF address, the response arrives from the reply-to address specified. The response message has the x-amqp-0-10.app-id property set to qmf2 when using amqp0-10.
If the command message is processed as expected, the response message
qmf.opcode property is set to _method_response. If an error was encountered, qmf.opcode property will contain the value _exception.
The response message content is a map. In the case of a valid response, return values are presented as a nested map against the key
_arguments. In the case of an exception, details of the exception are within a nested map against the key _values.
