com.ibm.ras

Class RASEvent

  1. java.lang.Object
  2. extended bycom.ibm.ras.RASEvent
All implemented interfaces:
RASConstants, RASIEvent, java.io.Serializable
Direct known subclasses:
RASMessageEvent, RASTraceEvent

Deprecated. As of WAS 6.0, recommend using java.util.logging
  1. public class RASEvent
  2. extends java.lang.Object
  3. implements RASIEvent, RASConstants
RASEvent is the parent of all RASMessageEvent and RASTraceEvent objects. These classes are used within this RAS system to encapsulate the message and trace data created by an application. An application should not need to use them. They would only be used by a RAS implementation that wishes to extend the function of this RAS Toolkit.

RASEvent contains the following information:

See Also:
RASLogger, Serialized Form

Field Summary

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

Constructor and Description
RASEvent()
Deprecated. Creates a RASEvent.
RASEvent(long type,java.lang.String text,java.lang.Object[] parms)
Deprecated. Creates a RASEvent.
RASEvent(long type,java.lang.String text,java.lang.String[] parms)
Deprecated. Use RASEvent instead.

Method Summary

Modifier and Type Method and Description
  1. java.lang.Object
getAttribute(java.lang.String name)
Deprecated. Gets an attribute that is saved as part of a RAS event.
  1. java.lang.String[]
getParameters()
Deprecated. Gets the text parameters: Strings to be displayed with the message text.
  1. java.util.Hashtable
getSupportedTypes()
Deprecated. Gets the complete set of event types supported by this class.
  1. java.lang.String
getText()
Deprecated. Gets the event text.
  1. long
getTimeStamp()
Deprecated. Gets the time at which this event was created.
  1. long
getType()
Deprecated. Gets the type of event: "informational message," for example.
  1. boolean
isMessageEvent()
Deprecated. Determines if this object is a message event or a trace event.
  1. long
maskLongValue(java.lang.String types)
Deprecated. Converts a String representation of a message or trace mask to its long equivalent.
  1. java.lang.String
maskToString(long types)
Deprecated. Converts a long containing the logical OR of one or more event types to its String equivalent.
  1. protected static
  2. java.lang.String[]
objectsToStrings(java.lang.Object[] parms)
Deprecated. Converts an array of Objects to an array of equivalent Strings.
  1. void
setAttribute(java.lang.String name,java.lang.Object attrib)
Deprecated. Sets an attribute, saving it as part of a RAS event.
  1. void
setMessageEvent(boolean flag)
Deprecated. Sets a flag that indicates whether this object is classified as a message event or a trace event.
  1. void
setParameters(java.lang.String[] parms)
Deprecated. Gets the text parameters: Strings to be displayed with the message text.
  1. void
setText(java.lang.String text)
Deprecated. Sets the event text.
  1. void
setTimeStamp(long timeStamp)
Deprecated. Sets the time at which this event was created.
  1. void
setType(long type)
Deprecated. Sets the type of event: "informational message," for example.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RASEvent

  1. public RASEvent()
Deprecated.
Creates a RASEvent. The time stamp is generated at this time.

RASEvent

  1. public RASEvent(long type,
  2. java.lang.String text,
  3. java.lang.Object[] parms)
Deprecated.
Creates a RASEvent.
Parameters:
type - The message type.
text - The message text, or a message key if the message file is not null.
parms - An array of Objects to be displayed with the message.

RASEvent

  1. public RASEvent(long type,
  2. java.lang.String text,
  3. java.lang.String[] parms)
Deprecated. Use RASEvent instead.
Creates a RASEvent.
Parameters:
type - The message type.
text - The message text, or a message key if the message file is not null.
parms - An array of Strings to be displayed with the message.

Method Detail

objectsToStrings

  1. protected static java.lang.String[] objectsToStrings( java.lang.Object[] parms)
