Chapter 5. Tools

5.1. ObjectStore command-line editors

5.1.1. LogEditor
5.1.2. LogBrowser

This chapter explains how to start and use the tools framework and what tools are available.

Note

For this version of JBoss Transactions the GUI based tools are mainly documented in the file <INSTALL_ROOT>/INSTALL

5.1. ObjectStore command-line editors

There are currently two command-line editors for manipulating the ObjectStore. These tools are used to manipulate the lists of heuristic participants maintained by a transaction log. They allow a heuristic participant to be moved from that list back to the list of prepared participants so that transaction recovery may attempt to resolve them automatically.

5.1.1. LogEditor

Started by executing com.arjuna.ats.arjuna.tools.log.LogBrowser, this tool supports the following options that can be provided on the command-line.

Table 5.1. LogEditor Options

Option	Description
-tx `id`	Specifies the transaction log to work on.
-type `name`	The transaction type to work on.
-dump	Print out the contents of the log identified by the other options.
-forget `index`	Move the specified target from the heuristic list to the prepared list.
-help	Print out the list of commands and options.

5.1.2. LogBrowser

The LogBrowser, invoked by calling com.arjuna.ats.arjuna.tools.log.LogBrowser, is similar to the LogEditor, but allows multiple log instances to be manipulated. It presents a shell-like interface, with the following options:

Table 5.2. LogBrowserOptions

Option	Description
ls [`type`]	List the logs for the specified type. If no type is specified, the editor must already be attached to the transaction type.
select [`type`]	Browse a specific transaction type. If already attached to a transaction type, you are detached from that type first.
attach `log`	Attach the console to the specified transaction log. If you are attached to another log, the command will fail.
detach	Detach the console from the current log.
forget `pid`	Move the specified heuristic participant back to the `prepared` list. The console must be attached.
delete `pid`	Delete the specified heuristic participant. The console must be attached.
types	List the supported transaction types.
quit	Exit the console tool.
help	Print out the supported commands.