|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.ras.RASEvent | +--com.ibm.ras.RASMessageEvent
A RASMessageEvent
encapsulates all of the information generated
by a RASMessageLogger
. It is not necessary
to create a RASMessageEvent
directly, as the message logger
handles this task. However, the methods of this class are public, should
it be necessary to extend RASMessageEvent
.
A RASMessageEvent
contains the following components:
Strings
which can be displayed with the
message text. These parameters are required only if the message expects them.
Objects
associated with the attributes are Strings
.
"className" The name of the Java class which generated the
message.
"methodName" The name of the Java method which generated the
message.
"organization" The name of the organization which owns the
application that created the message.
"product" The name of the product that created the
message.
"component" The name of the component within the product
that created the message.
"server" A server associated with the creation of the
message.
"client" The client on whose behalf the message was created.
"exception" An Exception
.
The RASMessageEvent
type is defined by the set of
RASIMessageEvent.TYPE_XXXX
constants.
Values 0x0000L up to, but not including, 0x01000L are reserved.
Extensions to the RASMessageEvent
class may use values outside
this range for additional types. The constant DEFAULT_MESSAGE_MASK
contains the message types that the handlers log by default. It includes all
message types.
RASEvent
,
RASMessageLogger
,
RASHandler
, Serialized FormConstructor Summary | |
RASMessageEvent(long type,
java.lang.String text,
java.lang.String[] parms,
java.lang.String messageFile,
java.lang.String className,
java.lang.String methodName,
java.lang.String org,
java.lang.String prod,
java.lang.String comp,
java.lang.String server,
java.lang.String client,
java.lang.Exception exception)
Creates a RASMessageEvent . |
Method Summary | |
java.lang.String |
getMessageFile()
Gets the base message file name used to format a message. |
java.util.Hashtable |
getSupportedTypes()
Gets the complete set of event types supported by this class. |
static long |
maskLongValue(java.lang.String types)
Converts a String representation of the message mask
to its long equivalent. |
static java.lang.String |
maskToString(long types)
Converts a long containing the logical OR of one or more RASIMessageEvent.TYPE_XXXX constants to its String
equivalent. |
void |
setMessageFile(java.lang.String messageFile)
Sets the base message file name used to format a message. |
Methods inherited from class com.ibm.ras.RASEvent |
getAttribute,
getParameters,
getText,
getTimeStamp,
getType,
isMessageEvent,
setAttribute,
setMessageEvent,
setParameters,
setText,
setTimeStamp,
setType |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public RASMessageEvent(long type, java.lang.String text, java.lang.String[] parms, java.lang.String messageFile, java.lang.String className, java.lang.String methodName, java.lang.String org, java.lang.String prod, java.lang.String comp, java.lang.String server, java.lang.String client, java.lang.Exception exception)
RASMessageEvent
. The caller is expected to provide
a message type, key and, if needed, any Object
parameters for
the message text. If any of the other parameters are not needed, they
must be set to an empty string ("") or null
.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.messageFile
- The base message file name.className
- The class.methodName
- The method.org
- The organization.prod
- The product.comp
- The component.server
- The server.client
- The client.exception
- An exception.Method Detail |
public java.lang.String getMessageFile()
public void setMessageFile(java.lang.String messageFile)
messageFile
- The message file names.public java.util.Hashtable getSupportedTypes()
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.
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 longs
, are returned as
Longs
because of the Hashtable
requirement that all elements be Objects
.public static long maskLongValue(java.lang.String types)
String
representation of the message mask
to its long equivalent. The string must have the following format:
String types = "TYPE_INFO TYPE_WARN";DEFAULT_MESSAGE_MASK may also be included in the string. (These values are the names of the
RASIMessageEvent.TYPE_XXXX
constants.)
Every extending class should override this method to add the types it
supports to the value returned by its parent.
Unknown values in the String
are ignored.
types
- The blank-delimited String
to be converted.String
, formed by
the logical OR of each element in the String
.public static java.lang.String maskToString(long types)
RASIMessageEvent.TYPE_XXXX
constants 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.
types
- The message mask.String
equivalent of the message mask.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |