com.ibm.wsspi.rasdiag

Class CommonBaseEventDiagnosticEventFactory

  1. java.lang.Object
  2. extended bycom.ibm.wsspi.rasdiag.CommonBaseEventDiagnosticEventFactory

  1. public class CommonBaseEventDiagnosticEventFactory
  2. 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

Constructor and Description
CommonBaseEventDiagnosticEventFactory()

Method Summary

Modifier and Type Method and Description
  1. static
  2. 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
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. 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.
  1. static
  2. 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

  1. public CommonBaseEventDiagnosticEventFactory( )

Method Detail

createConfigDump

  1. public static DiagnosticEvent createConfigDump( java.lang.String DPId,
  2. java.lang.String sourceClass,
  3. java.lang.String sourceMethod,
  4. java.util.HashMap aDiagnosticEventData,
  5. 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

  1. public static DiagnosticEvent createStateDump( java.lang.String DPId,
  2. java.lang.String sourceClass,
  3. java.lang.String sourceMethod,
  4. java.util.HashMap aDiagnosticEventData,
  5. 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

  1. public static DiagnosticEvent createDiagnosticEvent( java.lang.String DPId,
  2. java.lang.String aEventType,
  3. int level,
  4. java.lang.String sourceClass,
  5. java.lang.String sourceMethod,
  6. java.lang.String aResourceBundleName,
  7. java.lang.String aMsgKey,
  8. java.util.HashMap aDiagnosticEventData,
  9. 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

  1. public static DiagnosticEvent createDiagnosticEvent( java.lang.String DPId,
  2. java.lang.String aEventType,
  3. int level,
  4. java.lang.String sourceClass,
  5. java.lang.String sourceMethod,
  6. java.lang.String aResourceBundleName,
  7. java.lang.String aMsgKey,
  8. java.lang.Object aMsgParams,
  9. java.util.HashMap aDiagnosticEventData,
  10. 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

  1. public static DiagnosticEvent createDiagnosticEvent( java.lang.String DPId,
  2. java.lang.String aEventType,
  3. int level,
  4. java.lang.String sourceClass,
  5. java.lang.String sourceMethod,
  6. java.lang.String aResourceBundleName,
  7. java.lang.String aMsgKey,
  8. java.lang.Object[] aMsgParams,
  9. java.util.HashMap aDiagnosticEventData,
  10. 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).