com.ibm.ras
Class RASTraceEvent

java.lang.Object
  |
  +--com.ibm.ras.RASEvent
        |
        +--com.ibm.ras.RASTraceEvent
All Implemented Interfaces:
RASConstants, RASIEvent, RASITraceEvent, java.io.Serializable

public class RASTraceEvent
extends RASEvent
implements RASITraceEvent

RASTraceEvent encapsulates all of the information generated by RASTraceLogger. It is not necessary to create a RASTraceEvent directly, as the RASTraceLogger handles this task. However, the methods of this class are public, should it be necessary to extend RASTraceEvent.

A RASTraceEvent object contains the following components:

The RASTraceEvent type is defined by the set of RASITraceEvent TYPE_XXXX constants. Values 0x000000 up to, but not including, 0x100000L are reserved. Extensions to the RASTraceEvent class may use values outside this range for additional types. The constant RASITraceEvent.DEFAULT_TRACE_MASK contains the set of RASTraceEvent types that the handlers will log by default. The default mask is defined as follows:

 public static final long DEFAULT_TRACE_MASK = 
   TYPE_API |
   TYPE_CALLBACK |
   TYPE_ENTRY_EXIT |
   TYPE_ERROR_EXC |
   TYPE_MISC_DATA |
   TYPE_OBJ_CREATE |
   TYPE_OBJ_DELETE |
   TYPE_PRIVATE |
   TYPE_PUBLIC |
   TYPE_STATIC |
   TYPE_SVC;
 

See Also:
RASEvent, Serialized Form

Fields inherited from interface com.ibm.ras.RASITraceEvent
ALL_TRACE_MASK, DEFAULT_TRACE_MASK, TYPE_API, TYPE_CALLBACK, TYPE_ENTRY_EXIT, TYPE_ERROR_EXC, TYPE_LEVEL1, TYPE_LEVEL2, TYPE_LEVEL3, TYPE_MISC_DATA, TYPE_OBJ_CREATE, TYPE_OBJ_DELETE, TYPE_PERF, TYPE_PRIVATE, TYPE_PUBLIC, TYPE_STATIC, TYPE_SVC
 
Fields inherited from interface com.ibm.ras.RASConstants
KEY_CLASS_NAME, KEY_CLIENT, KEY_COMPONENT, KEY_DATE_FORMAT, KEY_DEFAULT_HANDLERS, KEY_DEFAULT_MESSAGE_HANDLERS, KEY_DEFAULT_TRACE_HANDLERS, KEY_DESCRIPTION, KEY_ENCODING, KEY_EXCEPTION, KEY_EXCEPTION_TRACE, KEY_FILE_NAME, KEY_FORMATTER_NAMES, KEY_GROUP, KEY_HANDLER_NAMES, KEY_HEX_DATA, KEY_IS_CIRCULAR, KEY_IS_LOGGING, KEY_IS_SYNC, KEY_LOGGER, KEY_LOGGING_CLASS, KEY_LOGGING_METHOD, KEY_MAX_FILE_SIZE, KEY_MAX_FILES, KEY_MAX_QUEUE_SIZE, KEY_MESSAGE_EVENT_CLASSES, KEY_MESSAGE_FILE, KEY_MESSAGE_MASK, KEY_NAME, KEY_ORGANIZATION, KEY_PRODUCT, KEY_RETRY_INTERVAL, KEY_SEPARATOR, KEY_SERVER, KEY_SOCKET_PORT, KEY_SOCKET_SERVER, KEY_SUPPRESSED_KEYS, KEY_THREAD_ID, KEY_TIME_FORMAT, KEY_TRACE_EVENT_CLASSES, KEY_TRACE_MASK, RAS_VERSION
 
Constructor Summary
  RASTraceEvent()
          Creates a RASTraceEvent object.
protected RASTraceEvent(long type, java.lang.String text, java.lang.Object[] parms)
          Creates a RASTraceEvent object.
  RASTraceEvent(long type, java.lang.String text, java.lang.Object[] parms, java.lang.String loggingClass, java.lang.String loggingMethod, RASITraceLogger logger, java.lang.String server, java.lang.String client, java.lang.Throwable exception)
          Creates a RASTraceEvent object.
protected RASTraceEvent(long type, java.lang.String text, java.lang.String[] parms)
          Deprecated. Use RASTraceEvent instead.
  RASTraceEvent(long type, java.lang.String text, java.lang.String[] parms, java.lang.String loggingClass, java.lang.String loggingMethod, RASITraceLogger logger, java.lang.String server, java.lang.String client, java.lang.Throwable exception)
          Deprecated. Use RASTraceEvent instead.
  RASTraceEvent(long type, java.lang.String loggingClass, java.lang.String loggingMethod, RASITraceLogger logger, java.lang.String server, java.lang.String client, byte[] data)
          Creates a RASTraceEvent object.
 
