Note that support for the MessageStoreTool was withdrawn beginning with release 0.16. The Management interfaces of the Broker now fulfil these use-cases.

MessageStore Tool

We have a number of implementations of the Qpid MessageStore interface. This tool allows the interrogation of these stores while the broker is offline.

MessageStore Implementations

Unable to render {children}. Page not found: Java Broker Design - MessageStore.


Each of the MessageStore implementations provide different back end storage for their messages and so would need a different tool to be able to interrogate their contents at the back end.

What this tool does is to utilise the Java broker code base to access the contents of the storage providing the user with a consistent means to inspect the storage contents in broker memory. The tool allows the current messages in the store to be inspected and copied/moved between queues. The tool uses the message instance in memory for all its access paths, but changes made will be reflected in the physical store (if one exists).


The tools-distribution currently includes a unix shell command 'msTool.sh' this script will launch the java tool.

The tool loads $QPID_HOME/etc/config.xml by default. If an alternative broker configuration is required this should be provided on the command line as would be done for the broker.

msTool.sh -c <path to different config.xml>

On startup the user is present with a command prompt

$ msTool.sh
MessageStoreTool - for examining Persistent Qpid Broker MessageStore instances

Available Commands

The available commands in the tool can be seen through the use of the 'help' command.

bdb$ help
|                       Available Commands                       |
| Command | Description                                          |
| quit    | Quit the tool.                                       |
| list    | list available items.                                |
| dump    | Dump selected message content. Default: show=content |
| load    | Loads specified broker configuration file.           |
| clear   | Clears any selection.                                |
| show    | Shows the messages headers.                          |
| select  | Perform a selection.                                 |
| help    | Provides detailed help on commands.                  |

A brief description is displayed and further usage information is shown with 'help <command>'

bdb$ help list
list availble items.
Usage:list queues [<exchange>] | exchanges | bindings [<exchange>] | all

Future Work

Currently the tool only works whilst the broker is offline i.e. it is up, but not accepting AMQP connections. This requires a stop/start of the broker. If this functionality was incorporated into the broker then a telnet functionality could be provided allowing online management.

  • No labels