Package com.amazon.sqs.javamessaging

Class SQSSession

java.lang.Object
com.amazon.sqs.javamessaging.SQSSession
All Implemented Interfaces:
jakarta.jms.QueueSession, jakarta.jms.Session, AutoCloseable, Runnable
public class SQSSession extends Object implements jakarta.jms.Session, jakarta.jms.QueueSession
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
    Description
    static final int
    UNORDERED_ACKNOWLEDGE
    Non standard acknowledge mode.

    Fields inherited from interface jakarta.jms.Session

    AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

  • Method Summary

    Modifier and Type
    Method
    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.
    jakarta.jms.QueueBrowser
    createBrowser(jakarta.jms.Queue queue)
    This method is not supported.
    jakarta.jms.QueueBrowser
    createBrowser(jakarta.jms.Queue queue, String messageSelector)
    This method is not supported.
    jakarta.jms.BytesMessage
    createBytesMessage()
    Creates a BytesMessage.
    jakarta.jms.MessageConsumer
    createConsumer(jakarta.jms.Destination destination)
    Creates a MessageConsumer for the specified destination.
    jakarta.jms.MessageConsumer
    createConsumer(jakarta.jms.Destination destination, String messageSelector)
    Creates a MessageConsumer for the specified destination.
    jakarta.jms.MessageConsumer
    createConsumer(jakarta.jms.Destination destination, String messageSelector, boolean NoLocal)
    Creates a MessageConsumer for the specified destination.
    jakarta.jms.MessageConsumer
    createDurableConsumer(jakarta.jms.Topic topic, String name)
     
    jakarta.jms.MessageConsumer
    createDurableConsumer(jakarta.jms.Topic topic, String name, String messageSelector, boolean noLocal)
     
    jakarta.jms.TopicSubscriber
    createDurableSubscriber(jakarta.jms.Topic topic, String name)
    This method is not supported.
    jakarta.jms.TopicSubscriber
    createDurableSubscriber(jakarta.jms.Topic topic, String name, String messageSelector, boolean noLocal)
    This method is not supported.
    jakarta.jms.MapMessage
    createMapMessage()
    This method is not supported.
    jakarta.jms.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.
    jakarta.jms.ObjectMessage
    createObjectMessage()
    Creates a ObjectMessage.
    jakarta.jms.ObjectMessage
    createObjectMessage(Serializable object)
    Creates an initialized ObjectMessage.
    jakarta.jms.MessageProducer
    createProducer(jakarta.jms.Destination destination)
    Creates a MessageProducer for the specified destination.
    jakarta.jms.Queue
    createQueue(String queueName)
    This does not create SQS Queue.
    jakarta.jms.Queue
    createQueue(String queueName, String ownerAccountId)
    This does not create SQS Queue.
    jakarta.jms.QueueReceiver
    createReceiver(jakarta.jms.Queue queue)
    Creates a QueueReceiver for the specified queue.
    jakarta.jms.QueueReceiver
    createReceiver(jakarta.jms.Queue queue, String messageSelector)
    Creates a QueueReceiver for the specified queue.
    jakarta.jms.QueueSender
    createSender(jakarta.jms.Queue queue)
    Creates a QueueSender for the specified queue.
    jakarta.jms.MessageConsumer
    createSharedConsumer(jakarta.jms.Topic topic, String sharedSubscriptionName)
     
    jakarta.jms.MessageConsumer
    createSharedConsumer(jakarta.jms.Topic topic, String sharedSubscriptionName, String messageSelector)
     
    jakarta.jms.MessageConsumer
    createSharedDurableConsumer(jakarta.jms.Topic topic, String name)
     
    jakarta.jms.MessageConsumer
    createSharedDurableConsumer(jakarta.jms.Topic topic, String name, String messageSelector)
     
    jakarta.jms.StreamMessage
    createStreamMessage()
    This method is not supported.
    jakarta.jms.TemporaryQueue
    createTemporaryQueue()
    This method is not supported.
    jakarta.jms.TemporaryTopic
    createTemporaryTopic()
    This method is not supported.
    jakarta.jms.TextMessage
    createTextMessage()
    Creates a TextMessage.
    jakarta.jms.TextMessage
    createTextMessage(String text)
    Creates an initialized TextMessage.
    jakarta.jms.Topic
    createTopic(String topicName)
    This method is not supported.
    int
    getAcknowledgeMode()
    Returns the acknowledge mode of the session.
    jakarta.jms.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(jakarta.jms.MessageListener listener)
    This method is not supported.
    void
    unsubscribe(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 Details

    • 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:

  • Method Details

    • createReceiver

      public jakarta.jms.QueueReceiver createReceiver(jakarta.jms.Queue queue) throws jakarta.jms.JMSException
      Creates a QueueReceiver for the specified queue.
      Specified by:
      createReceiver in interface jakarta.jms.QueueSession
      Parameters:
      queue - a queue receiver
      Returns:
      new message consumer
      Throws:
      jakarta.jms.JMSException - If session is closed

    • createReceiver

      public jakarta.jms.QueueReceiver createReceiver(jakarta.jms.Queue queue, String messageSelector) throws jakarta.jms.JMSException
      Creates a QueueReceiver for the specified queue. Does not support messageSelector. It will drop anything in messageSelector.
      Specified by:
      createReceiver in interface jakarta.jms.QueueSession
      Parameters:
      queue - a queue destination
      messageSelector -
      Returns:
      new message receiver
      Throws:
      jakarta.jms.JMSException - If session is closed

    • createSender

      public jakarta.jms.QueueSender createSender(jakarta.jms.Queue queue) throws jakarta.jms.JMSException
      Creates a QueueSender for the specified queue.
      Specified by:
      createSender in interface jakarta.jms.QueueSession
      Parameters:
      queue - a queue destination
      Returns:
      new message sender
      Throws:
      jakarta.jms.JMSException - If session is closed

    • createBytesMessage

      public jakarta.jms.BytesMessage createBytesMessage() throws jakarta.jms.JMSException
      Creates a BytesMessage.
      Specified by:
      createBytesMessage in interface jakarta.jms.Session
      Returns:
      new BytesMessage
      Throws:
      jakarta.jms.JMSException - If session is closed or internal error

    • createMessage

      public jakarta.jms.Message createMessage() throws jakarta.jms.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
      Specified by:
      createMessage in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createObjectMessage

      public jakarta.jms.ObjectMessage createObjectMessage() throws jakarta.jms.JMSException
      Creates a ObjectMessage.
      Specified by:
      createObjectMessage in interface jakarta.jms.Session
      Returns:
      new ObjectMessage
      Throws:
      jakarta.jms.JMSException - If session is closed or internal error

    • createObjectMessage

      public jakarta.jms.ObjectMessage createObjectMessage(Serializable object) throws jakarta.jms.JMSException
      Creates an initialized ObjectMessage.
      Specified by:
      createObjectMessage in interface jakarta.jms.Session
      Parameters:
      object - The initialized ObjectMessage
      Returns:
      new ObjectMessage
      Throws:
      jakarta.jms.JMSException - If session is closed or internal error

    • createTextMessage

      public jakarta.jms.TextMessage createTextMessage() throws jakarta.jms.JMSException
      Creates a TextMessage.
      Specified by:
      createTextMessage in interface jakarta.jms.Session
      Returns:
      new TextMessage
      Throws:
      jakarta.jms.JMSException - If session is closed or internal error

    • createTextMessage

      public jakarta.jms.TextMessage createTextMessage(String text) throws jakarta.jms.JMSException
      Creates an initialized TextMessage.
      Specified by:
      createTextMessage in interface jakarta.jms.Session
      Parameters:
      text - The initialized TextMessage
      Returns:
      new TextMessage
      Throws:
      jakarta.jms.JMSException - If session is closed or internal error

    • getAcknowledgeMode

      public int getAcknowledgeMode() throws jakarta.jms.JMSException
      Returns the acknowledge mode of the session. The acknowledge mode is set at the time that the session is created.
      Specified by:
      getAcknowledgeMode in interface jakarta.jms.Session
      Returns:
      acknowledge mode
      Throws:
      jakarta.jms.JMSException

    • close

      public void close() throws jakarta.jms.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.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface jakarta.jms.Session
      Throws:
      jakarta.jms.IllegalStateException - If called by a message listener on its own Session.
      jakarta.jms.JMSException - On internal error.

    • recover

      public void recover() throws jakarta.jms.JMSException
      Negative acknowledges all the messages on the session that is delivered but not acknowledged.
      Specified by:
      recover in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException - If session is closed or on internal error.

    • run

      public void run()
      Specified by:
      run in interface Runnable
      Specified by:
      run in interface jakarta.jms.Session

    • createProducer

      public jakarta.jms.MessageProducer createProducer(jakarta.jms.Destination destination) throws jakarta.jms.JMSException
      Creates a MessageProducer for the specified destination. Only queue destinations are supported at this time.
      Specified by:
      createProducer in interface jakarta.jms.Session
      Parameters:
      destination - a queue destination
      Returns:
      new message producer
      Throws:
      jakarta.jms.JMSException - If session is closed or queue destination is not used

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination) throws jakarta.jms.JMSException
      Creates a MessageConsumer for the specified destination. Only queue destinations are supported at this time.
      Specified by:
      createConsumer in interface jakarta.jms.Session
      Parameters:
      destination - a queue destination
      Returns:
      new message consumer
      Throws:
      jakarta.jms.JMSException - If session is closed or queue destination is not used

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination, String messageSelector) throws jakarta.jms.JMSException
      Creates a MessageConsumer for the specified destination. Only queue destinations are supported at this time. It will ignore any argument in messageSelector.
      Specified by:
      createConsumer in interface jakarta.jms.Session
      Parameters:
      destination - a queue destination
      messageSelector -
      Returns:
      new message consumer
      Throws:
      jakarta.jms.JMSException - If session is closed or queue destination is not used

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination, String messageSelector, boolean NoLocal) throws jakarta.jms.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.
      Specified by:
      createConsumer in interface jakarta.jms.Session
      Parameters:
      destination - a queue destination
      messageSelector -
      NoLocal -
      Returns:
      new message consumer
      Throws:
      jakarta.jms.JMSException - If session is closed or queue destination is not used

    • createSharedConsumer

      public jakarta.jms.MessageConsumer createSharedConsumer(jakarta.jms.Topic topic, String sharedSubscriptionName) throws jakarta.jms.JMSException
      Specified by:
      createSharedConsumer in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createSharedConsumer

      public jakarta.jms.MessageConsumer createSharedConsumer(jakarta.jms.Topic topic, String sharedSubscriptionName, String messageSelector) throws jakarta.jms.JMSException
      Specified by:
      createSharedConsumer in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createQueue

      public jakarta.jms.Queue createQueue(String queueName) throws jakarta.jms.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.
      Specified by:
      createQueue in interface jakarta.jms.QueueSession
      Specified by:
      createQueue in interface jakarta.jms.Session
      Parameters:
      queueName -
      Returns:
      a queue destination
      Throws:
      jakarta.jms.JMSException - If session is closed or invalid queue is provided

    • createQueue

      public jakarta.jms.Queue createQueue(String queueName, String ownerAccountId) throws jakarta.jms.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:
      jakarta.jms.JMSException - If session is closed or invalid queue is provided

    • getTransacted

      public boolean getTransacted() throws jakarta.jms.JMSException
      SQS does not support transacted. Transacted will always be false.
      Specified by:
      getTransacted in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • commit

      public void commit() throws jakarta.jms.JMSException
      This method is not supported. This method is related to transaction which SQS doesn't support
      Specified by:
      commit in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • rollback

      public void rollback() throws jakarta.jms.JMSException
      This method is not supported. This method is related to transaction which SQS doesn't support
      Specified by:
      rollback in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • unsubscribe

      public void unsubscribe(String name) throws jakarta.jms.JMSException
      This method is not supported. This method is related to Topic which SQS doesn't support
      Specified by:
      unsubscribe in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createTopic

      public jakarta.jms.Topic createTopic(String topicName) throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createTopic in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createDurableSubscriber

      public jakarta.jms.TopicSubscriber createDurableSubscriber(jakarta.jms.Topic topic, String name) throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createDurableSubscriber in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createDurableSubscriber

      public jakarta.jms.TopicSubscriber createDurableSubscriber(jakarta.jms.Topic topic, String name, String messageSelector, boolean noLocal) throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createDurableSubscriber in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createDurableConsumer

      public jakarta.jms.MessageConsumer createDurableConsumer(jakarta.jms.Topic topic, String name) throws jakarta.jms.JMSException
      Specified by:
      createDurableConsumer in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createDurableConsumer

      public jakarta.jms.MessageConsumer createDurableConsumer(jakarta.jms.Topic topic, String name, String messageSelector, boolean noLocal) throws jakarta.jms.JMSException
      Specified by:
      createDurableConsumer in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createSharedDurableConsumer

      public jakarta.jms.MessageConsumer createSharedDurableConsumer(jakarta.jms.Topic topic, String name) throws jakarta.jms.JMSException
      Specified by:
      createSharedDurableConsumer in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createSharedDurableConsumer

      public jakarta.jms.MessageConsumer createSharedDurableConsumer(jakarta.jms.Topic topic, String name, String messageSelector) throws jakarta.jms.JMSException
      Specified by:
      createSharedDurableConsumer in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createBrowser

      public jakarta.jms.QueueBrowser createBrowser(jakarta.jms.Queue queue) throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createBrowser in interface jakarta.jms.QueueSession
      Specified by:
      createBrowser in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createBrowser

      public jakarta.jms.QueueBrowser createBrowser(jakarta.jms.Queue queue, String messageSelector) throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createBrowser in interface jakarta.jms.QueueSession
      Specified by:
      createBrowser in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createTemporaryQueue

      public jakarta.jms.TemporaryQueue createTemporaryQueue() throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createTemporaryQueue in interface jakarta.jms.QueueSession
      Specified by:
      createTemporaryQueue in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createTemporaryTopic

      public jakarta.jms.TemporaryTopic createTemporaryTopic() throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createTemporaryTopic in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • getMessageListener

      public jakarta.jms.MessageListener getMessageListener() throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      getMessageListener in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • setMessageListener

      public void setMessageListener(jakarta.jms.MessageListener listener) throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      setMessageListener in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createStreamMessage

      public jakarta.jms.StreamMessage createStreamMessage() throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createStreamMessage in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • createMapMessage

      public jakarta.jms.MapMessage createMapMessage() throws jakarta.jms.JMSException
      This method is not supported.
      Specified by:
      createMapMessage in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException

    • checkClosed

      public void checkClosed() throws jakarta.jms.IllegalStateException
      Check if session is closed.
      Throws:
      jakarta.jms.IllegalStateException

    • checkClosing

      public void checkClosing() throws jakarta.jms.IllegalStateException
      Check if session is closed or closing.
      Throws:
      jakarta.jms.IllegalStateException