IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.rasdiag
Class CommonBaseEventDiagnosticEventFactory

java.lang.Object
  extended by com.ibm.wsspi.rasdiag.CommonBaseEventDiagnosticEventFactory

public class CommonBaseEventDiagnosticEventFactory
extends java.lang.Object

The DiagnosticEventFactory class facilitates the creation of DiagnosticEvents (specifically CommonBaseEventDiagnosticEventImpl objects. It handles most of the heavy-lifting with respect to CommonBaseEvent creation.


Constructor Summary
CommonBaseEventDiagnosticEventFactory()
           
 
Method Summary
static DiagnosticEvent createConfigDump(java.lang.String DPId, java.lang.String sourceClass, java.lang.String sourceMethod, java.util.HashMap aDiagnosticEventData, org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
          creates a dump of the configuration for a DiagnosticProvider
static DiagnosticEvent createDiagnosticEvent(java.lang.String DPId, java.lang.String aEventType, int level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String aResourceBundleName, java.lang.String aMsgKey, java.util.HashMap aDiagnosticEventData, org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
          creates a DiagnosticEvent.
static DiagnosticEvent createDiagnosticEvent(java.lang.String DPId, java.lang.String aEventType, int level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String aResourceBundleName, java.lang.String aMsgKey, java.lang.Object[] aMsgParams, java.util.HashMap aDiagnosticEventData, org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
          creates a DiagnosticEvent.
static DiagnosticEvent createDiagnosticEvent(java.lang.String DPId, java.lang.String aEventType, int level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String aResourceBundleName, java.lang.String aMsgKey, java.lang.Object aMsgParams, java.util.HashMap aDiagnosticEventData, org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
          creates a DiagnosticEvent.
static DiagnosticEvent createStateDump(java.lang.String DPId, java.lang.String sourceClass, java.lang.String sourceMethod, java.util.HashMap aDiagnosticEventData, org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
          creates a dump of the current state of a DiagnosticProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommonBaseEventDiagnosticEventFactory

public CommonBaseEventDiagnosticEventFactory()
Method Detail

createConfigDump

public static DiagnosticEvent createConfigDump(java.lang.String DPId,
                                               java.lang.String sourceClass,
                                               java.lang.String sourceMethod,
                                               java.util.HashMap aDiagnosticEventData,
                                               org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
creates a dump of the configuration for a DiagnosticProvider

Parameters:
DPId - DiagnosticProvider ID of the caller (a DiagnosticProvider). This is currently the JMX objectName
sourceClass - Class that initiated construction of the DiagnosticEvent
sourceMethod - Method that initiated construction of the DiagnosticEvent
aDiagnosticEventData - HashMap containing the primary data in the Payload. The DiagnosticTypedValue class provides the ability to create typed values, and provides a helper method (addHashMap) for cascading HashMaps within HashMaps (recursively if needed).
Returns:
DiagnosticEvent which is a CommonBaseEventDiagnosticEventImpl object (which contains a CBE).

createStateDump

public static DiagnosticEvent createStateDump(java.lang.String DPId,
                                              java.lang.String sourceClass,
                                              java.lang.String sourceMethod,
                                              java.util.HashMap aDiagnosticEventData,
                                              org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
creates a dump of the current state of a DiagnosticProvider

Parameters:
DPId - DiagnosticProvider ID of the caller (a DiagnosticProvider). This is currently the JMX objectName
sourceClass - Class that initiated construction of the DiagnosticEvent
sourceMethod - Method that initiated construction of the DiagnosticEvent
aDiagnosticEventData - HashMap containing the primary data in the Payload. The DiagnosticTypedValue class provides the ability to create typed values, and provides a helper method (addHashMap) for cascading HashMaps within HashMaps (recursively if needed).
Returns:
DiagnosticEvent which is a CommonBaseEventDiagnosticEventImpl object (which contains a CBE).

createDiagnosticEvent

public static DiagnosticEvent createDiagnosticEvent(java.lang.String DPId,
                                                    java.lang.String aEventType,
                                                    int level,
                                                    java.lang.String sourceClass,
                                                    java.lang.String sourceMethod,
                                                    java.lang.String aResourceBundleName,
                                                    java.lang.String aMsgKey,
                                                    java.util.HashMap aDiagnosticEventData,
                                                    org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
creates a DiagnosticEvent. Primarily used at this time when DiagnosticProviders are requested to run selfDiagnostic tests

Parameters:
DPId - DiagnosticProvider ID of the caller (a DiagnosticProvider). This is currently the JMX objectName
aEventType - String that will go into the CBE to identify what prompted the creation of this DiagnosticEvent
level - The severity level of the DiagnosticEvent. Currently supported levels:
  • DiagnosticEvent.INFO_LEVEL (0)
  • DiagnosticEvent.WARNING_LEVEL (10)
  • DiagnosticEvent.SEVERE_LEVEL (20)
sourceClass - Class that initiated construction of the DiagnosticEvent
sourceMethod - Method that initiated construction of the DiagnosticEvent
aResourceBundleName - Name of the ResourceBundle used for localization
aMsgKey - Key for the message within the ResourceBundle
aDiagnosticEventData - HashMap containing the primary data in the Payload. The DiagnosticTypedValue class provides the ability to create typed values, and provides a helper method (addHashMap) for cascading HashMaps within HashMaps (recursively if needed).
Returns:
DiagnosticEvent which is a CommonBaseEventDiagnosticEventImpl object (which contains a CBE).

createDiagnosticEvent

public static DiagnosticEvent createDiagnosticEvent(java.lang.String DPId,
                                                    java.lang.String aEventType,
                                                    int level,
                                                    java.lang.String sourceClass,
                                                    java.lang.String sourceMethod,
                                                    java.lang.String aResourceBundleName,
                                                    java.lang.String aMsgKey,
                                                    java.lang.Object aMsgParams,
                                                    java.util.HashMap aDiagnosticEventData,
                                                    org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
creates a DiagnosticEvent. Primarily used at this time when DiagnosticProviders are requested to run selfDiagnostic tests

Parameters:
DPId - DiagnosticProvider ID of the caller (a DiagnosticProvider). This is currently the JMX objectName
aEventType - String that will go into the CBE to identify what prompted the creation of this DiagnosticEvent
level - The severity level of the DiagnosticEvent. Currently supported levels:
  • DiagnosticEvent.INFO_LEVEL (0)
  • DiagnosticEvent.WARNING_LEVEL (10)
  • DiagnosticEvent.SEVERE_LEVEL (20)
sourceClass - Class that initiated construction of the DiagnosticEvent
sourceMethod - Method that initiated construction of the DiagnosticEvent
aResourceBundleName - Name of the ResourceBundle used for localization
aMsgKey - Key for the message within the ResourceBundle
aMsgParams - Single parameter to the message for processing
aDiagnosticEventData - HashMap containing the primary data in the Payload. The DiagnosticTypedValue class provides the ability to create typed values, and provides a helper method (addHashMap) for cascading HashMaps within HashMaps (recursively if needed).
Returns:
DiagnosticEvent which is a CommonBaseEventDiagnosticEventImpl object (which contains a CBE).

createDiagnosticEvent

public static DiagnosticEvent createDiagnosticEvent(java.lang.String DPId,
                                                    java.lang.String aEventType,
                                                    int level,
                                                    java.lang.String sourceClass,
                                                    java.lang.String sourceMethod,
                                                    java.lang.String aResourceBundleName,
                                                    java.lang.String aMsgKey,
                                                    java.lang.Object[] aMsgParams,
                                                    java.util.HashMap aDiagnosticEventData,
                                                    org.eclipse.hyades.logging.events.cbe.EventFactory aEventFactory)
creates a DiagnosticEvent. Primarily used at this time when DiagnosticProviders are requested to run selfDiagnostic tests

Parameters:
DPId - DiagnosticProvider ID of the caller (a DiagnosticProvider). This is currently the JMX objectName
aEventType - String that will go into the CBE to identify what prompted the creation of this DiagnosticEvent
level - The severity level of the DiagnosticEvent. Currently supported levels:
  • DiagnosticEvent.INFO_LEVEL (0)
  • DiagnosticEvent.WARNING_LEVEL (10)
  • DiagnosticEvent.SEVERE_LEVEL (20)
sourceClass - Class that initiated construction of the DiagnosticEvent
sourceMethod - Method that initiated construction of the DiagnosticEvent
aResourceBundleName - Name of the ResourceBundle used for localization
aMsgKey - Key for the message within the ResourceBundle
aMsgParams - Array of parameters to the message for processing
aDiagnosticEventData - HashMap containing the primary data in the Payload. The DiagnosticTypedValue class provides the ability to create typed values, and provides a helper method (addHashMap) for cascading HashMaps within HashMaps (recursively if needed).
Returns:
DiagnosticEvent which is a CommonBaseEventDiagnosticEventImpl object (which contains a CBE).

IBM WebSphere Application ServerTM
Release 7