org.wso2.broker.core

Interface Consumer

public interface Consumer

Interface representing broker subscription.

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying transport consumer.
String	getConsumerTag() Identifier for the consumer.
String	getQueueName() Queue name of the subscriber queue.
boolean	isExclusive() If true only this consumer can access the queue and consume messages.
void	send(Message message) Send message to the consumer.

Method Detail

send

void send(Message message)
   throws BrokerException

Send message to the consumer.

Parameters:

message - Message to be sent to the consumer

Throws:

BrokerException - throws BrokerException on message sending failure

getQueueName

String getQueueName()

Queue name of the subscriber queue.

Returns:

queue name

close

void close()
    throws BrokerException

Close the underlying transport consumer.

Throws:

BrokerException

getConsumerTag

String getConsumerTag()

Identifier for the consumer. This consumer tag should be local to a channel.

Returns:

isExclusive

boolean isExclusive()

If true only this consumer can access the queue and consume messages.

Returns:

True if the consumer is exclusive. False otherwise