public class DiagnosticEventFactory
extends java.lang.Object
DiagnosticFactory
class provides a simple means for DiagnosticProviders
in
the DiagnosticProvider infrastructure to create DiagnosticEvents with artifacts that they have created. There
are 3 signatures for the same function similar to the logging signatures. All have a hashMap
payload, one has no message parms, one has one message parm, and the third has an object array
of message parms. The HashMap contains AttributeIds as the name and DiagnosticTypedValue objects
(including MessageKeys) as the value or ... sub-HashMap names as the name and a child HashMap as
the valueConstructor and Description |
---|
DiagnosticEventFactory() |
Modifier and Type | Method and Description |
---|---|
static DiagnosticEvent |
createConfigDump(java.lang.String aDPId,
java.lang.String sourceClass,
java.lang.String sourceMethod,
java.util.HashMap aDiagnosticEventData)
creates a dump of the configuration for a DiagnosticProvider
|
static DiagnosticEvent |
createDiagnosticEvent(java.lang.String aDPId,
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)
creates a DiagnosticEvent.
|
static DiagnosticEvent |
createDiagnosticEvent(java.lang.String aDPId,
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)
creates a DiagnosticEvent.
|
static DiagnosticEvent |
createDiagnosticEvent(java.lang.String aDPId,
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)
creates a DiagnosticEvent.
|
static DiagnosticEvent |
createStateDump(java.lang.String aDPId,
java.lang.String sourceClass,
java.lang.String sourceMethod,
java.util.HashMap aDiagnosticEventData)
creates a dump of the current state of a DiagnosticProvider
|
public static DiagnosticEvent createConfigDump(java.lang.String aDPId, java.lang.String sourceClass, java.lang.String sourceMethod, java.util.HashMap aDiagnosticEventData)
aDPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNamesourceClass
- Class that initiated construction of the DiagnosticEventsourceMethod
- Method that initiated construction of the DiagnosticEventaDiagnosticEventData
- 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).public static DiagnosticEvent createStateDump(java.lang.String aDPId, java.lang.String sourceClass, java.lang.String sourceMethod, java.util.HashMap aDiagnosticEventData)
aDPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNamesourceClass
- Class that initiated construction of the DiagnosticEventsourceMethod
- Method that initiated construction of the DiagnosticEventaDiagnosticEventData
- 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).public static DiagnosticEvent createDiagnosticEvent(java.lang.String aDPId, 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)
aDPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNameaEventType
- String that will go into the DiagnosticEvent to identify what prompted the
creation of this Eventlevel
- The severity level of the DiagnosticEvent. Currently supported levels:
sourceClass
- Class that initiated construction of the DiagnosticEventsourceMethod
- Method that initiated construction of the DiagnosticEventaResourceBundleName
- Name of the ResourceBundle used for localizationaMsgKey
- Key for the message within the ResourceBundleaDiagnosticEventData
- 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).public static DiagnosticEvent createDiagnosticEvent(java.lang.String aDPId, 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)
aDPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNameaEventType
- String that will go into the DiagnosticEvent to identify what prompted the
creation of this Eventlevel
- The severity level of the DiagnosticEvent. Currently supported levels:
sourceClass
- Class that initiated construction of the DiagnosticEventsourceMethod
- Method that initiated construction of the DiagnosticEventaResourceBundleName
- Name of the ResourceBundle used for localizationaMsgKey
- Key for the message within the ResourceBundleaMsgParams
- Single parameter to the message for processingaDiagnosticEventData
- 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).public static DiagnosticEvent createDiagnosticEvent(java.lang.String aDPId, 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)
aDPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNameaEventType
- String that will go into the DiagnosticEvent to identify what prompted the
creation of this Eventlevel
- The severity level of the DiagnosticEvent. Currently supported levels:
sourceClass
- Class that initiated construction of the DiagnosticEventsourceMethod
- Method that initiated construction of the DiagnosticEventaResourceBundleName
- Name of the ResourceBundle used for localizationaMsgKey
- Key for the message within the ResourceBundleaMsgParams
- Array of parameters to the message for processingaDiagnosticEventData
- 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).