Method Summary
 java.util.Hashtable getSupportedTypes()
          Gets the complete set of trace event types supported by this class.
 long maskLongValue(java.lang.String types)
          Converts a String representation of a trace mask to its long equivalent.
 java.lang.String maskToString(long types)
          Converts a long containing the logical OR of one or more event types to its String equivalent.
 java.lang.String toString()
          Returns a String representation of this object.
 
Methods inherited from class com.ibm.ras.RASEvent
getAttribute, getParameters, getText, getTimeStamp, getType, isMessageEvent, objectsToStrings, setAttribute, setMessageEvent, setParameters, setText, setTimeStamp, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RASTraceEvent

public RASTraceEvent()
Creates a RASTraceEvent object.

RASTraceEvent

protected RASTraceEvent(long type,
                        java.lang.String text,
                        java.lang.Object[] parms)
Creates a RASTraceEvent object.
Parameters:
type - The type of trace event.
text - The trace text.
parms - An array of Objects to be displayed with the trace text.

RASTraceEvent

protected RASTraceEvent(long type,
                        java.lang.String text,
                        java.lang.String[] parms)
Deprecated. Use RASTraceEvent instead.

Creates a RASTraceEvent object.
Parameters:
type - The type of trace event.
text - The trace text.
parms - An array of Strings to be displayed with the trace text.

RASTraceEvent

public RASTraceEvent(long type,
                     java.lang.String text,
                     java.lang.Object[] parms,
                     java.lang.String loggingClass,
                     java.lang.String loggingMethod,
                     RASITraceLogger logger,
                     java.lang.String server,
                     java.lang.String client,
                     java.lang.Throwable exception)
Creates a RASTraceEvent object.
Parameters:
type - The type of trace event.
text - The trace text.
parms - An array of Objects to be displayed with the trace text.
loggingClass - The class.
loggingMethod - The method.
logger - The RASITraceLogger which created this RASTraceEvent.
server - The server.
client - The client.
exception - A Throwable object.

RASTraceEvent

public RASTraceEvent(long type,
                     java.lang.String text,
                     java.lang.String[] parms,
                     java.lang.String loggingClass,
                     java.lang.String loggingMethod,
                     RASITraceLogger logger,
                     java.lang.String server,
                     java.lang.String client,
                     java.lang.Throwable exception)
Deprecated. Use RASTraceEvent instead.

Creates a RASTraceEvent object.
Parameters:
type - The type of trace event.
text - The trace text.
parms - An array of Strings to be displayed with the trace text.
loggingClass - The class.
loggingMethod - The method.
logger - The RASITraceLogger which created this RASTraceEvent.
server - The server.
client - The client.
exception - A Throwable object.

RASTraceEvent

public RASTraceEvent(long type,
                     java.lang.String loggingClass,
                     java.lang.String loggingMethod,
                     RASITraceLogger logger,
                     java.lang.String server,
                     java.lang.String client,
                     byte[] data)
Creates a RASTraceEvent object.
Parameters:
type - The type of trace event.
loggingClass - The class.
loggingMethod - The method.
logger - The RASITraceLogger which created this RASTraceEvent.
server - The server.
client - The client.
data - An array of bytes.
Method Detail

getSupportedTypes

public java.util.Hashtable getSupportedTypes()
Gets the complete set of trace event types supported by this class.

This method can be used by a graphical log manager to display the set of types and allow a user to select those to be monitored. Every extending class should override this method to add the types it supports to the Hashtable returned by its parent.

Overrides:
getSupportedTypes in class RASEvent
Returns:
A Hashtable containing the values of all of the trace event types. The names of the types are used as keys and are returned in the current locale. The type values, normally kept as longs, are returned as Longs because of the Hashtable requirement that all elements be Objects.

maskLongValue

public long maskLongValue(java.lang.String types)
Converts a String representation of a trace mask to its long equivalent. The string must have the following format:
 String types = "TYPE_INFO TYPE_WARN";
 
Unknown values in the String are ignored.
Overrides:
maskLongValue in class RASEvent
Parameters:
types - The blank-delimited String to be converted.
Returns:
The long equivalent of the String, formed by the logical OR of each element in the String.

maskToString

public java.lang.String maskToString(long types)
Converts a long containing the logical OR of one or more event types to its String equivalent. The string will have the following format:
 String types = "TYPE_INFO TYPE_WARN";
 
Every extending class should override this method to add the types it supports to the value returned by its parent.

Unknown values in the long are ignored.

Overrides:
maskToString in class RASEvent
Parameters:
types - The trace mask.
Returns:
The String equivalent of the mask.

toString

public java.lang.String toString()
Returns a String representation of this object.
Overrides:
toString in class java.lang.Object
Returns:
A representation of this object.