org.hawkular.bus.common.consumer

Class FutureBasicMessageListener<T extends BasicMessage>

java.lang.Object

org.hawkular.bus.common.consumer.AbstractBasicMessageListener<T>

org.hawkular.bus.common.consumer.BasicMessageListener<T>

org.hawkular.bus.common.consumer.FutureBasicMessageListener<T>

Type Parameters:

T - the type of message that is expected to be received

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<BasicMessageWithExtraData<T>>, Future<BasicMessageWithExtraData<T>>, javax.jms.MessageListener

public class FutureBasicMessageListener<T extends BasicMessage>
extends BasicMessageListener<T>
implements com.google.common.util.concurrent.ListenableFuture<BasicMessageWithExtraData<T>>

This listener waits for a single incoming message and returns it within the context of the Future API. Once the message is received, the consumer associated with this listener will be closed. This is not intended to receive a series of messages; it is only expected that the consumer will receive a single message. This is useful, for example, to process a response from a single RPC call over a temporary queue. To use this, just register this as a message listener and call one of the get() methods to block waiting for the response.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
FutureBasicMessageListener()
FutureBasicMessageListener(Class<T> jsonDecoderRing)

Method Summary

Modifier and Type	Method and Description
void	addListener(Runnable listener, Executor exec)
boolean	cancel(boolean mayInterruptIfRunning)
protected void	closeConsumer()
BasicMessageWithExtraData<T>	get()
BasicMessageWithExtraData<T>	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
protected void	onBasicMessage(BasicMessageWithExtraData<T> msgWithData) Subclasses implement this method to process the received message.
String	toString()

Methods inherited from class org.hawkular.bus.common.consumer.BasicMessageListener

onBasicMessage, onMessage

Methods inherited from class org.hawkular.bus.common.consumer.AbstractBasicMessageListener

determineBasicMessageClass, getBasicMessageClass, getConsumerConnectionContext, getLog, parseMessage, setConsumerConnectionContext

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureBasicMessageListener

public FutureBasicMessageListener()

FutureBasicMessageListener

public FutureBasicMessageListener(Class<T> jsonDecoderRing)

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<BasicMessageWithExtraData<T extends BasicMessage>>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<BasicMessageWithExtraData<T extends BasicMessage>>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<BasicMessageWithExtraData<T extends BasicMessage>>

get

public BasicMessageWithExtraData<T> get()
                                 throws InterruptedException,
                                        ExecutionException

Specified by:

get in interface Future<BasicMessageWithExtraData<T extends BasicMessage>>

Throws:

InterruptedException

ExecutionException

get

public BasicMessageWithExtraData<T> get(long timeout,
                                        TimeUnit unit)
                                 throws InterruptedException,
                                        ExecutionException,
                                        TimeoutException

Specified by:

get in interface Future<BasicMessageWithExtraData<T extends BasicMessage>>

Throws:

InterruptedException

ExecutionException

TimeoutException

addListener

public void addListener(Runnable listener,
                        Executor exec)

Specified by:

addListener in interface com.google.common.util.concurrent.ListenableFuture<BasicMessageWithExtraData<T extends BasicMessage>>

onBasicMessage

protected void onBasicMessage(BasicMessageWithExtraData<T> msgWithData)

Description copied from class: BasicMessageListener

Subclasses implement this method to process the received message. If subclasses would rather just receive the BasicMessage, it can do so by overriding BasicMessageListener.onBasicMessage(BasicMessage) and leaving this method as-is (that is, do NOT override this method).

Overrides:

onBasicMessage in class BasicMessageListener<T extends BasicMessage>

Parameters:

msgWithData - the basic message received with any extra data that came with it

closeConsumer

protected void closeConsumer()
                      throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object