com.ibm.mqlight.api

Class DestinationAdapter<T>

java.lang.Object

com.ibm.mqlight.api.DestinationAdapter<T>

All Implemented Interfaces:

DestinationListener<T>

public abstract class DestinationAdapter<T>
extends Object
implements DestinationListener<T>

An abstract adapter class for receiving destination events. The methods in this class are empty. This class exists as convenience for creating destination listener objects. Extend this class to create a DestinationListener object and override the methods for the events of interest. (If you implement the DestinationListener interface, you have to define all of the methods in it. This abstract class defines null methods for them all, so you can only have to define methods for events you care about.)

Constructor Summary

Constructors

Constructor and Description
DestinationAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	onMalformed(NonBlockingClient client, T context, MalformedDelivery delivery) Invoked to deliver a malformed message to the client.
void	onMessage(NonBlockingClient client, T context, Delivery delivery) Invoked to deliver a message to the client.
void	onUnsubscribed(NonBlockingClient client, T context, String topicPattern, String share, Exception error) Invoked to provide a notification that the client is no longer subscribed to a destination that this DestinationListneer has previously being associated with.

Methods inherited from class java.lang.Object

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

Constructor Detail

DestinationAdapter

public DestinationAdapter()

Method Detail

onMessage

public void onMessage(NonBlockingClient client,
             T context,
             Delivery delivery)

Description copied from interface: DestinationListener

Invoked to deliver a message to the client.

Specified by:

onMessage in interface DestinationListener<T>

Parameters:

client - the client that this DestinationListener was registered with.

context - the context object that was supplied when this instance of the DestinationListener was registered with the NonBlockingClient.

delivery - an object that contains both information about the message delivery and the payload of the message itself.

onMalformed

public void onMalformed(NonBlockingClient client,
               T context,
               MalformedDelivery delivery)

Description copied from interface: DestinationListener

Invoked to deliver a malformed message to the client. Malformed messages are messages that the MQ Light server cannot convert into an appropriate representation for the client.

Specified by:

onMalformed in interface DestinationListener<T>

Parameters:

client - the client that this DestinationListener was registered with.

context - the context object that was supplied when this instance of the DestinationListener was registered with the NonBlockingClient.

delivery - an object that contains both information about the message delivery and the payload of the message itself.

onUnsubscribed

public void onUnsubscribed(NonBlockingClient client,
                  T context,
                  String topicPattern,
                  String share,
                  Exception error)

Description copied from interface: DestinationListener

Invoked to provide a notification that the client is no longer subscribed to a destination that this DestinationListneer has previously being associated with.

Specified by:

onUnsubscribed in interface DestinationListener<T>

Parameters:

client - the client that this DestinationListener was registered with.

context - the context object that was supplied when this instance of the DestinationListener was registered with the NonBlockingClient.

topicPattern - the topic pattern which identifies the destination that the client is no longer subscribed to.

share - the share which identifies the destination that the client is no longer subscribed to. This will be null if the destination was private.

error - if set, this Exception indicates that the unsubscribe occurred due to an error condition which is detailed within.