XmlBlaster Logo

REQUIREMENT

admin.messages

XmlBlaster Logo


Type NEW
Priority LOW
Status CLOSED
Topic You can administer XmlBlaster sending messages
Des
cription

Messages marked in their key oid with __cmd: are handled as administrative messages.

The query syntax is described in the admin.commands requirement.

Responses of get() commands are returned in the message content.

Example
any 		Start xmlBlaster. We configure the server to have a nice and short name heron: 
  java org.xmlBlaster.Main -cluster.node.id heron

Check who is logged in, the returned content contains the comma separated list of login names: 

  java org.xmlBlaster.client.reader.GetMessage -oid __cmd:?clientList

    <key oid='__cmd:/node/heron/?clientList' contentMime='text/plain'/>
    <content>guest,__sys__jdbc</content>
    <qos/>

Now lets query and change the run level, the returned data is shown as well: 

  java org.xmlBlaster.client.reader.GetMessage -oid __cmd:/node/heron/?runlevel

    <key oid='__cmd:/node/heron/?runlevel' contentMime='text/plain'/>
    <content>9</content>
    <qos/>

  java org.xmlBlaster.client.feeder.PublishFile -xmlKey "<key oid='__cmd:?runlevel=6'/>"

    <qos>
      <state id='OK' info='/node/heron/?runlevel=6'/>
      <key oid='__cmd:?runlevel=6'/>
    </qos>

Here we shutdown the server, the returned QoS is showed as well: 

  java org.xmlBlaster.client.feeder.PublishFile -xmlKey "<key oid='__cmd:?exit=-1'/>"

    <qos>
      <state id='OK' info='/node/heron/?exit=-1'/>
      <key oid='__cmd:?exit=-1'/>
    </qos>

Usually you do this in your client code directly, PublishFile and GetMessage are examples only to show usage from command line.

Please read the admin.commands requirement for a description of the command syntax.

Example
any

When publishing a command, the new value can be transported in the content of the message as well. In this case omit the '=' sign in the key oid: 

  key =     "<key oid='__cmd:?pluginConfig'/>"
  content = "<myPlugin maxValues='15'/>"
  qos =     "<qos/>"
Configure
Property Default / Example Description Implemented
admin.messages true Switch administration with administrative command messages on or off yes

NOTE: Configuration parameters are specified on command line (-someValue 17) or in the xmlBlaster.properties file (someValue=17). See requirement "util.property" for details.
Columns named Impl tells you if the feature is implemented.
Columns named Hot tells you if the configuration is changeable in hot operation.

Todo

Testsuite is missing.

See API org.xmlBlaster.engine.admin.extern.MomClientGateway
See REQ admin
See REQ admin.commands

This page is generated from the requirement XML file xmlBlaster/doc/requirements/admin.messages.xml

Back to overview