public class CommonBaseEventDiagnosticEventFactory
extends java.lang.Object
DiagnosticEventFactory
class facilitates the creation of DiagnosticEvents
(specifically CommonBaseEventDiagnosticEventImpl
objects. It handles most of the
heavy-lifting with respect to CommonBaseEvent creation.Constructor and Description |
---|
CommonBaseEventDiagnosticEventFactory() |
Modifier and Type | Method and Description |
---|---|
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
|
public CommonBaseEventDiagnosticEventFactory()
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)
DPId
- 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).CommonBaseEventDiagnosticEventImpl
object (which contains a CBE).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)
DPId
- 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).CommonBaseEventDiagnosticEventImpl
object (which contains a CBE).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)
DPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNameaEventType
- String that will go into the CBE to identify what prompted the
creation of this DiagnosticEventlevel
- 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).CommonBaseEventDiagnosticEventImpl
object (which contains a CBE).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)
DPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNameaEventType
- String that will go into the CBE to identify what prompted the
creation of this DiagnosticEventlevel
- 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).CommonBaseEventDiagnosticEventImpl
object (which contains a CBE).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)
DPId
- DiagnosticProvider ID of the caller (a DiagnosticProvider). This is
currently the JMX objectNameaEventType
- String that will go into the CBE to identify what prompted the
creation of this DiagnosticEventlevel
- 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).CommonBaseEventDiagnosticEventImpl
object (which contains a CBE).