com.ibm.commerce.ras
Class MethodLogEvent

java.lang.Object
  |
  +--com.ibm.commerce.ras.LogEvent
        |
        +--com.ibm.commerce.ras.MethodLogEvent
Direct Known Subclasses:
MethodEntryLogEvent, MethodExitLogEvent

public class MethodLogEvent
extends com.ibm.commerce.ras.LogEvent

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


Field Summary
protected  java.lang.String className
           
protected  java.lang.String clientId
           
protected  java.lang.String componentName
           
static java.lang.String COPYRIGHT
           
protected  java.lang.String message
           
protected  java.lang.String methodName
           
 
Constructor Summary
MethodLogEvent(java.sql.Timestamp time, java.lang.String thread, IOutputManager outputMgr, java.lang.String aClassName, java.lang.String aMethodName, java.lang.String text)
          MethodLogEvent constructor
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)
          MethodLogEvent constructor
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)
          MethodLogEvent constructor
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)
          MethodLogEvent constructor
 
Method Summary
protected  java.lang.String createCompactMessageHeader()
          Create the message header in compact format
 java.lang.String createMessageBody()
          Create the message body.
protected  java.lang.String createMessageFooter()
          Create the message footer
protected  java.lang.String createMessageHeader()
          Create the message header
protected  java.lang.String doCreateHeaderExtention()
          Create header extention
 java.lang.String getCompactMessageBody()
          Build the message body in compact format.
protected  java.lang.String getMessage()
          Retrieve the message text
 java.lang.String getMessageBody()
          Build the message body.
protected  boolean isCompactFormat()
          Check if the compact format is used
 void print()
          Print out the message text in specified output manager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

className

protected java.lang.String className

clientId

protected java.lang.String clientId

componentName

protected java.lang.String componentName

COPYRIGHT

public static final java.lang.String COPYRIGHT

message

protected java.lang.String message

methodName

protected java.lang.String methodName
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)
MethodLogEvent constructor
Parameters:
Timestamp - time
String - thread
IOutputManager - output manager
String - class name
String - method name
String - text

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)
MethodLogEvent constructor
Parameters:
Timestamp - time
String - thread
IOutputManager - output manager
String - component name
String - class name
String - method name
String - text

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)
MethodLogEvent constructor
Parameters:
Timestamp - time
String - thread
String - unique client Id
IOutputManager - output manager
String - class name
String - method name
String - text

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)
MethodLogEvent constructor
Parameters:
Timestamp - time
String - thread
String - unique client Id
IOutputManager - output manager
String - component name
String - class name
String - method name
String - text
Method Detail

createMessageBody

public java.lang.String createMessageBody()
Create the message body.
Overrides:
createMessageBody in class com.ibm.commerce.ras.LogEvent

getCompactMessageBody

public java.lang.String getCompactMessageBody()
Build the message body in compact format.

getMessageBody

public java.lang.String getMessageBody()
Build the message body.

createCompactMessageHeader

protected java.lang.String createCompactMessageHeader()
Create the message header in compact format

createMessageFooter

protected java.lang.String createMessageFooter()
Create the message footer

createMessageHeader

protected java.lang.String createMessageHeader()
Create the message header

doCreateHeaderExtention

protected java.lang.String doCreateHeaderExtention()
Create header extention

getMessage

protected java.lang.String getMessage()
Retrieve the message text

isCompactFormat

protected boolean isCompactFormat()
Check if the compact format is used

print

public void print()
Print out the message text in specified output manager