org.apache.qpid.client

Class AMQSession_0_10

java.lang.Object

org.apache.qpid.client.Closeable

org.apache.qpid.client.AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

org.apache.qpid.client.AMQSession_0_10

All Implemented Interfaces:

Runnable, javax.jms.QueueSession, javax.jms.Session, javax.jms.TopicSession, SessionListener

Direct Known Subclasses:

XASessionImpl

public class AMQSession_0_10
extends AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>
implements SessionListener

This is a 0.10 Session

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.qpid.client.AMQSession

AMQSession.Dispatchable, AMQSession.IdToConsumerMap<C extends BasicMessageConsumer>

Field Summary

Fields inherited from class org.apache.qpid.client.AMQSession

DEAMON_DISPATCHER_THREAD, IMMEDIATE_PREFETCH, IMMEDIATE_PREFETCH_DEFAULT, STRICT_AMQP, STRICT_AMQP_DEFAULT, STRICT_AMQP_FATAL, STRICT_AMQP_FATAL_DEFAULT

Fields inherited from interface org.apache.qpid.jms.Session

NO_ACKNOWLEDGE, PRE_ACKNOWLEDGE

Fields inherited from interface javax.jms.Session

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Method Summary

Methods

Modifier and Type	Method and Description
protected void	acknowledgeImpl()
void	acknowledgeMessage(long deliveryTag, boolean multiple) Acknowledge one or many messages.
protected void	addDeliveredMessage(long id) Store non committed messages for this session
void	closed(Session ssn)
void	commitImpl()
BasicMessageConsumer_0_10	createMessageConsumer(AMQDestination destination, int prefetchHigh, int prefetchLow, boolean noLocal, boolean exclusive, String messageSelector, FieldTable rawSelector, boolean noConsume, boolean autoClose) Create an 0_10 message consumer
BasicMessageProducer_0_10	createMessageProducer(javax.jms.Destination destination, Boolean mandatory, Boolean immediate, long producerId) Create an 0_10 message producer
protected Session	createSession()
protected AMQShortString	declareQueue(AMQDestination amqd, boolean noLocal, boolean nowait, boolean passive)
protected void	doBind(AMQDestination dest, AMQDestination.Binding binding, String queue, String exchange)
void	exception(Session ssn, SessionException exc)
protected void	flushAcknowledgments()
AMQException	getCurrentException() Get the latest thrown exception.
AMQException	getLastException()
AMQMessageDelegateFactory	getMessageDelegateFactory()
protected Connection	getQpidConnection()
protected Session	getQpidSession() Access to the underlying Qpid Session
protected void	handleQueueNodeCreation(AMQDestination dest, boolean noLocal)
protected boolean	isBound(AMQShortString exchangeName, AMQShortString amqQueueName, AMQShortString routingKey)
boolean	isExchangeExist(AMQDestination dest, boolean assertNode)
boolean	isFlowBlocked() Tests whether flow to this session is blocked.
boolean	isQueueBound(AMQDestination destination)
boolean	isQueueBound(AMQShortString exchangeName, AMQShortString queueName, AMQShortString routingKey) Bind a queue with an exchange.
boolean	isQueueBound(AMQShortString exchangeName, AMQShortString queueName, AMQShortString routingKey, AMQShortString[] bindingKeys)
boolean	isQueueBound(String exchangeName, String queueName, String bindingKey, Map<String,Object> args)
boolean	isQueueExist(AMQDestination dest, boolean assertNode)
boolean	isQueueExist(String queueName, boolean assertNode, boolean durable, boolean autoDelete, boolean exclusive, Map<String,Object> args)
void	message(Session ssn, MessageTransfer xfr)
void	opened(Session ssn)
void	rejectMessage(long deliveryTag, boolean requeue) Release (0_8 notion of Reject) an acquired message
void	releaseForRollback()
protected Long	requestQueueDepth(AMQDestination amqd, boolean sync)
int	resolveAddressType(AMQDestination dest)
void	resumed(Session ssn)
AMQShortString	send0_10QueueDeclare(AMQDestination amqd, boolean noLocal, boolean nowait, boolean passive) Declare a queue with the given queueName
void	sendClose(long timeout) Close this session.
void	sendConsume(BasicMessageConsumer_0_10 consumer, AMQShortString queueName, boolean nowait, int tag) This method is invoked when a consumer is created Registers the consumer with the broker
void	sendCreateQueue(AMQShortString name, boolean autoDelete, boolean durable, boolean exclusive, Map<String,Object> arguments) Create a queue with a given name.
void	sendExchangeDeclare(AMQShortString name, AMQShortString type, boolean nowait, boolean durable, boolean autoDelete, boolean internal) creates an exchange if it does not already exist
void	sendExchangeDeclare(AMQShortString name, AMQShortString type, boolean nowait, boolean durable, boolean autoDelete, FieldTable arguments, boolean passive)
void	sendExchangeDeclare(String name, String type, String alternateExchange, Map<String,Object> args, boolean nowait, boolean durable, boolean autoDelete)
void	sendExchangeDelete(String name, boolean nowait) deletes an exchange
void	sendQueueBind(AMQShortString queueName, AMQShortString routingKey, FieldTable arguments, AMQShortString exchangeName, AMQDestination destination, boolean nowait) Bind a queue with an exchange.
void	sendQueueDelete(AMQShortString queueName) deletes a queue
void	sendRecover() This method asks the broker to redeliver all unacknowledged messages
void	sendRollback()
void	sendSuspendChannel(boolean suspend) Activate/deactivate the message flow for all the consumers of this session.
protected void	sendTxCompletionsIfNecessary() With 0.10 messages are consumed with window mode, we must send a completion before the window size is reached so credits don't dry up.
void	setCurrentException(SessionException se)
void	setFlowControl(boolean active)
void	sync()
protected boolean	tagLE(long tag1, long tag2)
protected boolean	updateRollbackMark(long currentMark, long deliveryTag)

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

