com.ibm.ras
Class RASEvent
- java.lang.Object
com.ibm.ras.RASEvent
All implemented interfaces:
RASConstants, RASIEvent, java.io.Serializable
Direct known subclasses:
Deprecated. As of WAS 6.0, recommend using java.util.logging
- public class RASEvent
- extends java.lang.Object
- 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:
- A flag which identifies this event as a message event or a trace event.
- A time stamp, generated automatically when the event is created.
- A "type" field, which defines the particular flavor of the event.
For example, a message event might be one of "informational," "warning,"
or "error." These types are defined by the extensions to this class. See
RASLogger
for additional information on this important point. - The text of the event.
- An array of run-time parameters which may be inserted into the text or displayed with the text.
- Zero or more additional attributes that are specific to different RAS
event types. These attributes are a set of "key=value" pairs, maintained
in a hashtable by the
RASEvent
class.RASConstants
defines the key names. SeeRASMessageEvent
andRASTraceEvent
for a list of attributes specific to those classes.
See Also:
Field Summary
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 |
---|---|
|
getAttribute(java.lang.String name)
Deprecated. Gets an attribute that is saved as part of a RAS event.
|
|
getParameters()
Deprecated. Gets the text parameters:
Strings to be displayed with
the message text.
|
|
getSupportedTypes()
Deprecated. Gets the complete set of event types supported by this class.
|
|
getText()
Deprecated. Gets the event text.
|
|
getTimeStamp()
Deprecated. Gets the time at which this event was created.
|
|
getType()
Deprecated. Gets the type of event: "informational message," for example.
|
|
isMessageEvent()
Deprecated. Determines if this object is a message event or a trace event.
|
|
maskLongValue(java.lang.String types)
Deprecated. Converts a
String representation of a message or trace
mask to its long equivalent.
|
|
maskToString(long types)
Deprecated. Converts a long containing the logical OR of one or more event types
to its
String equivalent.
|
|
objectsToStrings(java.lang.Object[] parms)
Deprecated. Converts an array of
Objects to an array of equivalent
Strings .
|
|
setAttribute(java.lang.String name,java.lang.Object attrib)
Deprecated. Sets an attribute, saving it as part of a RAS event.
|
|
setMessageEvent(boolean flag)
Deprecated. Sets a flag that indicates whether this object is classified
as a message event or a trace event.
|
|
setParameters(java.lang.String[] parms)
Deprecated. Gets the text parameters:
Strings to be displayed with
the message text.
|
|
setText(java.lang.String text)
Deprecated. Sets the event text.
|
|
setTimeStamp(long timeStamp)
Deprecated. Sets the time at which this event was created.
|
|
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
- public RASEvent()
Deprecated.
RASEvent
- public RASEvent(long type,
- java.lang.String text,
- 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
- public RASEvent(long type,
- java.lang.String text,
- 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
- 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
- public long getTimeStamp()
Deprecated.
Gets the time at which this event was created.
Specified by:
getTimeStamp
in interface RASIEvent
setTimeStamp
- 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
- 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.
Returns:
The event type.
setType
- 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
.
Parameters:
type
- The event type. getText
- public java.lang.String getText( )
Deprecated.
Gets the event text.
Returns:
The event text.
setText
- public void setText(java.lang.String text)
Deprecated.
Sets the event text. If the text is
null
, the current
text is not changed.
Parameters:
text
- The event text. getParameters
- 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
- 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
- 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
- public void setAttribute(java.lang.String name,
- 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
- 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
- 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
- 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:
getSupportedTypes
in interface RASIEvent
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
- 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
- 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.
RASEvent
. The time stamp is generated at this time.