com.ibm.websphere.ras
Interface RasMessage
-
- All Superinterfaces:
- java.io.Serializable
public interface RasMessage extends java.io.Serializable
RasMessage defines the interface for WebSphere ras-generated localized message events that are externalized via the JMX mechanism.
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.String
AUDIT
static java.lang.String
ERROR
static java.lang.String
FATAL
static java.lang.String
INFO
Define a set of message severitiesstatic java.lang.String
SERVICE
static java.lang.String
UNKNOWN
static java.lang.String
WARNING
-
Method Summary
Methods Modifier and Type Method and Description java.lang.String
getLocalizedMessage(java.util.Locale locale)
Return the message represented by this Object in the specified Locale.java.lang.String
getMessageKey()
Return the message key specified by the caller when the message was logged.java.lang.String
getMessageOriginator()
Return the name of the Object that logged this message.java.lang.String
getMessageSeverity()
Return a String indicating the severity of this messagejava.lang.String
getResourceBundleName()
Return the name of the ResourceBundle specified by the caller when the message was logged.java.lang.String
getThreadId()
Return the identifier of the thread that logged this message.long
getTimeStamp()
Return the raw timestamp indicating the time when the message was logged.
-
-
-
Field Detail
-
INFO
static final java.lang.String INFO
Define a set of message severities- See Also:
- Constant Field Values
-
AUDIT
static final java.lang.String AUDIT
- See Also:
- Constant Field Values
-
SERVICE
static final java.lang.String SERVICE
- See Also:
- Constant Field Values
-
WARNING
static final java.lang.String WARNING
- See Also:
- Constant Field Values
-
ERROR
static final java.lang.String ERROR
- See Also:
- Constant Field Values
-
FATAL
static final java.lang.String FATAL
- See Also:
- Constant Field Values
-
UNKNOWN
static final java.lang.String UNKNOWN
- See Also:
- Constant Field Values
-
-
Method Detail
-
getTimeStamp
long getTimeStamp()
Return the raw timestamp indicating the time when the message was logged.- Returns:
- a long raw timestamp value
-
getThreadId
java.lang.String getThreadId()
Return the identifier of the thread that logged this message.- Returns:
- a String representation of the thread identifier.
-
getMessageSeverity
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
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
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
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
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.
-
-