com.ibm.retail.si.mgmt.notifications
Class RtlTracePointNotification

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.management.Notification
              |
              +--com.ibm.retail.si.mgmt.notifications.RtlNotification
                    |
                    +--com.ibm.retail.si.mgmt.notifications.RtlTracePointNotification
All Implemented Interfaces:
java.io.Serializable

public class RtlTracePointNotification
extends RtlNotification

This Notificaiton type is used by the logging component of the General and Master agent for converting locally logged entries to notificaitons that can be forwarded through the centralized notification system. An application should not need to ever instanciate one of these directly. NOTE that timestamp, and sequence number are provided in the base class and should be set too.

Version:
1.00, 10/01/2003
Author:
Paul A. Ruocchio, Kriselie D Rivera
See Also:
Notification, RtlNotification, Serialized Form

Field Summary
 
Fields inherited from class javax.management.Notification
source
 
Constructor Summary
RtlTracePointNotification(java.lang.Object source, java.lang.String Message)
          Creates a new instance of this Notification where the caller supplies both a Message string, and a source Object.
RtlTracePointNotification(java.lang.Object source, java.lang.String Message, java.lang.Object userData)
          Creates a new instance of this Notification where the caller supplies a Message string, a source object, and a user data Object.
 
Method Summary
 java.lang.String getFileName()
           
 int getLevel()
           
 java.lang.String getLineNumber()
           
 java.lang.String getMethodName()
           
 java.lang.String getNdc()
           
 java.lang.String getOriginator()
           
 java.lang.String getSourceClassName()
           
 java.lang.String getTaskName()
           
 int getThreadId()
           
 java.lang.Throwable getThrowable()
           
 void setFileName(java.lang.String string)
           
 void setLevel(int Level)
          Sets the level or severity of the log message.
 void setLineNumber(java.lang.String string)
           
 void setMethodName(java.lang.String string)
           
 void setNdc(java.lang.String ndc)
           
 void setOriginator(java.lang.String originator)
           
 void setSourceClassName(java.lang.String className)
           
 void setTaskName(java.lang.String Name)
           
 void setThreadId(int threadId)
           
 void setThrowable(java.lang.Throwable Thrown)
           
 
Methods inherited from class com.ibm.retail.si.mgmt.notifications.RtlNotification
getOriginatingDevice, GetSystemSequenceNo, GetSystemTimeStamp, setOriginatingDevice, SetSystemSequenceNo, SetSystemTimeStamp
 
Methods inherited from class javax.management.Notification
getMessage, getSequenceNumber, getSource, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RtlTracePointNotification

public RtlTracePointNotification(java.lang.Object source,
                                 java.lang.String Message)
Creates a new instance of this Notification where the caller supplies both a Message string, and a source Object. While extremely useful, care should be taken in using this form of the constructor since the object passed in will be serialized and passed through the Notification sub-system.

Parameters:
source - - the object that has generated this notification.
Message - - a caller provided message.

RtlTracePointNotification

public RtlTracePointNotification(java.lang.Object source,
                                 java.lang.String Message,
                                 java.lang.Object userData)
Creates a new instance of this Notification where the caller supplies a Message string, a source object, and a user data Object. While extremely useful, care should be taken in using this form of the constructor since the objects passed in will be serialized and passed through the Notification sub-system.

Parameters:
source - - the object that has generated this notification.
Message - - a caller provided message.
userData - - a caller supplied data object.
Method Detail

getLevel

public int getLevel()
Returns:
int - The level or severity of the message, as defined by the levels in MgmtLoggingCtrlMBean

setLevel

public void setLevel(int Level)
Sets the level or severity of the log message. Should be obtained from MgmtLoggingCtrlMBean

Parameters:
Level - - int level, from MgmtLoggingCtrlMBean

getTaskName

public java.lang.String getTaskName()
Returns:
String - The name of the task where the message originated, which correspongs to the thread description from log4j, the tag in the message from syslog, or getsourcemethodname on the JDK 1.4 logger

setTaskName

public void setTaskName(java.lang.String Name)
Parameters:
Name - - The name of the task where the log message originated
See Also:
getTaskName()

getOriginator

public java.lang.String getOriginator()
Returns:
String - Identifier indicating the logging category or entity taht logged the message. This corresponds to the Facility on syslog, getcategory() on log4j, and loggername on the JDK 1.4 logger

setOriginator

public void setOriginator(java.lang.String originator)
Parameters:
originator - - Sets the originator for this message
See Also:
getOriginator()

getThrowable

public java.lang.Throwable getThrowable()
Returns:
throwable - For error messages, the associated Throwable (Not used in Syslog)

setThrowable

public void setThrowable(java.lang.Throwable Thrown)
Parameters:
Thrown - - For error messages, the associated Throwable (Not used in Syslog)

getSourceClassName

public java.lang.String getSourceClassName()
Returns:
String - Class that allegedy issued the logging request (JDK and Log4J only)

setSourceClassName

public void setSourceClassName(java.lang.String className)
Parameters:
className - - Class that allegedy issued the logging request (JDK and Log4J only)

getFileName

public java.lang.String getFileName()
Returns:
File name where the event occurred

getLineNumber

public java.lang.String getLineNumber()
Returns:
Line number within the file where the event occurred

getMethodName

public java.lang.String getMethodName()
Returns:
Name of the method where the event occurred

setFileName

public void setFileName(java.lang.String string)
Parameters:
string - File name where the event occurred

setLineNumber

public void setLineNumber(java.lang.String string)
Parameters:
string - Line number within the file where the event occurred

setMethodName

public void setMethodName(java.lang.String string)

getNdc

public java.lang.String getNdc()
Returns:
ndc - The NDC (Nested Diagnostic Context) for this record (Log4J only)

setNdc

public void setNdc(java.lang.String ndc)
Parameters:
ndc - - The NDC (Nested Diagnostic Context) for this record (Log4J only)

getThreadId

public int getThreadId()
Returns:
threadId - Thread identifier from where the message originated (JDK only)

setThreadId

public void setThreadId(int threadId)
Parameters:
threadId - - Thread identifier from where the message originated (JDK only)


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004