acknowledge, addBindingKey, addUnacknowledgedMessage, bindQueue, bindQueue, checkNotClosed, checkTransacted, checkValidTopic, checkValidTopic, close, close, closed, commit, confirmConsumerCancelled, createBrowser, createBrowser, createBrowserConsumer, createBytesMessage, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumerImpl, createDurableSubscriber, createDurableSubscriber, createListMessage, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createProducer, createProducer, createPublisher, createQueue, createQueue, createQueue, createQueueReceiver, createQueueReceiver, createReceiver, createReceiver, createSender, createStreamMessage, createSubscriber, createSubscriber, createTemporaryQueue, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, declareAndBind, declareAndBind, declareExchange, declareQueue, declareQueue, deleteQueue, deleteTemporaryDestination, dispatch, getAcknowledgeMode, getAMQConnection, getChannelId, getConsumers, getDefaultPrefetch, getDefaultPrefetchHigh, getDefaultPrefetchLow, getDefaultQueueExchangeName, getDefaultTopicExchangeName, getDeliveredMessageTags, getDispatcher, getDispatcherThread, getFailoverMutex, getHighestDeliveryTag, getMessageFactoryRegistry, getMessageListener, getPrefetch, getPrefetchedMessageTags, getQueueDepth, getQueueDepth, getTemporaryQueueExchangeName, getTemporaryTopicExchangeName, getTicket, getTransacted, getUnacknowledgedMessageTags, hasConsumer, hasFailedOverDirty, hasMessageListeners, isClosed, isClosing, isDeclareExchanges, isImmediatePrefetch, isStrictAMQP, isSuspended, isTransacted, markClean, markDirty, messageReceived, prefetch, preprocessAddressTopic, recover, rejectMessage, rejectMessage, resolveAddress, rollback, run, setLegacyFieldsForQueueType, setLegacyFieldsForTopicType, setMessageListener, setTicket, setUsingDispatcherForCleanup, stopDispatcherThread, suspendChannel, unsubscribe, verifySubject

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

resetClosedFlag, setClosed, setClosing

Methods inherited from class java.lang.Object

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

Method Detail

createSession

protected Session createSession()

getQpidConnection

protected Connection getQpidConnection()

acknowledgeMessage

public void acknowledgeMessage(long deliveryTag,
                      boolean multiple)

Acknowledge one or many messages.

Specified by:

acknowledgeMessage in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Parameters:

deliveryTag - The tag of the last message to be acknowledged.

multiple - true to acknowledge all messages up to and including the one specified by the delivery tag, false to just acknowledge that message.

flushAcknowledgments

protected void flushAcknowledgments()

Specified by:

flushAcknowledgments in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

sendQueueBind

public void sendQueueBind(AMQShortString queueName,
                 AMQShortString routingKey,
                 FieldTable arguments,
                 AMQShortString exchangeName,
                 AMQDestination destination,
                 boolean nowait)
                   throws AMQException

Bind a queue with an exchange.

Specified by:

sendQueueBind in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Parameters:

queueName - Specifies the name of the queue to bind. If the queue name is empty, refers to the current queue for the session, which is the last declared queue.

exchangeName - The exchange name.

routingKey - Specifies the routing key for the binding.

arguments - 0_8 specific

Throws:

AMQException

sendClose

