|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
All WebSphere MQ Everyplace trace handlers must implement this interface.
Classes which implement this interface can use the
MQeTrace.setHandler(com.ibm.mqe.MQeTraceHandler)
method to start capturing trace
information from the MQe system.
MQeTrace
Method Summary | |
void |
setFilter(long filterMask)
Called when the groups filter is changed from above. |
void |
traceMessage(java.lang.Object selfReference,
short messageNumber,
long groups)
Called to write a trace message to the output stream. |
void |
traceMessage(java.lang.Object selfReference,
short messageNumber,
long groups,
java.lang.Object insert1)
Called to write a trace message to the output stream. |
void |
traceMessage(java.lang.Object selfReference,
short messageNumber,
long groups,
java.lang.Object insert1,
java.lang.Object insert2)
Called to write a trace message to the output stream. |
void |
traceMessage(java.lang.Object selfReference,
short messageNumber,
long groups,
java.lang.Object insert1,
java.lang.Object insert2,
java.lang.Object insert3)
Called to write a trace message to the output stream. |
void |
traceMessage(java.lang.Object selfReference,
short messageNumber,
long groups,
java.lang.Object insert1,
java.lang.Object insert2,
java.lang.Object insert3,
java.lang.Object insert4)
Called to write a trace message to the output stream. |
Method Detail |
public void traceMessage(java.lang.Object selfReference, short messageNumber, long groups)
Called by WebSphere MQ Everyplace to output a trace message through the trace handler.
selfReference
- A reference to the object which is issuing the trace.
Will be null if the trace point is not associated with this trace point,
for example, when the trace is generated from within a static method.
If non-null, the class name, and hash code of the object can be obtained to
provide extra information to accompany the other trace information.messageNumber
- The trace message number is a unique, single point in source
code. Can be mapped to other information relating to this point in the code
using the MQeTracePoint
,
MQeTracePointGroup
and MQeTraceRenderer
classes.groups
- A bitmasked field comprised of one or more MQeTrace.GROUP_*
constants bit-ORed together.
This information can be used to dynamically filter out these course groupings
in a simple way, without having to load the
MQeTraceRenderer
and associated classes.
public void traceMessage(java.lang.Object selfReference, short messageNumber, long groups, java.lang.Object insert1)
Called by WebSphere MQ Everyplace to output a trace message through the trace handler.
selfReference
- A reference to the object which is issuing the trace.
Will be null if the trace point is not associated with this trace point,
for example, when the trace is generated from within a static method.
If non-null, the class name, and hash code of the object can be obtained to
provide extra information to accompany the other trace information.messageNumber
- The trace message number is a unique, single point in source
code. Can be mapped to other information relating to this point in the code
using the MQeTracePoint
,
MQeTracePointGroup
and MQeTraceRenderer
classes.groups
- A bitmasked field comprised of one or more MQeTrace.GROUP_*
constants bit-ORed together.
This information can be used to dynamically filter out these course groupings
in a simple way, without having to load the
MQeTraceRenderer
and associated classes.insert1
- A substitution parameter to be substituted for in the
trace template so that a readable text string can be built.
Trace handlers will typically use the toString() method on the object passed, though may choose not to use the information at all if the particular trace information carried by this method is not required.
If it derived from java.lang.Throwable then the trace handler may wish to trace a stack trace together with the accompanying error message text.
public void traceMessage(java.lang.Object selfReference, short messageNumber, long groups, java.lang.Object insert1, java.lang.Object insert2)
Called by WebSphere MQ Everyplace to output a trace message through the trace handler.
selfReference
- A reference to the object which is issuing the trace.
Will be null if the trace point is not associated with this trace point,
for example, when the trace is generated from within a static method.
If non-null, the class name, and hash code of the object can be obtained to
provide extra information to accompany the other trace information.messageNumber
- The trace message number is a unique, single point in source
code. Can be mapped to other information relating to this point in the code
using the MQeTracePoint
,
MQeTracePointGroup
and MQeTraceRenderer
classes.groups
- A bitmasked field comprised of one or more MQeTrace.GROUP_*
constants bit-ORed together.
This information can be used to dynamically filter out these course groupings
in a simple way, without having to load the
MQeTraceRenderer
and associated classes.insert1
- A substitution parameter to be substituted for in the
trace template so that a readable text string can be built.
Trace handlers will typically use the toString() method on the object passed, though may choose not to use the information at all if the particular trace information carried by this method is not required.
insert2
- As insert1
If it derived from java.lang.Throwable then the trace handler may wish to trace a stack trace together with the accompanying error message text.
public void traceMessage(java.lang.Object selfReference, short messageNumber, long groups, java.lang.Object insert1, java.lang.Object insert2, java.lang.Object insert3)
Called by WebSphere MQ Everyplace to output a trace message through the trace handler.
selfReference
- A reference to the object which is issuing the trace.
Will be null if the trace point is not associated with this trace point,
for example, when the trace is generated from within a static method.
If non-null, the class name, and hash code of the object can be obtained to
provide extra information to accompany the other trace information.messageNumber
- The trace message number unique a single point in source
code. Can be mapped to other information relating to this point in the code
using the MQeTracePoint
,
MQeTracePointGroup
and MQeTraceRenderer
classes.groups
- A bitmasked field comprised of one or more MQeTrace.GROUP_*
constants bit-ORed together.
This information can be used to dynamically filter out these course groupings
in a simple way, without having to load the
MQeTraceRenderer
and associated classes.insert1
- A substitution parameter to be substituted for in the
trace template so that a readable text string can be built.
Trace handlers will typically use the toString() method on the object passed, though may choose not to use the information at all if the particular trace information carried by this method is not required.
insert2
- As insert1insert3
- As insert1
If it derived from java.lang.Throwable then the trace handler may wish to trace a stack trace together with the accompanying error message text.
public void traceMessage(java.lang.Object selfReference, short messageNumber, long groups, java.lang.Object insert1, java.lang.Object insert2, java.lang.Object insert3, java.lang.Object insert4)
Called by WebSphere MQ Everyplace to output a trace message through the trace handler.
selfReference
- A reference to the object which is issuing the trace.
Will be null if the trace point is not associated with this trace point,
for example, when the trace is generated from within a static method.
If non-null, the class name, and hash code of the object can be obtained to
provide extra information to accompany the other trace information.messageNumber
- The trace message number unique a single point in source
code. Can be mapped to other information relating to this point in the code
using the MQeTracePoint
,
MQeTracePointGroup
and MQeTraceRenderer
classes.groups
- A bitmasked field comprised of one or more MQeTrace.GROUP_*
constants bit-ORed together.
This information can be used to dynamically filter out these course groupings
in a simple way, without having to load the
MQeTraceRenderer
and associated classes.insert1
- A substitution parameter to be substituted for in the
trace template so that a readable text string can be built.
Trace handlers will typically use the toString() method on the object passed, though may choose not to use the information at all if the particular trace information carried by this method is not required.
insert2
- As insert1insert3
- As insert1insert4
- As insert1
If it derived from java.lang.Throwable then the trace handler may wish to trace a stack trace together with the accompanying error message text.
public void setFilter(long filterMask)
This method is called when the trace filter is changed.
filterMask
- A bitmask indicating which subsets, or groups of trace point
classifications should be captured, and which groups are discarded.
If the filterMask is changed from a zero value to a non-zero value, partial or full tracing has been turned on.
If the filterMask is changed from a non-zero value to a zero value, partial or full tracing has been turned off.
Exact meaning of the filtermask is explained in the documentation for
the MQeTrace
class.
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |