org.apache.qpid.client

Class BasicMessageConsumer<U>

java.lang.Object

org.apache.qpid.client.Closeable

org.apache.qpid.client.BasicMessageConsumer<U>

All Implemented Interfaces:

javax.jms.MessageConsumer

Direct Known Subclasses:

BasicMessageConsumer_0_10, BasicMessageConsumer_0_8

public abstract class BasicMessageConsumer<U>
extends Closeable
implements MessageConsumer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicMessageConsumer(int channelId, AMQConnection connection, AMQDestination destination, String messageSelector, boolean noLocal, MessageFactoryRegistry messageFactory, AMQSession session, Map<String,Object> rawSelector, int prefetchHigh, int prefetchLow, boolean exclusive, int acknowledgeMode, boolean browseOnly, boolean autoClose)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBindingKey(AMQDestination amqd, String routingKey)
void	clearReceiveQueue()
void	close() Closes this object.
void	close(boolean sendClose)
abstract AbstractJMSMessage	createJMSMessageFromUnprocessedMessage(AMQMessageDelegateFactory delegateFactory, U messageFrame)
String	debugIdentity()
List<Long>	drainReceiverQueueAndRetrieveDeliveryTags()
void	failedOverPost()
void	failedOverPre() to be called when a failover has occured
int	getAcknowledgeMode() The acknowledge mode in force for this consumer.
Map<String,Object>	getArguments()
protected int	getChannelId() We need to know the channel id when constructing frames
protected AMQConnection	getConnection() The connection being used by this consumer
String	getConsumerTag() The consumer tag allows us to close the consumer by sending a jmsCancel method to the broker
AMQDestination	getDestination()
protected MessageFactoryRegistry	getMessageFactory()
Object	getMessageFromQueue(long l)
javax.jms.MessageListener	getMessageListener()
String	getMessageSelector()
MessageFilter	getMessageSelectorFilter()
int	getPrefetch()
int	getPrefetchHigh()
int	getPrefetchLow()
String	getQueuename()
AMQSession	getSession()
protected BlockingQueue	getSynchronousQueue() Used in the blocking receive methods to receive a message from the Session thread.
boolean	isAutoClose()
boolean	isBrowseOnly()
protected boolean	isDurableSubscriber()
boolean	isExclusive() We store the exclusive field in order to be able to reuse it when resubscribing in the event of failover
protected boolean	isMessageListenerSet()
boolean	isNoLocal()
boolean	isReceiving()
protected void	markAsDurableSubscriber()
void	notifyCloseMessage(CloseConsumerMessage closeMessage)
void	notifyMessage(AbstractJMSMessage jmsMessage)
protected void	preDeliver(AbstractJMSMessage msg)
javax.jms.Message	receive()
javax.jms.Message	receive(long l)
javax.jms.Message	receiveNoWait()
void	setConsumerTag(String consumerTag)
protected void	setDestination(AMQDestination destination)
void	setMessageListener(javax.jms.MessageListener messageListener)
void	setQueuename(String queuename)

Methods inherited from class org.apache.qpid.client.Closeable

checkNotClosed, isClosed, isClosing, setClosed, setClosing

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicMessageConsumer

protected BasicMessageConsumer(int channelId,
                    AMQConnection connection,
                    AMQDestination destination,
                    String messageSelector,
                    boolean noLocal,
                    MessageFactoryRegistry messageFactory,
                    AMQSession session,
                    Map<String,Object> rawSelector,
                    int prefetchHigh,
                    int prefetchLow,
                    boolean exclusive,
                    int acknowledgeMode,
                    boolean browseOnly,
                    boolean autoClose)
                        throws javax.jms.JMSException

Throws:

javax.jms.JMSException

Method Detail

getDestination

public AMQDestination getDestination()

getMessageSelector

public String getMessageSelector()
                          throws javax.jms.JMSException

Specified by:

getMessageSelector in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

getMessageListener

public javax.jms.MessageListener getMessageListener()
                                             throws javax.jms.JMSException

Specified by:

