com.amazon.sqs.javamessaging

Class SQSSession

java.lang.Object

com.amazon.sqs.javamessaging.SQSSession

public class SQSSession
extends java.lang.Object

A session serves several purposes:

• It is a factory for its message producers and consumers.
• It provides a way to create Queue objects for those clients that need to dynamically manipulate provider-specific destination names.
• It retains messages it consumes until they have been acknowledged.
• It serializes execution of message listeners registered with its message consumers.

Not safe for concurrent use.

This session object does not support:

• (Temporary)Topic
• Temporary Queue
• Browser
• MapMessage
• StreamMessage
• MessageSelector
• Transactions

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNORDERED_ACKNOWLEDGE Non standard acknowledge mode.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkClosed() Check if session is closed.
void	checkClosing() Check if session is closed or closing.
void	close() Closes the session.
void	commit() This method is not supported.
QueueBrowser	createBrowser(Queue queue) This method is not supported.
QueueBrowser	createBrowser(Queue queue, java.lang.String messageSelector) This method is not supported.
BytesMessage	createBytesMessage() Creates a BytesMessage.
MessageConsumer	createConsumer(Destination destination) Creates a MessageConsumer for the specified destination.
MessageConsumer	createConsumer(Destination destination, java.lang.String messageSelector) Creates a MessageConsumer for the specified destination.
MessageConsumer	createConsumer(Destination destination, java.lang.String messageSelector, boolean NoLocal) Creates a MessageConsumer for the specified destination.
TopicSubscriber	createDurableSubscriber(Topic topic, java.lang.String name) This method is not supported.
TopicSubscriber	createDurableSubscriber(Topic topic, java.lang.String name, java.lang.String messageSelector, boolean noLocal) This method is not supported.
MapMessage	createMapMessage() This method is not supported.
Message	createMessage() According to JMS specification, a message can be sent with only headers without any payload, SQS does not support messages with empty payload.
ObjectMessage	createObjectMessage() Creates a ObjectMessage.
ObjectMessage	createObjectMessage(java.io.Serializable object) Creates an initialized ObjectMessage.
MessageProducer	createProducer(Destination destination) Creates a MessageProducer for the specified destination.
Queue	createQueue(java.lang.String queueName) This does not create SQS Queue.
Queue	createQueue(java.lang.String queueName, java.lang.String ownerAccountId) This does not create SQS Queue.
QueueReceiver	createReceiver(Queue queue) Creates a QueueReceiver for the specified queue.
QueueReceiver	createReceiver(Queue queue, java.lang.String messageSelector) Creates a QueueReceiver for the specified queue.
QueueSender	createSender(Queue queue) Creates a QueueSender for the specified queue.
StreamMessage	createStreamMessage() This method is not supported.
TemporaryQueue	createTemporaryQueue() This method is not supported.
TemporaryTopic	createTemporaryTopic() This method is not supported.
TextMessage	createTextMessage() Creates a TextMessage.
TextMessage	createTextMessage(java.lang.String text) Creates an initialized TextMessage.
Topic	createTopic(java.lang.String topicName) This method is not supported.
int	getAcknowledgeMode() Returns the acknowledge mode of the session.
MessageListener	getMessageListener() This method is not supported.
boolean	getTransacted() SQS does not support transacted.
void	recover() Negative acknowledges all the messages on the session that is delivered but not acknowledged.
void	rollback() This method is not supported.
void	run()
void	setMessageListener(MessageListener listener) This method is not supported.
void	unsubscribe(java.lang.String name) This method is not supported.

Methods inherited from class java.lang.Object

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

Field Detail

UNORDERED_ACKNOWLEDGE

public static final int UNORDERED_ACKNOWLEDGE

Non standard acknowledge mode. This is a variation of CLIENT_ACKNOWLEDGE where Clients need to remember to call acknowledge on message. Difference is that calling acknowledge on a message only acknowledge the message being called.

See Also:

Constant Field Values

Method Detail

createReceiver

