com.cisco.provisioning.cpe.events
Class MessagingAdapter

java.lang.Object
  com.cisco.provisioning.cpe.events.MessagingAdapter

All Implemented Interfaces:

MessagingListener, ProvAPIEventListener

public abstract class MessagingAdapter
extends Object
implements MessagingListener

An abstract class that provides no-op definitions of all methods in the MessagingListener interface. Users must extend this class, and then implement the methods for the desired MessagingEvent sub-event notifications.

Field Summary

Fields inherited from interface com.cisco.provisioning.cpe.events.MessagingListener

CONNECTION_DOWN, CONNECTION_UP, MESSAGING_QUEUE_FULL

Constructor Summary

MessagingAdapter()

Method Summary

void	connectionStarted(MessagingEvent ev) The method invoked when a MessagingEvent arrives as a result of a Connection starting.
void	connectionStopped(MessagingEvent ev) The method invoked when a MessagingEvent arrives as a result of a connection stopping.
boolean	getOneShot() Gets oneShot mode value, specifying whether or not the listener is registered for just one occurrence of the Event.
void	messagingQueuefull(MessagingEvent ev) The method invoked when a MessagingEvent arrives as a result of the messaging system runs into a queue limit and drops the message.
void	setOneShot(boolean flg) Sets oneShot mode, specifying that the registration request is for just one occurrence of the Event.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessagingAdapter

public MessagingAdapter()

Method Detail

connectionStarted

public void connectionStarted(MessagingEvent ev)

The method invoked when a MessagingEvent arrives as a result of a Connection starting.

Specified by:

connectionStarted in interface MessagingListener

Parameters:

ev - The object containing the MessagingEvent data.

connectionStopped

public void connectionStopped(MessagingEvent ev)

The method invoked when a MessagingEvent arrives as a result of a connection stopping.

Specified by:

connectionStopped in interface MessagingListener

Parameters:

ev - The object containing the MessagingEvent data.

messagingQueuefull

public void messagingQueuefull(MessagingEvent ev)

The method invoked when a MessagingEvent arrives as a result of the messaging system runs into a queue limit and drops the message.

Specified by:

messagingQueuefull in interface MessagingListener

Parameters:

ev - The object containing the MessagingEvent data.

getOneShot

public boolean getOneShot()

Gets oneShot mode value, specifying whether or not the listener is registered for just one occurrence of the Event.

Specified by:

getOneShot in interface ProvAPIEventListener

Returns:

true if oneShot mode has been set

setOneShot

public void setOneShot(boolean flg)

Sets oneShot mode, specifying that the registration request is for just one occurrence of the Event.

Specified by:

setOneShot in interface ProvAPIEventListener

Parameters:

flg - true if oneShot mode is being set