com.ibm.commerce.ras

Class MethodLogEvent

java.lang.Object

com.ibm.commerce.ras.MethodLogEvent

Direct Known Subclasses:

MethodEntryLogEvent, MethodExitLogEvent

public class MethodLogEvent
extends java.lang.Object

MethodLogEvent class is used to format the message text for Tracing service.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
MethodLogEvent(java.sql.Timestamp time, java.lang.String thread, IOutputManager outputMgr, java.lang.String aClassName, java.lang.String aMethodName, java.lang.String text) Constructor for MethodLogEvent.
MethodLogEvent(java.sql.Timestamp time, java.lang.String thread, IOutputManager outputMgr, java.lang.String aComponentName, java.lang.String aClassName, java.lang.String aMethodName, java.lang.String text) Constructor for MethodLogEvent.
MethodLogEvent(java.sql.Timestamp time, java.lang.String thread, java.lang.String uniqueClientId, IOutputManager outputMgr, java.lang.String aClassName, java.lang.String aMethodName, java.lang.String text) Constructor for MethodLogEvent.
MethodLogEvent(java.sql.Timestamp time, java.lang.String thread, java.lang.String uniqueClientId, IOutputManager outputMgr, java.lang.String aComponentName, java.lang.String aClassName, java.lang.String aMethodName, java.lang.String text) Constructor for MethodLogEvent.

Method Summary

Modifier and Type	Method and Description
java.lang.String	createMessageBody() Creates the message body.
java.lang.String	getCompactMessageBody() Gets the message body in compact format.
java.lang.String	getMessageBody() Gets the message body in detailed format.
void	print() Print out the message text in specified output manager

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

MethodLogEvent

public MethodLogEvent(java.sql.Timestamp time,
                      java.lang.String thread,
                      IOutputManager outputMgr,
                      java.lang.String aClassName,
                      java.lang.String aMethodName,
                      java.lang.String text)

Constructor for MethodLogEvent.

Parameters:

time - the timestamp of the trace entry

thread - the thread that entry is generated by

outputMgr - output device to write the logs

aClassName - class name that generates the entry

aMethodName - method name that generates the entry

text - the plain text that will be shown in the log file

MethodLogEvent

public MethodLogEvent(java.sql.Timestamp time,
                      java.lang.String thread,
                      IOutputManager outputMgr,
                      java.lang.String aComponentName,
                      java.lang.String aClassName,
                      java.lang.String aMethodName,
                      java.lang.String text)

Constructor for MethodLogEvent.

Parameters:

time - the timestamp of the trace entry

thread - the thread that entry is generated by

outputMgr - output device to write the logs

aComponentName - trace component the entry belongs to

aClassName - class name that generates the entry

aMethodName - method name that generates the entry

text - the plain text that will be shown in the log file

MethodLogEvent

public MethodLogEvent(java.sql.Timestamp time,
                      java.lang.String thread,
                      java.lang.String uniqueClientId,
                      IOutputManager outputMgr,
                      java.lang.String aClassName,
                      java.lang.String aMethodName,
                      java.lang.String text)

Constructor for MethodLogEvent.

Parameters:

time - the timestamp of the trace entry

thread - the thread that entry is generated by

uniqueClientId - the unique Id to represent the client; used to debug double click problem

outputMgr - output device to write the logs

aClassName - class name that generates the entry

aMethodName - method name that generates the entry

text - the plain text that will be shown in the log file

MethodLogEvent

public MethodLogEvent(java.sql.Timestamp time,
                      java.lang.String thread,
                      java.lang.String uniqueClientId,
                      IOutputManager outputMgr,
                      java.lang.String aComponentName,
                      java.lang.String aClassName,
                      java.lang.String aMethodName,
                      java.lang.String text)

Constructor for MethodLogEvent.

Parameters:

time - the timestamp of the trace entry

thread - the thread that entry is generated by

uniqueClientId - the unique Id to represent the client; used to debug double click problem

outputMgr - output device to write the logs

aComponentName - trace component the entry belongs to

aClassName - class name that generates the entry

aMethodName - method name that generates the entry

text - the plain text that will be shown in the log file

Method Detail

createMessageBody

public java.lang.String createMessageBody()

Creates the message body. The message body can be in either detailed or compact format.

Returns:

formatted message body

getCompactMessageBody

public java.lang.String getCompactMessageBody()

Gets the message body in compact format.

Returns:

the message text in compact format

getMessageBody

public java.lang.String getMessageBody()

Gets the message body in detailed format.

Returns:

the message text in detailed format

print

public void print()

Print out the message text in specified output manager