public QueueReceiver createReceiver(Queue queue)
                             throws JMSException

Creates a QueueReceiver for the specified queue.

Parameters:

queue - a queue receiver

Returns:

new message consumer

Throws:

JMSException - If session is closed

createReceiver

public QueueReceiver createReceiver(Queue queue,
                           java.lang.String messageSelector)
                             throws JMSException

Creates a QueueReceiver for the specified queue. Does not support messageSelector. It will drop anything in messageSelector.

Parameters:

queue - a queue destination

messageSelector -

Returns:

new message receiver

Throws:

JMSException - If session is closed

createSender

public QueueSender createSender(Queue queue)
                         throws JMSException

Creates a QueueSender for the specified queue.

Parameters:

queue - a queue destination

Returns:

new message sender

Throws:

JMSException - If session is closed

createBytesMessage

public BytesMessage createBytesMessage()
                                throws JMSException

Creates a BytesMessage.

Returns:

new BytesMessage

Throws:

JMSException - If session is closed or internal error

createMessage

public Message createMessage()
                      throws JMSException

According to JMS specification, a message can be sent with only headers without any payload, SQS does not support messages with empty payload. so this method is not supported

Throws:

JMSException

createObjectMessage

public ObjectMessage createObjectMessage()
                                  throws JMSException

Creates a ObjectMessage.

Returns:

new ObjectMessage

Throws:

JMSException - If session is closed or internal error

createObjectMessage

public ObjectMessage createObjectMessage(java.io.Serializable object)
                                  throws JMSException

Creates an initialized ObjectMessage.

Parameters:

object - The initialized ObjectMessage

Returns:

new ObjectMessage

Throws:

JMSException - If session is closed or internal error

createTextMessage

public TextMessage createTextMessage()
                              throws JMSException

Creates a TextMessage.

Returns:

new TextMessage

Throws:

JMSException - If session is closed or internal error

createTextMessage

public TextMessage createTextMessage(java.lang.String text)
                              throws JMSException

Creates an initialized TextMessage.

Parameters:

text - The initialized TextMessage

Returns:

new TextMessage

Throws:

JMSException - If session is closed or internal error

getAcknowledgeMode

public int getAcknowledgeMode()
                       throws JMSException

Returns the acknowledge mode of the session. The acknowledge mode is set at the time that the session is created.

Returns:

acknowledge mode

Throws:

JMSException

close

public void close()
           throws JMSException

Closes the session.

This will not return until all the message consumers and producers close internally, which blocks until receives and/or message listeners in progress have completed. A blocked message consumer receive call returns null when this session is closed.

Since consumer prefetch threads use SQS long-poll feature with 20 seconds timeout, closing each consumer prefetch thread can take up to 20 seconds, which in-turn will impact the time on session close.

This method is safe for concurrent use.

A message listener must not attempt to close its own session; otherwise throws a IllegalStateException.

Invoking any other session method on a closed session must throw a IllegalStateException.

Throws:

java.lang.IllegalStateException - If called by a message listener on its own Session.

JMSException - On internal error.

recover

public void recover()
             throws JMSException

Negative acknowledges all the messages on the session that is delivered but not acknowledged.

Throws:

JMSException - If session is closed or on internal error.

run

public void run()

createProducer

public MessageProducer createProducer(Destination destination)
                               throws JMSException

Creates a MessageProducer for the specified destination. Only queue destinations are supported at this time.

Parameters:

destination - a queue destination

Returns:

new message producer

Throws:

JMSException - If session is closed or queue destination is not used

createConsumer

public MessageConsumer createConsumer(Destination destination)
                               throws JMSException

Creates a MessageConsumer for the specified destination. Only queue destinations are supported at this time.

Parameters:

destination - a queue destination

Returns:

new message consumer

Throws:

JMSException - If session is closed or queue destination is not used

createConsumer

public MessageConsumer createConsumer(Destination destination,
                             java.lang.String messageSelector)
                               throws JMSException

Creates a MessageConsumer for the specified destination. Only queue destinations are supported at this time. It will ignore any argument in messageSelector.