public void sendClose(long timeout)
               throws AMQException,
                      FailoverException

Close this session.

Specified by:

sendClose in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Parameters:

timeout - no used / 0_8 specific

Throws:

AMQException

FailoverException

sendCreateQueue

public void sendCreateQueue(AMQShortString name,
                   boolean autoDelete,
                   boolean durable,
                   boolean exclusive,
                   Map<String,Object> arguments)
                     throws AMQException,
                            FailoverException

Create a queue with a given name.

Specified by:

sendCreateQueue in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Parameters:

name - The queue name

autoDelete - If this field is set and the exclusive field is also set, then the queue is deleted when the connection closes.

durable - If set when creating a new queue, the queue will be marked as durable.

exclusive - Exclusive queues can only be used from one connection at a time.

arguments - Exclusive queues can only be used from one connection at a time.

Throws:

AMQException

FailoverException

sendRecover

public void sendRecover()
                 throws AMQException,
                        FailoverException

This method asks the broker to redeliver all unacknowledged messages

Specified by:

sendRecover in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

releaseForRollback

public void releaseForRollback()

Specified by:

releaseForRollback in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

rejectMessage

public void rejectMessage(long deliveryTag,
                 boolean requeue)

Release (0_8 notion of Reject) an acquired message

Specified by:

rejectMessage in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Parameters:

deliveryTag - the message ID

requeue - always true

createMessageConsumer

public BasicMessageConsumer_0_10 createMessageConsumer(AMQDestination destination,
                                              int prefetchHigh,
                                              int prefetchLow,
                                              boolean noLocal,
                                              boolean exclusive,
                                              String messageSelector,
                                              FieldTable rawSelector,
                                              boolean noConsume,
                                              boolean autoClose)
                                                throws javax.jms.JMSException

Create an 0_10 message consumer

Specified by:

createMessageConsumer in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

javax.jms.JMSException

isQueueBound

public boolean isQueueBound(AMQShortString exchangeName,
                   AMQShortString queueName,
                   AMQShortString routingKey)

Bind a queue with an exchange.

Specified by:

isQueueBound in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Parameters:

exchangeName - The exchange name to test for binding against.

queueName - The queue name to check if bound.

routingKey - The routing key to check if the queue is bound under.

Returns:

true if the queue is bound to the exchange and routing key, false if not.

isQueueBound

public boolean isQueueBound(AMQDestination destination)

Specified by:

isQueueBound in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

isQueueBound

public boolean isQueueBound(AMQShortString exchangeName,
                   AMQShortString queueName,
                   AMQShortString routingKey,
                   AMQShortString[] bindingKeys)

isQueueBound

public boolean isQueueBound(String exchangeName,
                   String queueName,
                   String bindingKey,
                   Map<String,Object> args)

Specified by:

isQueueBound in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

isBound

protected boolean isBound(AMQShortString exchangeName,
              AMQShortString amqQueueName,
              AMQShortString routingKey)

Specified by:

isBound in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

sendConsume

public void sendConsume(BasicMessageConsumer_0_10 consumer,
               AMQShortString queueName,
               boolean nowait,
               int tag)
                 throws AMQException,
                        FailoverException

This method is invoked when a consumer is created Registers the consumer with the broker

Specified by:

sendConsume in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

createMessageProducer

public BasicMessageProducer_0_10 createMessageProducer(javax.jms.Destination destination,
                                              Boolean mandatory,
                                              Boolean immediate,
                                              long producerId)
                                                throws javax.jms.JMSException

Create an 0_10 message producer

Specified by:

createMessageProducer in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

javax.jms.JMSException

sendExchangeDeclare

public void sendExchangeDeclare(AMQShortString name,
                       AMQShortString type,
                       boolean nowait,
                       boolean durable,
                       boolean autoDelete,
                       boolean internal)
                         throws AMQException,
                                FailoverException

creates an exchange if it does not already exist

Specified by:

sendExchangeDeclare in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

sendExchangeDeclare

public void sendExchangeDeclare(AMQShortString name,
                       AMQShortString type,
                       boolean nowait,
                       boolean durable,
                       boolean autoDelete,
                       FieldTable arguments,
                       boolean passive)
                         throws AMQException,
                                FailoverException

Specified by:

sendExchangeDeclare in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

sendExchangeDeclare

public void sendExchangeDeclare(String name,
                       String type,
                       String alternateExchange,
                       Map<String,Object> args,
                       boolean nowait,
                       boolean durable,
                       boolean autoDelete)
                         throws AMQException

Throws:

AMQException

sendExchangeDelete

public void sendExchangeDelete(String name,
                      boolean nowait)
                        throws AMQException,
                               FailoverException

