edu.cmu.cs.able.probebus.siena.events
Class SienaBandwidthProbeEvent

java.lang.Object
  |
  +--edu.cmu.cs.able.probebus.siena.SienaProbeEvent
        |
        +--edu.cmu.cs.able.probebus.siena.SienaSensedProbeEvent
              |
              +--edu.cmu.cs.able.probebus.siena.events.SienaBandwidthProbeEvent
All Implemented Interfaces:
IProbeEvent, ISienaProbeEvent

public class SienaBandwidthProbeEvent
extends SienaSensedProbeEvent

SienaBandwidthProbeEvent This event is sent by a probe with the intent of initiating informing consumers of a change in the bandwidth. Here is the format of the message: 1. Bandwidth="0.748" 2. ProbeConfigurationName="BandwidthConfig" 3. SystemID="Client2" 4. Event="an xml string" 5. Hostname="gs01.isri.cs.cmu.edu" 6. MethodName="processResponse(java.lang.StringBuffer)" 7. ProbeInfrastructureEventType="Sensed" 8. ProbedClass="runtime.client.ClientThread" 9. ProbedObject="runtime.client.ClientThread" 10. className="runtime.client.ClientThread" 11. threadId="ClientThread"


Field Summary
static java.lang.String BANDWIDTH_KEY
          Notification will have Bandwidth="0.748"
protected  BandwidthProbeEvent myProbeEvent
          The generic event associated with this Siena-specific event
static java.lang.String PROBE_CONFIGURATION_NAME_KEY
          Notification will have ProbeConfigurationName="BandwidthConfig"
static java.lang.String SYSTEM_ID_KEY
          Notification will have SystemID="Client2"
 
Fields inherited from class edu.cmu.cs.able.probebus.siena.SienaSensedProbeEvent
CLASS_NAME_KEY, classNameValue, EVENT_KEY, eventValue, HOSTNAME_KEY, hostnameValue, METHOD_NAME_KEY, methodNameValue, PI_EVENT_TYPE_KEY, piEventTypeValue, PROBED_CLASS_KEY, PROBED_OBJECT_KEY, probedClassValue, probedObjectValue, THREAD_ID_KEY, threadIdValue
 
Fields inherited from class edu.cmu.cs.able.probebus.siena.SienaProbeEvent
theProbeBus
 
Constructor Summary
SienaBandwidthProbeEvent(siena.Notification n)
          Constructor for SienaBandwidthProbeEvent( Notification ) Converts from a Notification to a SienaBandwidthProbeEvent
SienaBandwidthProbeEvent(SienaProbeBus pb, java.lang.String bandwidth, java.lang.String probeConfigurationName, java.lang.String systemID)
          Constructor for SienaBandwidthProbeEvent
 
Method Summary
 siena.Filter createFilter()
          Create a Siena Filter that will only listen to this event For this event, we match based on - probe configuration name - system id
 boolean equals(IProbeEvent e)
          Equality testing important for writing test cases!
 BandwidthProbeEvent getProbeEvent()
           
 siena.Notification toNotification()
          Converts this event to a Siena Notification In the current imlementation, this method is not called by probes However, it is needed for test case generation
 
Methods inherited from class edu.cmu.cs.able.probebus.siena.SienaSensedProbeEvent
setCommonNotificationFields
 
Methods inherited from class edu.cmu.cs.able.probebus.siena.SienaProbeEvent
dispatch, getProbeBus, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

myProbeEvent

protected BandwidthProbeEvent myProbeEvent
The generic event associated with this Siena-specific event

BANDWIDTH_KEY

public static final java.lang.String BANDWIDTH_KEY
Notification will have Bandwidth="0.748"

PROBE_CONFIGURATION_NAME_KEY

public static final java.lang.String PROBE_CONFIGURATION_NAME_KEY
Notification will have ProbeConfigurationName="BandwidthConfig"

SYSTEM_ID_KEY

public static final java.lang.String SYSTEM_ID_KEY
Notification will have SystemID="Client2"
Constructor Detail

SienaBandwidthProbeEvent

public SienaBandwidthProbeEvent(SienaProbeBus pb,
                                java.lang.String bandwidth,
                                java.lang.String probeConfigurationName,
                                java.lang.String systemID)
Constructor for SienaBandwidthProbeEvent

SienaBandwidthProbeEvent

public SienaBandwidthProbeEvent(siena.Notification n)
Constructor for SienaBandwidthProbeEvent( Notification ) Converts from a Notification to a SienaBandwidthProbeEvent
Method Detail

toNotification

public siena.Notification toNotification()
Converts this event to a Siena Notification In the current imlementation, this method is not called by probes However, it is needed for test case generation
Overrides:
toNotification in class SienaSensedProbeEvent
Following copied from class: edu.cmu.cs.able.probebus.siena.SienaProbeEvent
Returns:
this object represented as a Siena Notification

getProbeEvent

public BandwidthProbeEvent getProbeEvent()

createFilter

public siena.Filter createFilter()
Create a Siena Filter that will only listen to this event For this event, we match based on - probe configuration name - system id

equals

public boolean equals(IProbeEvent e)
Equality testing important for writing test cases!