Deprecated.
Converts an array of Objects to an array of equivalent Strings.
Parameters:
parms - An array of objects to be converted to strings.
Returns:
The equivalent array of strings.

getTimeStamp

  1. public long getTimeStamp()
Deprecated.
Gets the time at which this event was created.
Specified by:
getTimeStamp in interface RASIEvent

setTimeStamp

  1. public void setTimeStamp(long timeStamp)
Deprecated.
Sets the time at which this event was created. This value is expected to be of the format returned by System.currentTimeMillis.
Specified by:
setTimeStamp in interface RASIEvent
Parameters:
timeStamp - The event time stamp.

getType

  1. public long getType()
Deprecated.
Gets the type of event: "informational message," for example. Specific types are defined by the classes which extend RASEvent. If a type is not defined, the default value of zero is returned.
Specified by:
getType in interface RASIEvent
Returns:
The event type.

setType

  1. public void setType(long type)
Deprecated.
Sets the type of event: "informational message," for example. Specific types are defined by the classes which extend RASEvent.
Specified by:
setType in interface RASIEvent
Parameters:
type - The event type.

getText

  1. public java.lang.String getText( )
Deprecated.
Gets the event text.
Specified by:
getText in interface RASIEvent
Returns:
The event text.

setText

  1. public void setText(java.lang.String text)
Deprecated.
Sets the event text. If the text is null, the current text is not changed.
Specified by:
setText in interface RASIEvent
Parameters:
text - The event text.

getParameters

  1. public java.lang.String[] getParameters( )
Deprecated.
Gets the text parameters: Strings to be displayed with the message text. If no parameters have been set, null is returned.
Specified by:
getParameters in interface RASIEvent
Returns:
The text parameters.

setParameters

  1. public void setParameters(java.lang.String[] parms)
Deprecated.
Gets the text parameters: Strings to be displayed with the message text.
Specified by:
setParameters in interface RASIEvent
Parameters:
parms - The text parameters.

getAttribute

  1. public java.lang.Object getAttribute( java.lang.String name)
Deprecated.
Gets an attribute that is saved as part of a RAS event.
Specified by:
getAttribute in interface RASIEvent
Parameters:
name - The name of the attribute.
Returns:
The attribute associated with the name or null if the named attribute was not found.

setAttribute

  1. public void setAttribute(java.lang.String name,
  2. java.lang.Object attrib)
Deprecated.
Sets an attribute, saving it as part of a RAS event. If the name or the attribute are null, nothing is saved.
Specified by:
setAttribute in interface RASIEvent
Parameters:
name - The name of the attribute.
attrib - The attribute associated with the name.

setMessageEvent

  1. public void setMessageEvent(boolean flag)
Deprecated.
Sets a flag that indicates whether this object is classified as a message event or a trace event.
Specified by:
setMessageEvent in interface RASIEvent
Parameters:
flag - A boolean set true if this object is a message event and false if it is a trace event.

isMessageEvent

  1. public boolean isMessageEvent()
Deprecated.
Determines if this object is a message event or a trace event.
Specified by:
isMessageEvent in interface RASIEvent
Returns:
true if this object is a message event and false if it is a trace event.

getSupportedTypes

  1. public java.util.Hashtable getSupportedTypes( )
Deprecated.
Gets the complete set of 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.

Specified by:
Returns:
A Hashtable containing the values of all of the event types. The names of the types are used as keys and are returned in the current locale. The type values, normally kept as ints, are returned as Integers because of the Hashtable requirement that all elements be Objects.

maskLongValue

  1. public long maskLongValue(java.lang.String types)
Deprecated.
Converts a String representation of a message or 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.
Specified by:
maskLongValue in interface RASIEvent
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

  1. public java.lang.String maskToString( long types)
Deprecated.
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.

Specified by:
maskToString in interface RASIEvent
Parameters:
types - The message or trace mask.
Returns:
The blank-delimited String equivalent of the mask.