public interface EventSourceContext
extends com.ibm.wsspi.monitoring.metadata.MonitoringSpec
EventSource
Modifier and Type | Interface and Description |
---|---|
static interface |
EventSourceContext.Factory |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
static EventSourceContext.Factory |
Factory |
static java.lang.String |
SessionKey |
Modifier and Type | Method and Description |
---|---|
boolean |
blockExceptions(boolean isBlockExceptions)
Direct monitoring to be block event publishing exceptions for the artifact monitored by this event source context.
|
java.lang.String |
getAttribute(java.lang.String key)
Return the value of the requested attribute, as is defined for this context in the mon file.
|
java.util.Map |
getAttributes()
Return the attributes defined for this context in the mon file.
|
com.ibm.websphere.cem.ECSEmitter |
getECSEmitter(java.lang.String ecsID)
Deprecated.
|
java.lang.String |
getEventFormat()
return this monitor's event format, the format can be HexBinary, XML or XMLWithSchema.
|
EventSource |
getEventSource(java.lang.String elementKind,
java.lang.String elementName)
Returns an event source for a monitored element.
|
java.lang.String |
getEventVersion()
return current valid event version. the value can be 6.1 or 6.0.2.
|
java.util.logging.Logger |
getLogger() |
boolean |
hasDefaultEventsDisabled() |
boolean |
hasDefaultEventsEnabled() |
boolean |
hasMonitor() |
boolean |
isBlockExceptions() |
boolean |
isOverridingDefaults() |
void |
setEventFormat(java.lang.String format)
set event format, it equals to call set event version. the valid input are HexBinary, XML and XMLWithSchema
if inputed value is not HexBinary, XML or XMLWithSchema,it will be ignored.
|
void |
setEventVersion(java.lang.String version)
set event version. by default the version is 6.1.if event producers want to use
old format, then they need to call this SPI to set the version to 6.0.2
if inputed value is neither 6.1 nor 6.0.2 ,it will be ignored.
|
static final java.lang.String COPYRIGHT
static final EventSourceContext.Factory Factory
static final java.lang.String SessionKey
EventSource getEventSource(java.lang.String elementKind, java.lang.String elementName)
elementKind
- element kinds are specified for each component kind in the .mes file, for example for a Map transformation "Transformation"elementName
- the name of the monitored element e.g. "/ClarifyToGenericAddress/1" this name is used also in the .mon filejava.util.logging.Logger getLogger()
java.lang.String getAttribute(java.lang.String key)
getAttribute
in interface com.ibm.wsspi.monitoring.metadata.MonitoringSpec
key
- java.util.Map getAttributes()
getAttributes
in interface com.ibm.wsspi.monitoring.metadata.MonitoringSpec
boolean isOverridingDefaults()
boolean hasMonitor()
@Deprecated com.ibm.websphere.cem.ECSEmitter getECSEmitter(java.lang.String ecsID)
ecsID
- - event correlation sphere ID. it can be null, In that case, the current ECS ID is used.boolean hasDefaultEventsEnabled()
hasDefaultEventsEnabled
in interface com.ibm.wsspi.monitoring.metadata.MonitoringSpec
boolean hasDefaultEventsDisabled()
hasDefaultEventsDisabled
in interface com.ibm.wsspi.monitoring.metadata.MonitoringSpec
boolean blockExceptions(boolean isBlockExceptions)
Event blocking can be adjusted for each monitored artifact separately. By default monitoring blocks all event publishing exceptions.
isBlockExceptions
- if true no exceptions are raised for event publishing failures,
if set to false, a RuntimeException is raised with the cause set to the originating exception,
the wrappering is neccessary because the originating exception may be a checked exceptionboolean isBlockExceptions()
java.lang.String getEventVersion()
void setEventVersion(java.lang.String version)
version
- java.lang.String getEventFormat()
void setEventFormat(java.lang.String format)
format
- format