Parameters:

destination - a queue destination

messageSelector -

Returns:

new message consumer

Throws:

JMSException - If session is closed or queue destination is not used

createConsumer

public MessageConsumer createConsumer(Destination destination,
                             java.lang.String messageSelector,
                             boolean NoLocal)
                               throws JMSException

Creates a MessageConsumer for the specified destination. Only queue destinations are supported at this time. It will ignore any argument in messageSelector and NoLocal.

Parameters:

destination - a queue destination

messageSelector -

NoLocal -

Returns:

new message consumer

Throws:

JMSException - If session is closed or queue destination is not used

createQueue

public Queue createQueue(java.lang.String queueName)
                  throws JMSException

This does not create SQS Queue. This method is only to create JMS Queue Object. Make sure the queue exists corresponding to the queueName.

Parameters:

queueName -

Returns:

a queue destination

Throws:

JMSException - If session is closed or invalid queue is provided

createQueue

public Queue createQueue(java.lang.String queueName,
                java.lang.String ownerAccountId)
                  throws JMSException

This does not create SQS Queue. This method is only to create JMS Queue Object. Make sure the queue exists corresponding to the queueName and ownerAccountId.

Parameters:

queueName -

ownerAccountId - the account id, which originally created the queue on SQS

Returns:

a queue destination

Throws:

JMSException - If session is closed or invalid queue is provided

getTransacted

public boolean getTransacted()
                      throws JMSException

SQS does not support transacted. Transacted will always be false.

Throws:

JMSException

commit

public void commit()
            throws JMSException

This method is not supported. This method is related to transaction which SQS doesn't support

Throws:

JMSException

rollback

public void rollback()
              throws JMSException

This method is not supported. This method is related to transaction which SQS doesn't support

Throws:

JMSException

unsubscribe

public void unsubscribe(java.lang.String name)
                 throws JMSException

This method is not supported. This method is related to Topic which SQS doesn't support

Throws:

JMSException

createTopic

public Topic createTopic(java.lang.String topicName)
                  throws JMSException

This method is not supported.

Throws:

JMSException

createDurableSubscriber

public TopicSubscriber createDurableSubscriber(Topic topic,
                                      java.lang.String name)
                                        throws JMSException

This method is not supported.

Throws:

JMSException

createDurableSubscriber

public TopicSubscriber createDurableSubscriber(Topic topic,
                                      java.lang.String name,
                                      java.lang.String messageSelector,
                                      boolean noLocal)
                                        throws JMSException

This method is not supported.

Throws:

JMSException

createBrowser

public QueueBrowser createBrowser(Queue queue)
                           throws JMSException

This method is not supported.

Throws:

JMSException

createBrowser

public QueueBrowser createBrowser(Queue queue,
                         java.lang.String messageSelector)
                           throws JMSException

This method is not supported.

Throws:

JMSException

createTemporaryQueue

public TemporaryQueue createTemporaryQueue()
                                    throws JMSException

This method is not supported.

Throws:

JMSException

createTemporaryTopic

public TemporaryTopic createTemporaryTopic()
                                    throws JMSException

This method is not supported.

Throws:

JMSException

getMessageListener

public MessageListener getMessageListener()
                                   throws JMSException

This method is not supported.

Throws:

JMSException

setMessageListener

public void setMessageListener(MessageListener listener)
                        throws JMSException

This method is not supported.

Throws:

JMSException

createStreamMessage

public StreamMessage createStreamMessage()
                                  throws JMSException

This method is not supported.

Throws:

JMSException

createMapMessage

public MapMessage createMapMessage()
                            throws JMSException

This method is not supported.

Throws:

JMSException

checkClosed

public void checkClosed()
                 throws java.lang.IllegalStateException

Check if session is closed.

Throws:

java.lang.IllegalStateException

checkClosing

public void checkClosing()
                  throws java.lang.IllegalStateException

Check if session is closed or closing.

Throws:

java.lang.IllegalStateException