com.ibm.wsspi.monitoring
Interface EventSource

All Superinterfaces:
WellKnownEventNatures

public interface EventSource
extends WellKnownEventNatures

An event source represents a monitoarable element kind of a WBI component. Examples are: a map, an adaptive entity timer, etc...

See Also:

Each monitorable element defines an event source, each event source defines a set of component-element specific event points.

Examples for event points are ENTER, EXIT, FAILURE

An event source object is used to retrieve event points to fire monitoring events or plain loggers to trace diagnosis or other messages.


Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from interface com.ibm.wsspi.monitoring.WellKnownEventNatures
ENTRY, EXIT, FAILED, FAILURE
 
Method Summary
 EventPoint getEventPoint(java.lang.String eventPointName)
          Factory method, creates an EventPoint for the monitored element represented by the event point.
 EventSourceContext getEventSourceContext()
           
 java.util.logging.Logger getLogger()
          Returns the logger named using the component-type, component, element-kind, element-name tupel
 com.ibm.ws.monitoring.core.pmi.PMIHandler getPmiHandler()
           
 java.util.Set getProperties()
           
 boolean hasProperty(java.lang.String propertyName)
           
 boolean isOverridingDefaults()
           
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getEventPoint

public EventPoint getEventPoint(java.lang.String eventPointName)
Factory method, creates an EventPoint for the monitored element represented by the event point.

Parameters:
eventPointName - a valid event nature for this
Returns:
the event point specified by the name

getLogger

public java.util.logging.Logger getLogger()
Returns the logger named using the component-type, component, element-kind, element-name tupel

Returns:
the logger associated with this event source

hasProperty

public boolean hasProperty(java.lang.String propertyName)
Parameters:
propertyName - the name of property to be checked
Returns:
returns true if the property propertyName is set for this event source, otherwise returns false

getProperties

public java.util.Set getProperties()
Returns:
the set of property names set for this event source

isOverridingDefaults

public boolean isOverridingDefaults()
Returns:
true if this event source publishes events to other targets (log, cei) or different payload levels then specified as default in the corresponding .mes file (@see EventSourceContext)

getEventSourceContext

public EventSourceContext getEventSourceContext()
Returns:
the event source context from which this event source is created

getPmiHandler

public com.ibm.ws.monitoring.core.pmi.PMIHandler getPmiHandler()
Returns:
performance monitor handler to report stats for this event source