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
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 theRASEvent
class.
-
-
Method Summary
Methods Modifier and Type Method and Description java.lang.Object
getAttribute(java.lang.String name)
Deprecated.Gets an attribute that is saved as part of a RAS event.java.lang.String[]
getParameters()
Deprecated.Gets the text parameters:Strings
to be displayed with the message text.java.util.Hashtable
getSupportedTypes()
Deprecated.Gets the complete set of event types supported by this class.java.lang.String
getText()
Deprecated.Gets the event text.long
getTimeStamp()
Deprecated.Gets the time at which this event was created.long
getType()
Deprecated.Gets the type of event: "informational message," for example.boolean
isMessageEvent()
Deprecated.Determines if this object is a message event or a trace event.long
maskLongValue(java.lang.String types)
Deprecated.Converts aString
representation of a message or trace mask to itslong
equivalent.java.lang.String
maskToString(long types)
Deprecated.Converts a long containing the logical OR of one or more event types to itsString
equivalent.void
setAttribute(java.lang.String name, java.lang.Object attrib)
Deprecated.Sets an attribute, saving it as part of a RAS event.void
setMessageEvent(boolean flag)
Deprecated.Sets a flag that that indicates whether this object is classified as a message event or a trace event.void
setParameters(java.lang.String[] parms)
Deprecated.Gets the text parameters:Strings
to be displayed with the message text.void
setText(java.lang.String text)
Deprecated.Sets the event text.void
setTimeStamp(long timeStamp)
Deprecated.Sets the time at which this event was created.void
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.- Parameters:
timeStamp
- The event time stamp, as generated bySystem.currentTimeMillis
.
-
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 bySystem.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 extendRASEvent
.- 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 extendRASEvent
.- 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 arenull
, 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 andfalse
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 andfalse
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 asints
, are returned asIntegers
because of theHashtable
requirement that all elements beObjects
.
-
maskLongValue
long maskLongValue(java.lang.String types)
Deprecated.Converts aString
representation of a message or trace mask to itslong
equivalent. The string must have the following format:String types = "TYPE_INFO TYPE_WARN";
Unknown values in theString
are ignored.- Parameters:
types
- The blank-delimitedString
to be converted.- Returns:
- The long equivalent of the
String
, formed by the logical OR of each element in theString
.
-
maskToString
java.lang.String maskToString(long types)
Deprecated.Converts a long containing the logical OR of one or more event types to itsString
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.
-
-