com.ibm.ras
Class RASMessageEvent

java.lang.Object
  |
  +--com.ibm.ras.RASEvent
        |
        +--com.ibm.ras.RASMessageEvent
All Implemented Interfaces:
RASConstants, RASIEvent, RASIMessageEvent, java.io.Serializable

public class RASMessageEvent
extends RASEvent
implements RASIMessageEvent

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:

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 RASIMessageEvent.DEFAULT_MESSAGE_MASK contains the message types that the handlers log by default. It includes all message types.

See Also:
RASEvent, Serialized Form

Fields inherited from interface com.ibm.ras.RASIMessageEvent
ALL_MESSAGE_MASK, DEFAULT_MESSAGE_MASK, TYPE_ERR, TYPE_ERROR, TYPE_INFO, TYPE_INFORMATION, TYPE_WARN, TYPE_WARNING
 
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
  RASMessageEvent()
          Creates a RASMessageEvent.
protected RASMessageEvent(long type, java.lang.String text, java.lang.Object[] parms, java.lang.String messageFile)
          Creates a RASMessageEvent.
  RASMessageEvent(long type, java.lang.String text, java.lang.Object[] parms, java.lang.String messageFile, java.lang.String loggingClass, java.lang.String loggingMethod, java.lang.String org, java.lang.String prod, java.lang.String comp, java.lang.String server, java.lang.String client, java.lang.Throwable exception)
          Creates a RASMessageEvent.
protected RASMessageEvent(long type, java.lang.String text, java.lang.String[] parms, java.lang.String messageFile)
          Deprecated. Use RASMessageEvent instead.
  RASMessageEvent(long type, java.lang.String text, java.lang.String[] parms, java.lang.String messageFile, java.lang.String loggingClass, java.lang.String loggingMethod, java.lang.String org, java.lang.String prod, java.lang.String comp, java.lang.String server, java.lang.String client, java.lang.Throwable exception)
          Deprecated. Use RASMessageEvent instead.
 
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.
 long maskLongValue(java.lang.String types)
          Converts a String representation of a message or trace mask to its long equivalent.
 java.lang.String maskToString(long types)
          Converts a long containing the logical OR of one or more event types to its String equivalent.
 void setMessageFile(java.lang.String messageFile)
          Sets the base message file name used to format a message.
 java.lang.String toString()
          Returns a String representation of this object.
 
Methods inherited from class com.ibm.ras.RASEvent
getAttribute, getParameters, getText, getTimeStamp, getType, isMessageEvent, objectsToStrings, setAttribute, setMessageEvent, setParameters, setText, setTimeStamp, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RASMessageEvent

public RASMessageEvent()
Creates a RASMessageEvent.

RASMessageEvent

protected RASMessageEvent(long type,
                          java.lang.String text,
                          java.lang.Object[] parms,
                          java.lang.String messageFile)
Creates a RASMessageEvent.
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.
messageFile - The base message file name.

RASMessageEvent

protected RASMessageEvent(long type,
                          java.lang.String text,
                          java.lang.String[] parms,
                          java.lang.String messageFile)
Deprecated. Use RASMessageEvent instead.

Creates a RASMessageEvent.
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.
messageFile - The base message file name.

RASMessageEvent

public RASMessageEvent(long type,
                       java.lang.String text,
                       java.lang.Object[] parms,
                       java.lang.String messageFile,
                       java.lang.String loggingClass,
                       java.lang.String loggingMethod,
                       java.lang.String org,
                       java.lang.String prod,
                       java.lang.String comp,
                       java.lang.String server,
                       java.lang.String client,
                       java.lang.Throwable exception)
Creates a 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.
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.
messageFile - The base message file name.
loggingClass - The class.
loggingMethod - The method.
org - The organization.
prod - The product.
comp - The component.
server - The server.
client - The client.
exception - A Throwable object.

RASMessageEvent

public RASMessageEvent(long type,
                       java.lang.String text,
                       java.lang.String[] parms,
                       java.lang.String messageFile,
                       java.lang.String loggingClass,
                       java.lang.String loggingMethod,
                       java.lang.String org,
                       java.lang.String prod,
                       java.lang.String comp,
                       java.lang.String server,
                       java.lang.String client,
                       java.lang.Throwable exception)
Deprecated. Use RASMessageEvent instead.

Creates a 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.
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.
messageFile - The base message file name.
loggingClass - The class.
loggingMethod - The method.
org - The organization.
prod - The product.
comp - The component.
server - The server.
client - The client.
exception - A Throwable object.
Method Detail

getMessageFile

public java.lang.String getMessageFile()
Gets the base message file name used to format a message.
Returns:
A message file name.

setMessageFile

public void setMessageFile(java.lang.String messageFile)
Sets the base message file name used to format a message.
Parameters:
messageFile - The message file name.

getSupportedTypes

public java.util.Hashtable getSupportedTypes()
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.

Overrides:
getSupportedTypes in class RASEvent
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 longs, are returned as Longs because of the Hashtable requirement that all elements be Objects.

maskLongValue

public long maskLongValue(java.lang.String types)
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.
Overrides:
maskLongValue in class RASEvent
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)
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.

Overrides:
maskToString in class RASEvent
Parameters:
types - The message or trace mask.
Returns:
The String equivalent of the mask.

toString

public java.lang.String toString()
Returns a String representation of this object.
Overrides:
toString in class java.lang.Object
Returns:
A representation of this object.