org.granite.client.messaging

Class Consumer

java.lang.Object

org.granite.client.messaging.AbstractTopicAgent

org.granite.client.messaging.Consumer

All Implemented Interfaces:

TopicAgent

public class Consumer
extends AbstractTopicAgent

Consumer class that allows to receive messages from a remote pub/sub destination

 Consumer consumer = new Consumer(messagingChannel, "myDestination", "myTopic");
 consumer.subscribe().get();
 consumer.addMessageListener(new TopicMessageListener() {
     public void onMessage(TopicMessageEvent event) {
         System.out.println("Received: " + event.getData());
     }
 });
 
 

Author:

Franck WOLFF

Field Summary

Fields inherited from class org.granite.client.messaging.AbstractTopicAgent

channel, defaultHeaders, destination, topic

Constructor Summary

Constructors

Constructor and Description
Consumer(MessagingChannel channel, java.lang.String destination, java.lang.String topic) Create a consumer for the specified channel and destination

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessageListener(TopicMessageListener listener) Register a message listener for this consumer
void	addSubscriptionListener(TopicSubscriptionListener listener) Register a subscription listener for this consumer
java.lang.String	getSelector() Message selector for this consumer
java.lang.String	getSubscriptionId() Current subscription id received from the server
boolean	isSubscribed() Is this consumer subscribed ?
void	onDisconnect() Called when the channel is disconnected
void	onMessage(TopicMessage message) Called when a message is received on the channel
boolean	removeMessageListener(TopicMessageListener listener) Unregister a message listener for this consumer
boolean	removeSubscriptionListener(TopicSubscriptionListener listener) Unregister a subscription listener for this consumer
void	reply(TopicMessage message, java.lang.Object reply) Reply to a server-to-client request
void	setSelector(java.lang.String selector) Set the message selector for this consumer This must be set before subscribing to the destination It is necessary to resubscribe to the destination after changing its value
ResponseMessageFuture	subscribe(ResponseListener... listeners) Subscribe to the remote destination
java.lang.String	toString()
ResponseMessageFuture	unsubscribe(ResponseListener... listeners) Unubscribe from the remote destination

Methods inherited from class org.granite.client.messaging.AbstractTopicAgent

getChannel, getDefaultHeaders, getDestination, getTopic

Methods inherited from class java.lang.Object

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

Constructor Detail

Consumer

public Consumer(MessagingChannel channel,
        java.lang.String destination,
        java.lang.String topic)

Create a consumer for the specified channel and destination

Parameters:

channel - messaging channel

destination - remote destination

topic - subtopic to which the producer sends its messages

Method Detail

getSelector

public java.lang.String getSelector()

Message selector for this consumer

Returns:

selector

setSelector

public void setSelector(java.lang.String selector)

Set the message selector for this consumer This must be set before subscribing to the destination It is necessary to resubscribe to the destination after changing its value

Parameters:

selector - selector

isSubscribed

public boolean isSubscribed()

Is this consumer subscribed ?

Returns:

true if subscribed

getSubscriptionId

public java.lang.String getSubscriptionId()

Current subscription id received from the server

Returns:

subscription id

subscribe

public ResponseMessageFuture subscribe(ResponseListener... listeners)

Subscribe to the remote destination

Parameters:

listeners - array of listeners notified when the subscription is processed

Returns:

future triggered when subscription is processed

unsubscribe

public ResponseMessageFuture unsubscribe(ResponseListener... listeners)

Unubscribe from the remote destination

Parameters:

listeners - array of listeners notified when the unsubscription is processed

Returns:

future triggered when unsubscription is processed

addMessageListener

public void addMessageListener(TopicMessageListener listener)

Register a message listener for this consumer

Parameters:

listener - message listener

removeMessageListener

public boolean removeMessageListener(TopicMessageListener listener)

Unregister a message listener for this consumer

Parameters:

listener - message listener

Returns:

true if the listener was actually removed (if it was registered before)

addSubscriptionListener

public void addSubscriptionListener(TopicSubscriptionListener listener)

Register a subscription listener for this consumer

Parameters:

listener - subscription listener

removeSubscriptionListener

public boolean removeSubscriptionListener(TopicSubscriptionListener listener)

Unregister a subscription listener for this consumer

Parameters:

listener - subscription listener

Returns:

true if the listener was actually removed (if it was registered before)

onDisconnect

public void onDisconnect()

Called when the channel is disconnected

onMessage

public void onMessage(TopicMessage message)

Called when a message is received on the channel

Parameters:

message - message received

reply

public void reply(TopicMessage message,
         java.lang.Object reply)

Reply to a server-to-client request

Parameters:

message - incoming request message

reply - response to send

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object