Websphere MQ Everyplace

com.ibm.mqe.trace
Class MQeTraceToBinary

java.lang.Object
  |
  +--com.ibm.mqe.trace.MQeTraceToBinary
All Implemented Interfaces:
MQeTraceHandler
Direct Known Subclasses:
MQeTraceToBinaryFile, MQeTraceToBinaryMidp

public abstract class MQeTraceToBinary
extends java.lang.Object
implements MQeTraceHandler

An abstract trace handler which accepts data from the MQeTraceHandler interface, and converts it into a binary form.

The resultant binary form can be saved to a persistent medium by a subclass. In this manner, a separation between the gathering of the trace informaion, and the processing of the trace information can be achieved.

The processing of the trace information often requires large amounts of data to be loaded, increasing the memory footprint of an application. Such facilities are provided by the MQeTracePoint, MQeTracePointGroup and MQeTraceRenderer classes in this package.

Passing the trace data to a binary persistent form allows for a compact representation of the data to be made. The trace data can be processed with more complex tools at a later time, possibly after the data has been moved or sent to a different machine. For example, IBM Service representatives might ask for such a trace to be sent for analysis.

Subclasses of this abstract class persist the trace data to different media.

This class will issue a single call to the writeHeader() method, followed by a succession of calls to the writeRecord() method.

For packaging purposes, this class has no dependencies on any other MQe class except the MQe and MQeTraceHandler classes.

The format of the binary data is formed with two pieces of data:

See Also:
MQeTracePoint, MQeTracePointGroup,

If for any reason, any ascii or unicode strings have a length exceeding ASCII_CHARS_IN_MAX_LENGTH_STRING or UNICODE_CHARS_IN_MAX_LENGTH_STRING, then these strings are truncated to that length. This trace mechanism is not designed for a volume of huge text messages.


Field Summary
static int UNICODE_CHARS_IN_MAX_LENGTH_STRING
          The maximum length of a unicode string which will be collected by the trace mechanism.
 
Constructor Summary
MQeTraceToBinary()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mqe.MQeTraceHandler
setFilter, traceMessage, traceMessage, traceMessage, traceMessage, traceMessage
 

Field Detail

UNICODE_CHARS_IN_MAX_LENGTH_STRING

public static final int UNICODE_CHARS_IN_MAX_LENGTH_STRING
The maximum length of a unicode string which will be collected by the trace mechanism.

Expressed in the number of unicode characters allowed.

Strings over this length are truncated to this number of unicode characters.

This is necessary as the length of the string is stored as a short, and if tracing a huge string, you get a negative length in the short being saved. Protect against this by simply cropping the information.

See Also:
Constant Field Values
Constructor Detail

MQeTraceToBinary

public MQeTraceToBinary()

Websphere MQ Everyplace