com.cisco.provisioning.cpe.events
Interface ProvAPIEventManager

All Known Subinterfaces:

PACEConnection

public interface ProvAPIEventManager

This interface outlines the methods for managing events. Each class of events has three methods associated with it. These methods are addXXXXListener(XXXXListener, Qualifier), fireXXXX(XXXXEvent), removeXXXXListener(XXXXListener, Qualifier). The event name is substituted for XXXX.

To receive notification of an event occurring, first register for the event using addXXXXListener(...). You will be notified of the XXXX event occurring if the call to Qualifier.qualifies returns true. Only one given pairing of a XXXXListener and a Qualifier can exist. You can register a XXXXListener with different Qualifier's.

See Also:

ProvAPIEvent, ProvAPIEventListener, Qualifier

Method Summary

void	addBatchListener(BatchListener listener, Qualifier qualifier) Adds BatchListener to receive BatchEvent that satisfy the given Qualifier.
void	addCOSListener(COSListener listener, Qualifier qualifier) Adds COSListener to receive COSEvents that satisfy the given Qualifier.
void	addCRSCompleteListener(CRSCompleteListener listener, Qualifier qualifier) Adds CRSCompleteListener to receive CRSCompleteEvents that satisfy the given Qualifier.
void	addDeviceListener(DeviceListener listener, Qualifier qualifier) Adds DeviceListener to receive DeviceEvents that satisfy the given Qualifier.
void	addDeviceTypeListener(DeviceTypeListener listener, Qualifier qualifier) Adds DeviceTypeListener to receive DeviceTypeEvents that satisfy the given Qualifier.
void	addDHCPCriteriaListener(DHCPCriteriaListener listener, Qualifier qualifier) Adds DHCPCriteriaListener to receive DHCPCriteriaEvents that satisfy the given Qualifier.
void	addFileListener(FileListener listener, Qualifier qualifier) Adds FileListener to receive FileEvents that satisfy the given Qualifier.
void	addMessagingListener(MessagingListener listener, Qualifier qualifier) Adds MessagingListener to receive MessagingEvents that satisfy the given Qualifier.
void	addProvGroupListener(ProvGroupListener listener, Qualifier qualifier) Adds ProvGroupListener to receive ProvGroupEvents that satisfy the given Qualifier.
void	addSystemConfigListener(SystemConfigListener listener, Qualifier qualifier) Adds SystemConfigListener to receive SystemConfigEvents that satisfy the given Qualifier.
void	fireBatchEvent(BatchEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireCOSEvent(COSEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireCRSCompleteEvent(CRSCompleteEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireDeviceEvent(DeviceEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireDeviceTypeEvent(DeviceTypeEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireDHCPCriteriaEvent(DHCPCriteriaEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireMessagingEvent(MessagingEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireNodeEvent(NodeEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireNodeTypeEvent(NodeTypeEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireProvGroupEvent(ProvGroupEvent event) This method will notify all registered listeners that the given event has occurred.
void	fireSystemConfigEvent(SystemConfigEvent event) This method will notify all registered listeners that the given event has occurred.
void	removeBatchListener(BatchListener listener, Qualifier qualifier) Stops the given BatchListener from receiving event notifications of events that satisfy the given qualifier.
void	removeCOSListener(COSListener listener, Qualifier qualifier) Stops the given COSListener from receiving event notifications of events that satisfy the given qualifier.
void	removeCRSCompleteListener(CRSCompleteListener listener, Qualifier qualifier) Stops the given CRSCompleteListener from receiving event notifications of events that satisfy the given qualifier.
void	removeDeviceListener(DeviceListener listener, Qualifier qualifier) Stops the given DeviceListener from receiving event notifications of events that satisfy the given qualifier.
void	removeDeviceTypeListener(DeviceTypeListener listener, Qualifier qualifier) Stops the given DeviceTypeListener from receiving event notifications of events that satisfy the given qualifier.
void	removeDHCPCriteriaListener(DHCPCriteriaListener listener, Qualifier qualifier) Stops the given DHCPCriteriaListener from receiving event notifications of events that satisfy the given qualifier.
void	removeFileListener(FileListener listener, Qualifier qualifier) Stops the given FileListener from receiving event notifications of events that satisfy the given qualifier.
void	removeMessagingListener(MessagingListener listener, Qualifier qualifier) Stops the given MessagingListener from receiving event notifications of events that satisfy the given qualifier.
void	removeNodeListener(NodeListener listener, Qualifier qualifier) Stops the given NodeListener from receiving event notifications of events that satisfy the given qualifier.
void	removeNodeTypeListener(NodeTypeListener listener, Qualifier qualifier) Stops the given NodeTypeListener from receiving event notifications of events that satisfy the given qualifier.
void	removeProvGroupListener(ProvGroupListener listener, Qualifier qualifier) Stops the given ProvGroupListener from receiving event notifications of events that satisfy the given qualifier.
void	removeSystemConfigListener(SystemConfigListener listener, Qualifier qualifier) Stops the given SystemConfigListener from receiving event notifications of events that satisfy the given qualifier.

Method Detail

addBatchListener

void addBatchListener(BatchListener listener,
                      Qualifier qualifier)

Adds BatchListener to receive BatchEvent that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if listener registration fails.

fireBatchEvent

void fireBatchEvent(BatchEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeBatchListener

void removeBatchListener(BatchListener listener,
                         Qualifier qualifier)

Stops the given BatchListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addDeviceListener

void addDeviceListener(DeviceListener listener,
                       Qualifier qualifier)

Adds DeviceListener to receive DeviceEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireDeviceEvent

void fireDeviceEvent(DeviceEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeDeviceListener

void removeDeviceListener(DeviceListener listener,
                          Qualifier qualifier)

Stops the given DeviceListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addDHCPCriteriaListener

void addDHCPCriteriaListener(DHCPCriteriaListener listener,
                             Qualifier qualifier)

Adds DHCPCriteriaListener to receive DHCPCriteriaEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireDHCPCriteriaEvent

void fireDHCPCriteriaEvent(DHCPCriteriaEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeDHCPCriteriaListener

void removeDHCPCriteriaListener(DHCPCriteriaListener listener,
                                Qualifier qualifier)

Stops the given DHCPCriteriaListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addMessagingListener

void addMessagingListener(MessagingListener listener,
                          Qualifier qualifier)

Adds MessagingListener to receive MessagingEvents that satisfy the given Qualifier. This event will be a local event only.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireMessagingEvent

void fireMessagingEvent(MessagingEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeMessagingListener

void removeMessagingListener(MessagingListener listener,
                             Qualifier qualifier)

Stops the given MessagingListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addProvGroupListener

void addProvGroupListener(ProvGroupListener listener,
                          Qualifier qualifier)

Adds ProvGroupListener to receive ProvGroupEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireProvGroupEvent

void fireProvGroupEvent(ProvGroupEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeProvGroupListener

void removeProvGroupListener(ProvGroupListener listener,
                             Qualifier qualifier)

Stops the given ProvGroupListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addSystemConfigListener

void addSystemConfigListener(SystemConfigListener listener,
                             Qualifier qualifier)

Adds SystemConfigListener to receive SystemConfigEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireSystemConfigEvent

void fireSystemConfigEvent(SystemConfigEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeSystemConfigListener

void removeSystemConfigListener(SystemConfigListener listener,
                                Qualifier qualifier)

Stops the given SystemConfigListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addCOSListener

void addCOSListener(COSListener listener,
                    Qualifier qualifier)

Adds COSListener to receive COSEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireCOSEvent

void fireCOSEvent(COSEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeCOSListener

void removeCOSListener(COSListener listener,
                       Qualifier qualifier)

Stops the given COSListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addCRSCompleteListener

void addCRSCompleteListener(CRSCompleteListener listener,
                            Qualifier qualifier)

Adds CRSCompleteListener to receive CRSCompleteEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireCRSCompleteEvent

void fireCRSCompleteEvent(CRSCompleteEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeCRSCompleteListener

void removeCRSCompleteListener(CRSCompleteListener listener,
                               Qualifier qualifier)

Stops the given CRSCompleteListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addDeviceTypeListener

void addDeviceTypeListener(DeviceTypeListener listener,
                           Qualifier qualifier)

Adds DeviceTypeListener to receive DeviceTypeEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

fireDeviceTypeEvent

void fireDeviceTypeEvent(DeviceTypeEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies.

NOTE - Please do not use this method. They are for intended for internal use only.

Parameters:

event - the object representing the event that has occurred.

removeDeviceTypeListener

void removeDeviceTypeListener(DeviceTypeListener listener,
                              Qualifier qualifier)

Stops the given DeviceTypeListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

fireNodeTypeEvent

void fireNodeTypeEvent(NodeTypeEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies().

Parameters:

event - the object representing the event that has occurred.

removeNodeTypeListener

void removeNodeTypeListener(NodeTypeListener listener,
                            Qualifier qualifier)

Stops the given NodeTypeListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

fireNodeEvent

void fireNodeEvent(NodeEvent event)

This method will notify all registered listeners that the given event has occurred. The listeners that are to be notified must return true on the call to Qualifier.qualifies().

Parameters:

event - the object representing the event that has occurred.

removeNodeListener

void removeNodeListener(NodeListener listener,
                        Qualifier qualifier)

Stops the given NodeListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.

addFileListener

void addFileListener(FileListener listener,
                     Qualifier qualifier)

Adds FileListener to receive FileEvents that satisfy the given Qualifier.

Parameters:

listener - the listener to notify when the event has occured.

qualifier - the qualifier to use to determine which events to be notified on.

Throws:

RegistrationFailedException - if the listener registration fails.

removeFileListener

void removeFileListener(FileListener listener,
                        Qualifier qualifier)

Stops the given FileListener from receiving event notifications of events that satisfy the given qualifier.

Parameters:

listener - the listener to stop receiving the notifications.

qualifier - the qualifier to use to determine which events to be notified on.