com.ibm.websphere.ras

Interface RasMessage

All Superinterfaces:
java.io.Serializable

  1. public interface RasMessage
  2. extends java.io.Serializable
RasMessage defines the interface for WebSphere ras-generated localized message events that are externalized via the JMX mechanism.

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
AUDIT
  1. static
  2. java.lang.String
ERROR
  1. static
  2. java.lang.String
FATAL
  1. static
  2. java.lang.String
INFO
Define a set of message severities
  1. static
  2. java.lang.String
SERVICE
  1. static
  2. java.lang.String
UNKNOWN
  1. static
  2. java.lang.String
WARNING

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getLocalizedMessage(java.util.Locale locale)
Return the message represented by this Object in the specified Locale.
  1. java.lang.String
getMessageKey()
Return the message key specified by the caller when the message was logged.
  1. java.lang.String
getMessageOriginator()
Return the name of the Object that logged this message.
  1. java.lang.String
getMessageSeverity()
Return a String indicating the severity of this message
  1. java.lang.String
getResourceBundleName()
Return the name of the ResourceBundle specified by the caller when the message was logged.
  1. java.lang.String
getThreadId()
Return the identifier of the thread that logged this message.
  1. long
getTimeStamp()
Return the raw timestamp indicating the time when the message was logged.

Field Detail

INFO

  1. static final java.lang.String INFO
Define a set of message severities
See Also:

AUDIT

  1. static final java.lang.String AUDIT
See Also:

SERVICE

  1. static final java.lang.String SERVICE
See Also:

WARNING

  1. static final java.lang.String WARNING
See Also:

ERROR

  1. static final java.lang.String ERROR
See Also:

FATAL

  1. static final java.lang.String FATAL
See Also:

UNKNOWN

  1. static final java.lang.String UNKNOWN
See Also:

Method Detail

getTimeStamp

  1. long getTimeStamp()
Return the raw timestamp indicating the time when the message was logged.

Returns:
a long raw timestamp value

getThreadId

  1. java.lang.String getThreadId()
Return the identifier of the thread that logged this message.

Returns:
a String representation of the thread identifier.

getMessageSeverity

  1. java.lang.String getMessageSeverity( )
Return a String indicating the severity of this message

Returns:
a non-null String indicating the message severity. The String will be one of the values defined above in this class.

getMessageKey

  1. java.lang.String getMessageKey( )
Return the message key specified by the caller when the message was logged.

Returns:
the String passed by the caller when the message was logged. If the caller passed null, Ras has generated a non-null String. Null is never returned.

getResourceBundleName

  1. java.lang.String getResourceBundleName( )
Return the name of the ResourceBundle specified by the caller when the message was logged.

Returns:
the name of the ResourceBundle that was set when this MessageEvent was created. This value may be null if the caller passed null, or if the caller has already localized the message.

getMessageOriginator

  1. java.lang.String getMessageOriginator( )
Return the name of the Object that logged this message.

Returns:
the name the caller registered with. May be null.

getLocalizedMessage

  1. java.lang.String getLocalizedMessage( java.util.Locale locale)
Return the message represented by this Object in the specified Locale.

Parameters:
locale - the Locale to use when looking up the ResourceBundle to retrieve the message text. Must not be null.
Returns:
a non-null message. If an error occurs during localization, a message is generated. This message may simply be the message key.