com.cisco.provisioning.cpe.events
Class MessagingQualifier

java.lang.Object
  extended by com.cisco.provisioning.cpe.events.Qualifier
      extended by com.cisco.provisioning.cpe.events.MessagingQualifier
All Implemented Interfaces:
Externalizable, Serializable

public class MessagingQualifier
extends Qualifier

This implementation of the Qualifier class is to be used with the MessagingEvent.

See Also:
Serialized Form

Constructor Summary
MessagingQualifier()
          This constructor is needed for externalization Note: This constructor is ONLY used for externalization.
 
Method Summary
 void clearAll()
          Clears all qualification options that have been set.
 boolean qualifies(ProvAPIEvent event)
          Returns true if the implementation has determined that this event satisfies the requirements to notify the associated listener.
 void readExternal(ObjectInput in)
          Externalizable interface.
 void setConnectionDown()
          Sets the qualifies method to return true to all MessagingEvent that are MessagingListener.CONNECTION_DOWN sub-events.
 void setConnectionUp()
          Sets the qualifies method to return true to all MessagingEvent that are MessagingListener.CONNECTION_UP sub-events.
 void setMessagingQueuefull()
          Sets the qualifies method to return true to all MessagingEvent that are MessagingListener.MESSAGING_QUEUE_FULL sub-events.
 void writeExternal(ObjectOutput out)
          Externalizable interface.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessagingQualifier

public MessagingQualifier()
This constructor is needed for externalization

Note: This constructor is ONLY used for externalization.

Method Detail

clearAll

public void clearAll()
Clears all qualification options that have been set.


qualifies

public boolean qualifies(ProvAPIEvent event)
Returns true if the implementation has determined that this event satisfies the requirements to notify the associated listener.

Specified by:
qualifies in class Qualifier
Parameters:
event - the object representing the event has occurred.

Returns:
true if the implementation has determined that this event satisfies the requirements to notify the associated listener.

setConnectionUp

public void setConnectionUp()
Sets the qualifies method to return true to all MessagingEvent that are MessagingListener.CONNECTION_UP sub-events.


setConnectionDown

public void setConnectionDown()
Sets the qualifies method to return true to all MessagingEvent that are MessagingListener.CONNECTION_DOWN sub-events.


setMessagingQueuefull

public void setMessagingQueuefull()
Sets the qualifies method to return true to all MessagingEvent that are MessagingListener.MESSAGING_QUEUE_FULL sub-events.


readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Externalizable interface. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class Qualifier
Parameters:
in - the stream to read data from in order to restore the object

Throws:
IOException - if I/O errors occur
ClassNotFoundException - If the class for an object being restored cannot be found.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Externalizable interface. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class Qualifier
Parameters:
out - the stream to write the object to

Throws:
IOException - Includes any I/O exceptions that may occur