com.ibm.ras
Class RASEvent
- java.lang.Object
-
- com.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
public class RASEvent extends java.lang.Object implements RASIEvent, RASConstants
RASEvent
is the parent of allRASMessageEvent
andRASTraceEvent
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:
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
Constructors Constructor and Description RASEvent()
Deprecated.Creates aRASEvent
.RASEvent(long type, java.lang.String text, java.lang.Object[] parms)
Deprecated.Creates aRASEvent
.RASEvent(long type, java.lang.String text, java.lang.String[] parms)
Deprecated.UseRASEvent
instead.
-
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.protected static java.lang.String[]
objectsToStrings(java.lang.Object[] parms)
Deprecated.Converts an array ofObjects
to an array of equivalentStrings
.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 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.
-
-
-
Constructor Detail
-
RASEvent
public RASEvent()
Deprecated.Creates aRASEvent
. The time stamp is generated at this time.- Parameters:
source
- TheObject
which created this event.
-
RASEvent
public RASEvent(long type, java.lang.String text, java.lang.Object[] parms)
Deprecated.Creates aRASEvent
.- Parameters:
type
- The message type.text
- The message text, or a message key if the message file is notnull
.parms
- An array ofObjects
to be displayed with the message.
-
RASEvent
public RASEvent(long type, java.lang.String text, java.lang.String[] parms)
Deprecated. UseRASEvent
instead.Creates aRASEvent
.- Parameters:
type
- The message type.text
- The message text, or a message key if the message file is notnull
.parms
- An array ofStrings
to be displayed with the message.
-
-
Method Detail
-
objectsToStrings
protected static java.lang.String[] objectsToStrings(java.lang.Object[] parms)
Deprecated.Converts an array ofObjects
to an array of equivalentStrings
.- 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 interfaceRASIEvent
- Parameters:
timeStamp
- The event time stamp, as generated bySystem.currentTimeMillis
.
-
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 bySystem.currentTimeMillis
.- Specified by:
setTimeStamp
in interfaceRASIEvent
- 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 extendRASEvent
. If a type is not defined, the default value of zero is returned.
-
setType
public void setType(long type)
Deprecated.Sets the type of event: "informational message," for example. Specific types are defined by the classes which extendRASEvent
.
-
getText
public java.lang.String getText()
Deprecated.Gets the event text.
-
setText
public void setText(java.lang.String text)
Deprecated.Sets the event text. If the text isnull
, the current text is not changed.
-
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 interfaceRASIEvent
- 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 interfaceRASIEvent
- 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 interfaceRASIEvent
- 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 arenull
, nothing is saved.- Specified by:
setAttribute
in interfaceRASIEvent
- 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 interfaceRASIEvent
- Parameters:
flag
- Aboolean
settrue
if this object is a message event andfalse
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 interfaceRASIEvent
- Returns:
true
if this object is a message event andfalse
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 interfaceRASIEvent
- 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
public 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.- Specified by:
maskLongValue
in interfaceRASIEvent
- 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
public 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.- Specified by:
maskToString
in interfaceRASIEvent
- Parameters:
types
- The message or trace mask.- Returns:
- The blank-delimited
String
equivalent of the mask.
-
-