com.ibm.ras
Interface RASIEvent
All Superinterfaces:
java.io.Serializable
All known implementing classes:
Deprecated. As of WAS 6.0, recommend using java.util.logging
- public interface RASIEvent
- 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 |
---|---|
|
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.
|
|
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 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.
|
Method Detail
getTimeStamp
- long getTimeStamp()
Deprecated.
Gets the time at which this event was created.
setTimeStamp
- 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
- 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
- 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
- java.lang.String getText()
Deprecated.
Gets the event text.
Returns:
The event text.
setText
- void setText(java.lang.String text)
Deprecated.
Sets the event text.
Parameters:
text
- The event text. getParameters
- java.lang.String[] getParameters( )
Deprecated.
Gets the text parameters:
Strings
to be displayed with
the message text.
Returns:
The text parameters.
setParameters
- 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
- 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
- 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.
Parameters:
name
- The name of the attribute. attrib
- The attribute associated with the name. setMessageEvent
- 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
- 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
- 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
- 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
- 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.