Websphere MQ Everyplace

com.ibm.mqe
Interface MQeTraceInterface


Deprecated. This interface class is being replaced by the MQeTraceHandler interface class. Please remove references to this interface from your code, and implement the MQeTraceHandler interface instead.

public interface MQeTraceInterface

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

version

public static final short[] version
Deprecated. 
MQe Version.

Method Detail

activate

public void activate(java.lang.String title,
                     java.lang.String language)
Deprecated. 

Called to activate the trace handler.

Parameters:
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.
Returns:
void
Throws:
none

addMessage

public void addMessage(int msgNumber,
                       java.lang.String msgText)
                throws java.lang.Exception
Deprecated. 

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                                    *
 *******************************************************************
 

Parameters:
msgNumber - An integer containing the trace message number to be used to identify the message template.
msgText - A String containing the trace message template.
Returns:
void
Throws:
none
java.lang.Exception

addMessage

public void addMessage(java.lang.String msgText)
                throws java.lang.Exception
Deprecated. 

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.

Parameters:
msgText - A String containing the trace message template.
Returns:
void
Throws:
none
java.lang.Exception

addMessageBundle

public void addMessageBundle(java.lang.String msgBundle)
                      throws java.lang.Exception
Deprecated. 

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                                    *
 *******************************************************************
 

Parameters:
msgBundle - A String identifying the bundle of trace messages templates to be added.
Returns:
void
Throws:
none
java.lang.Exception

close

public void close()
Deprecated. 

Called to close the trace handler and perform any cleanup as appropriate.

Returns:
void
Throws:
none

getMessage

public java.lang.String getMessage(int msgNumber)
Deprecated. 

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.

Parameters:
msgNumber - The number of the trace message String to be returned.
Returns:
A String containing the trace message template.
Throws:
none

traceMessage

public 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.

Called by WebSphere MQ Everyplace to output a trace message through the trace handler.

Parameters:
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.
Returns:
A String containing the expanded trace message text.
Throws:
none

Websphere MQ Everyplace