com.ibm.wsspi.rasdiag
Interface DiagnosticEvent
All Superinterfaces:
java.io.Serializable
- public interface DiagnosticEvent
- extends java.io.Serializable
DiagnosticEvent
interface is an interface that must be implemented by any class
that wants to use the DiagnosticProvider infrastructure. The infrastructure uses the
CommonBaseEventDiagnosticEventImpl
which wraps a CommonBaseEvent.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
CONTENT_TYPE_CBE_101
The content type for DiagnosticEvents whose content is a Common Base Event
|
|
EVENT_SERVER_DETAIL
DiagnosticEvent implementation suffix for server detail element
|
|
EVENT_TYPE_CONFIG_DUMP
MethodName and description of Configuration Dump action used in the AdminService invoke calls to DiagnosticProvider MBeans
|
|
EVENT_TYPE_NAME
Prefix to the CBE Extended Data Element name when CBE is used to store payload
|
|
EVENT_TYPE_SELF_DIAGNOSTIC
MethodName and description of SelfDiagnostic action used in the AdminService invoke calls to DiagnosticProvider MBeans
|
|
EVENT_TYPE_STATE_DUMP
MethodName and description of State Dump action used in the AdminService invoke calls to DiagnosticProvider MBeans
|
|
LEVEL_INFO
DiagnosticEvent integer level values which also map to java.util.Logging defaults.
|
|
LEVEL_SEVERE
DiagnosticEvent integer level values which also map to java.util.Logging defaults.
|
|
LEVEL_WARNING
DiagnosticEvent integer level values which also map to java.util.Logging defaults.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getCellName()
retrieves the name of the cell for this process in the WebSphere topology
|
|
getContent()
retrieves the content of the DiagnosticEvent (normally a CommonBaseEvent)
|
|
getContentType()
retrieves the type of the content
|
|
getDiagnosticData()
retrieves the primary payload of the DiagnosticEvent
|
|
getDiagnosticProviderId()
retrieves the DiagnosticProviderID that created the
DiagnosticEvent
|
|
getEventType()
retrieves the type of event that drove the creation of the DiagnosticEvent
|
|
getLevel()
retrieves the severity level of the DiagnosticEvent
|
|
getMessageKey()
retrieves the key (msgId) used for localization
|
|
getMessageParameters()
retrieves the parameters passed to the message processing
|
|
getNodeName()
retrieves the name of the node for this process in the WebSphere topology
|
|
getResourceBundleName()
retrieves the name of the ResourceBundle used for localization
|
|
getServerDetail()
retrieves the detail associated with this server.
|
|
getServerName()
retrieves the name of the WebSphere server
|
|
getSourceClass()
retrieves the class name that triggered the creation of the DiagnosticEvent
|
|
getSourceMethod()
retrieves the method name that triggered the creation of the DiagnosticEvent
|
|
toString()
returns the content of the DiagnosticEvent as a String
|
Field Detail
CONTENT_TYPE_CBE_101
- static final short CONTENT_TYPE_CBE_101
The content type for DiagnosticEvents whose content is a Common Base Event
See Also:
EVENT_TYPE_CONFIG_DUMP
- static final java.lang.String EVENT_TYPE_CONFIG_DUMP
MethodName and description of Configuration Dump action used in the AdminService invoke calls to DiagnosticProvider MBeans
See Also:
EVENT_TYPE_STATE_DUMP
- static final java.lang.String EVENT_TYPE_STATE_DUMP
MethodName and description of State Dump action used in the AdminService invoke calls to DiagnosticProvider MBeans
See Also:
EVENT_TYPE_SELF_DIAGNOSTIC
- static final java.lang.String EVENT_TYPE_SELF_DIAGNOSTIC
MethodName and description of SelfDiagnostic action used in the AdminService invoke calls to DiagnosticProvider MBeans
See Also:
EVENT_SERVER_DETAIL
- static final java.lang.String EVENT_SERVER_DETAIL
DiagnosticEvent implementation suffix for server detail element
See Also:
EVENT_TYPE_NAME
- static final java.lang.String EVENT_TYPE_NAME
Prefix to the CBE Extended Data Element name when CBE is used to store payload
See Also:
LEVEL_INFO
- static final int LEVEL_INFO
DiagnosticEvent integer level values which also map to java.util.Logging defaults. This is for an Informational event
See Also:
LEVEL_WARNING
- static final int LEVEL_WARNING
DiagnosticEvent integer level values which also map to java.util.Logging defaults. This is for a Warning event
See Also:
LEVEL_SEVERE
- static final int LEVEL_SEVERE
DiagnosticEvent integer level values which also map to java.util.Logging defaults. This is for a Severe event
See Also:
Method Detail
getContent
- java.lang.Object getContent()
retrieves the content of the DiagnosticEvent (normally a CommonBaseEvent)
Returns:
payload of the DiagnosticEvent (currently only implemented as a CBE,
but custom implementers of this class need not use CBE)
getContentType
- short getContentType()
retrieves the type of the content
Returns:
Type of content to assist consumer of the output
getEventType
- java.lang.String getEventType()
retrieves the type of event that drove the creation of the DiagnosticEvent
Returns:
type of event that prompted the creation of this DiagnosticEvent
getDiagnosticProviderId
- java.lang.String getDiagnosticProviderId( )
retrieves the DiagnosticProviderID that created the
DiagnosticEvent
Returns:
Identification of the DiagnosticProvider (JMX ObjectName)
getSourceClass
- java.lang.String getSourceClass( )
retrieves the class name that triggered the creation of the DiagnosticEvent
Returns:
Class name that created the event
getSourceMethod
- java.lang.String getSourceMethod( )
retrieves the method name that triggered the creation of the DiagnosticEvent
Returns:
Method name that created the event
getDiagnosticData
- java.util.SortedMap getDiagnosticData( )
retrieves the primary payload of the DiagnosticEvent
Returns:
The primary content of the payload in a SortedMap form (TreeMap)
getResourceBundleName
- java.lang.String getResourceBundleName( )
retrieves the name of the ResourceBundle used for localization
Returns:
Name of ResourceBundle used when DiagnosticEvent was created (localization)
getMessageKey
- java.lang.String getMessageKey( )
retrieves the key (msgId) used for localization
Returns:
MessageKey (ie: Catalog in a ResourceBundle)
getMessageParameters
- java.lang.Object[] getMessageParameters( )
retrieves the parameters passed to the message processing
Returns:
Parameters passed in for creation of the localized message
getLevel
- int getLevel()
retrieves the severity level of the DiagnosticEvent
Returns:
severity level of the DiagnosticEvent.
getCellName
- java.lang.String getCellName()
retrieves the name of the cell for this process in the WebSphere topology
Returns:
name of the cell in which this process is operating
getNodeName
- java.lang.String getNodeName()
retrieves the name of the node for this process in the WebSphere topology
Returns:
name of the node in which this process is operating
getServerName
- java.lang.String getServerName( )
retrieves the name of the WebSphere server
Returns:
WebSphere server name
getServerDetail
- java.lang.String getServerDetail( )
retrieves the detail associated with this server. This is null for non-z/OS
servers and contains the string Controller or Servant:[stoken] for servants where
stoken is the Servant Token associated with this servant
Returns:
z/OS specific server details, or null if not z/OS
toString
- java.lang.String toString()
returns the content of the DiagnosticEvent as a String
Overrides:
toString
in class java.lang.Object
Returns:
String value of the primary content