com.ibm.websphere.ras
Interface RasMessage
All Superinterfaces:
java.io.Serializable
- public interface RasMessage
- extends java.io.Serializable
Field Summary
Modifier and Type | Field and Description |
---|---|
|
AUDIT
|
|
ERROR
|
|
FATAL
|
|
INFO
Define a set of message severities
|
|
SERVICE
|
|
UNKNOWN
|
|
WARNING
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getLocalizedMessage(java.util.Locale locale)
Return the message represented by this Object in the specified Locale.
|
|
getMessageKey()
Return the message key specified by the caller when the message was logged.
|
|
getMessageOriginator()
Return the name of the Object that logged this message.
|
|
getMessageSeverity()
Return a String indicating the severity of this message
|
|
getResourceBundleName()
Return the name of the ResourceBundle specified by the caller when the message was logged.
|
|
getThreadId()
Return the identifier of the thread that logged this message.
|
|
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:
AUDIT
- static final java.lang.String AUDIT
See Also:
SERVICE
- static final java.lang.String SERVICE
See Also:
WARNING
- static final java.lang.String WARNING
See Also:
ERROR
- static final java.lang.String ERROR
See Also:
FATAL
- static final java.lang.String FATAL
See Also:
UNKNOWN
- static final java.lang.String UNKNOWN
See Also:
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.