com.ibm.ras

Interface RASIEvent

All Superinterfaces:
java.io.Serializable
All known implementing classes:
RASEvent, RASMessageEvent, RASTraceEvent

Deprecated. As of WAS 6.0, recommend using java.util.logging
  1. public interface RASIEvent
  2. extends java.io.Serializable
RASIEvent defines the methods that must be implemented to contain RAS message or trace data. Within the RAS Toolkit, RASIEvent is implemented by the RASEvent class.

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. 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 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.

Method Detail

getTimeStamp

  1. long getTimeStamp()
Deprecated.
Gets the time at which this event was created.

setTimeStamp

  1. 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.
Parameters:
timeStamp - The event time stamp.

getType

  1. long getType()
Deprecated.
Gets the type of event: "informational message," for example. Specific types are defined by the classes which extend RASEvent.
Returns:
The event type.

setType

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

getText

  1. java.lang.String getText()
Deprecated.
Gets the event text.
Returns:
The event text.

setText

  1. void setText(java.lang.String text)
Deprecated.
Sets the event text.
Parameters:
text - The event text.

getParameters

  1. java.lang.String[] getParameters( )
Deprecated.
Gets the text parameters: Strings to be displayed with the message text.
Returns:
The text parameters.

setParameters

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

getAttribute

  1. java.lang.Object getAttribute(java.lang.String name)
Deprecated.
Gets an attribute that is saved as part of a RAS event.
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. 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.
Parameters:
name - The name of the attribute.
attrib - The attribute associated with the name.

setMessageEvent

  1. void setMessageEvent(boolean flag)
Deprecated.
Sets a flag that that indicates whether this object is classified as a message event or a trace event.
Parameters:
flag - true if this object is a message event and false if it is a trace event.

isMessageEvent

  1. boolean isMessageEvent()
Deprecated.
Determines if this object is a message event or a trace event.
Returns:
true if this object is a message event and false if it is a trace event.

getSupportedTypes

  1. 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.

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. 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.
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. 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.

Parameters:
types - The message or trace mask.
Returns:
The String equivalent of the mask.