getMessageListener in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

getAcknowledgeMode

public int getAcknowledgeMode()

The acknowledge mode in force for this consumer. Note that the AMQP protocol allows different ack modes per consumer whereas JMS defines this at the session level, hence why we associate it with the consumer in our implementation.

isMessageListenerSet

protected boolean isMessageListenerSet()

setMessageListener

public void setMessageListener(javax.jms.MessageListener messageListener)
                        throws javax.jms.JMSException

Specified by:

setMessageListener in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

getArguments

public Map<String,Object> getArguments()

getPrefetch

public int getPrefetch()

getPrefetchHigh

public int getPrefetchHigh()

getPrefetchLow

public int getPrefetchLow()

isNoLocal

public boolean isNoLocal()

isExclusive

public boolean isExclusive()

We store the exclusive field in order to be able to reuse it when resubscribing in the event of failover

isReceiving

public boolean isReceiving()

getMessageSelectorFilter

public MessageFilter getMessageSelectorFilter()

receive

public javax.jms.Message receive()
                          throws javax.jms.JMSException

Specified by:

receive in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

receive

public javax.jms.Message receive(long l)
                          throws javax.jms.JMSException

Specified by:

receive in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

getMessageFromQueue

public Object getMessageFromQueue(long l)
                           throws InterruptedException

Throws:

InterruptedException

receiveNoWait

public javax.jms.Message receiveNoWait()
                                throws javax.jms.JMSException

Specified by:

receiveNoWait in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

close

public void close()
           throws javax.jms.JMSException

Description copied from class: Closeable

Closes this object.

Specified by:

close in interface javax.jms.MessageConsumer

Specified by:

close in class Closeable

Throws:

javax.jms.JMSException - If this cannot be closed for any reason.

close

public void close(boolean sendClose)
           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

notifyCloseMessage

public void notifyCloseMessage(CloseConsumerMessage closeMessage)

Parameters:

closeMessage - this message signals that we should close the browser

createJMSMessageFromUnprocessedMessage

public abstract AbstractJMSMessage createJMSMessageFromUnprocessedMessage(AMQMessageDelegateFactory delegateFactory,
                                                        U messageFrame)
                                                                   throws Exception

Throws:

Exception

notifyMessage

public void notifyMessage(AbstractJMSMessage jmsMessage)

Parameters:

jmsMessage - this message has already been processed so can't redo preDeliver

preDeliver

protected void preDeliver(AbstractJMSMessage msg)

getConsumerTag

public String getConsumerTag()

The consumer tag allows us to close the consumer by sending a jmsCancel method to the broker

setConsumerTag

public void setConsumerTag(String consumerTag)

getSession

public AMQSession getSession()

isAutoClose

public boolean isAutoClose()

isBrowseOnly

public boolean isBrowseOnly()

debugIdentity

public String debugIdentity()

clearReceiveQueue

public void clearReceiveQueue()

drainReceiverQueueAndRetrieveDeliveryTags

public List<Long> drainReceiverQueueAndRetrieveDeliveryTags()

getQueuename

public String getQueuename()

setQueuename

public void setQueuename(String queuename)

addBindingKey

public void addBindingKey(AMQDestination amqd,
                 String routingKey)
                   throws QpidException

Throws:

QpidException

failedOverPre

public void failedOverPre()

to be called when a failover has occured

failedOverPost

public void failedOverPost()

getConnection

protected AMQConnection getConnection()

The connection being used by this consumer

setDestination

protected void setDestination(AMQDestination destination)

getChannelId

protected int getChannelId()

We need to know the channel id when constructing frames

getSynchronousQueue

protected BlockingQueue getSynchronousQueue()

Used in the blocking receive methods to receive a message from the Session thread.

Or to notify of errors.

Argument true indicates we want strict FIFO semantics

getMessageFactory

protected MessageFactoryRegistry getMessageFactory()

isDurableSubscriber

protected boolean isDurableSubscriber()

markAsDurableSubscriber

protected void markAsDurableSubscriber()