deletes an exchange

Throws:

AMQException

FailoverException

send0_10QueueDeclare

public AMQShortString send0_10QueueDeclare(AMQDestination amqd,
                                  boolean noLocal,
                                  boolean nowait,
                                  boolean passive)
                                    throws AMQException

Declare a queue with the given queueName

Throws:

AMQException

sendQueueDelete

public void sendQueueDelete(AMQShortString queueName)
                     throws AMQException,
                            FailoverException

deletes a queue

Specified by:

sendQueueDelete in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

sendSuspendChannel

public void sendSuspendChannel(boolean suspend)
                        throws AMQException,
                               FailoverException

Activate/deactivate the message flow for all the consumers of this session.

Specified by:

sendSuspendChannel in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

sendRollback

public void sendRollback()
                  throws AMQException,
                         FailoverException

Specified by:

sendRollback in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

getQpidSession

protected Session getQpidSession()

Access to the underlying Qpid Session

Returns:

The associated Qpid Session.

getCurrentException

public AMQException getCurrentException()

Get the latest thrown exception.

Throws:

SessionException - get the latest thrown error.

opened

public void opened(Session ssn)

Specified by:

opened in interface SessionListener

resumed

public void resumed(Session ssn)

Specified by:

resumed in interface SessionListener

message

public void message(Session ssn,
           MessageTransfer xfr)

Specified by:

message in interface SessionListener

exception

public void exception(Session ssn,
             SessionException exc)

Specified by:

exception in interface SessionListener

closed

public void closed(Session ssn)

Specified by:

closed in interface SessionListener

getLastException

public AMQException getLastException()

Specified by:

getLastException in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

declareQueue

protected AMQShortString declareQueue(AMQDestination amqd,
                          boolean noLocal,
                          boolean nowait,
                          boolean passive)
                               throws AMQException

Specified by:

declareQueue in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

requestQueueDepth

protected Long requestQueueDepth(AMQDestination amqd,
                     boolean sync)

Specified by:

requestQueueDepth in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

addDeliveredMessage

protected void addDeliveredMessage(long id)

Store non committed messages for this session

Overrides:

addDeliveredMessage in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Parameters:

id -

sendTxCompletionsIfNecessary

protected void sendTxCompletionsIfNecessary()

With 0.10 messages are consumed with window mode, we must send a completion before the window size is reached so credits don't dry up.

commitImpl

public void commitImpl()
                throws AMQException,
                       FailoverException,
                       TransportException

Specified by:

commitImpl in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

FailoverException

TransportException

tagLE

protected final boolean tagLE(long tag1,
            long tag2)

Specified by:

tagLE in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

updateRollbackMark

protected final boolean updateRollbackMark(long currentMark,
                         long deliveryTag)

Specified by:

updateRollbackMark in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

sync

public void sync()
          throws AMQException

Specified by:

sync in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

setCurrentException

public void setCurrentException(SessionException se)

getMessageDelegateFactory

public AMQMessageDelegateFactory getMessageDelegateFactory()

Specified by:

getMessageDelegateFactory in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

isExchangeExist

public boolean isExchangeExist(AMQDestination dest,
                      boolean assertNode)
                        throws AMQException

Specified by:

isExchangeExist in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

isQueueExist

public boolean isQueueExist(AMQDestination dest,
                   boolean assertNode)
                     throws AMQException

Specified by:

isQueueExist in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

isQueueExist

public boolean isQueueExist(String queueName,
                   boolean assertNode,
                   boolean durable,
                   boolean autoDelete,
                   boolean exclusive,
                   Map<String,Object> args)
                     throws AMQException

Throws:

AMQException

resolveAddressType

public int resolveAddressType(AMQDestination dest)
                       throws AMQException

Specified by:

resolveAddressType in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

acknowledgeImpl

protected void acknowledgeImpl()

Specified by:

acknowledgeImpl in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

isFlowBlocked

public boolean isFlowBlocked()

Description copied from class: AMQSession

Tests whether flow to this session is blocked.

Specified by:

isFlowBlocked in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Returns:

true if flow is blocked or false otherwise.

setFlowControl

public void setFlowControl(boolean active)

Specified by:

setFlowControl in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

handleQueueNodeCreation

protected void handleQueueNodeCreation(AMQDestination dest,
                           boolean noLocal)
                                throws AMQException

Specified by:

handleQueueNodeCreation in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>

Throws:

AMQException

doBind

protected void doBind(AMQDestination dest,
          AMQDestination.Binding binding,
          String queue,
          String exchange)

Specified by:

doBind in class AMQSession<BasicMessageConsumer_0_10,BasicMessageProducer_0_10>