|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
MQeTraceHandler
interface class.
Please remove references to this interface from your code, and implement the
MQeTraceHandler interface instead.
All WebSphere MQ Everyplace trace handlers must implement this interface.
Field Summary | |
static short[] |
version
Deprecated. MQe Version. |
Method Summary | |
void |
activate(java.lang.String title,
java.lang.String language)
Deprecated. Called to activate the trace handler. |
void |
addMessage(int msgNumber,
java.lang.String msgText)
Deprecated. Adds a new trace message template. |
void |
addMessage(java.lang.String msgText)
Deprecated. Called to add a new trace message template to the trace handler. |
void |
addMessageBundle(java.lang.String msgBundle)
Deprecated. Adds a bundle of trace message templates. |
void |
close()
Deprecated. Called to close the trace handler and perform any cleanup as appropriate. |
java.lang.String |
getMessage(int msgNumber)
Deprecated. Return the message template for a given message number. |
java.lang.String |
traceMessage(java.lang.String prefix,
int msgNumber,
java.lang.Object insert)
Deprecated. Called to write a trace message to the output stream. |
Field Detail |
public static final short[] version
Method Detail |
public void activate(java.lang.String title, java.lang.String language)
Called to activate the trace handler.
title
- A String to be used as a title for this trace handler or null.language
- A String used to identify the resource bundle to use for
this trace handler.
none
public void addMessage(int msgNumber, java.lang.String msgText) throws java.lang.Exception
Adds a new trace message template.
Called to add a new trace message template to the trace handler. The template should be of the form:
static final Object [][]contents ={ ******************************************************************* * System Messages * * '-' Message * * 'i' Information * * 'w' Warning * * 'e' Error * * 'd' Debug * * * * Application Messages * * ' ' Message * * 'I' Information * * 'W' Warning * * 'E' Error * * 'D' Debug * * * * Message Number * * ':' no modification applied * * ';' RESERVED for create/destroy object * * '+' Log this message via the Log interface * * ' ' ignore -Do not display this message * * * * Message number * * "[nnnnn ]:" syntax for message number of this message * * * * Example: * * "e+[01000 ]:Error #0 occurred" * * "I:[01010 ]:All is wonderful * *******************************************************************
msgNumber
- An integer containing the trace message number to be used
to identify the message template.msgText
- A String containing the trace message template.
none
java.lang.Exception
public void addMessage(java.lang.String msgText) throws java.lang.Exception
Called to add a new trace message template to the trace handler.
The template should be of the form as shown in the above method.
msgText
- A String containing the trace message template.
none
java.lang.Exception
public void addMessageBundle(java.lang.String msgBundle) throws java.lang.Exception
Adds a bundle of trace message templates.
Is called to add a bundle of templates to the trace handler. The templates in the bundle should be of the form:
static final Object [][]contents ={ ******************************************************************* * System Messages * * '-' Message * * 'i' Information * * 'w' Warning * * 'e' Error * * 'd' Debug * * * * Application Messages * * ' ' Message * * 'I' Information * * 'W' Warning * * 'E' Error * * 'D' Debug * * * * Message Number * * ':' no modification applied * * ';' RESERVED for create/destroy object * * '+' Log this message via the Log interface * * ' ' ignore -Do not display this message * * * * Message number * * "[nnnnn ]:" syntax for message number of this message * * * * Example: * * "e+[01000 ]:Error #0 occurred" * * "I:[01010 ]:All is wonderful * *******************************************************************
msgBundle
- A String identifying the bundle of trace messages
templates to be added.
none
java.lang.Exception
public void close()
Called to close the trace handler and perform any cleanup as appropriate.
none
public java.lang.String getMessage(int msgNumber)
Return the message template for a given message number.
Called to get the String that corresponds to the trace message number supplied in the msgNumber parameter.
msgNumber
- The number of the trace message String to be returned.
none
public java.lang.String traceMessage(java.lang.String prefix, int msgNumber, java.lang.Object insert)
Called to write a trace message to the output stream.
Called by WebSphere MQ Everyplace to output a trace message through the trace handler.
prefix
- The calling object name and instance number.msgNumber
- An integer containing the trace message number to be used
to find the message template.insert
- Any inserts to be applied to the message template.
none
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |