Package org.apache.activemq

Class ActiveMQSession

java.lang.Object
org.apache.activemq.ActiveMQSession
All Implemented Interfaces:
jakarta.jms.QueueSession, jakarta.jms.Session, jakarta.jms.TopicSession, AutoCloseable, Runnable, ActiveMQDispatcher, StatsCapable
Direct Known Subclasses:
ActiveMQXASession
public class ActiveMQSession extends Object implements jakarta.jms.Session, jakarta.jms.QueueSession, jakarta.jms.TopicSession, StatsCapable, ActiveMQDispatcher

A Session object is a single-threaded context for producing and consuming messages. Although it may allocate provider resources outside the Java virtual machine (JVM), it is considered a lightweight JMS object.

A session serves several purposes:

  • It is a factory for its message producers and consumers.
  • It supplies provider-optimized message factories.
  • It is a factory for TemporaryTopics and TemporaryQueues.
  • It provides a way to create Queue or Topic objects for those clients that need to dynamically manipulate provider-specific destination names.
  • It supports a single series of transactions that combine work spanning its producers and consumers into atomic units.
  • It defines a serial order for the messages it consumes and the messages it produces.
  • It retains messages it consumes until they have been acknowledged.
  • It serializes execution of message listeners registered with its message consumers.
  • It is a factory for QueueBrowsers.

A session can create and service multiple message producers and consumers.

One typical use is to have a thread block on a synchronous MessageConsumer until a message arrives. The thread may then use one or more of the Session'sMessageProducers.

If a client desires to have one thread produce messages while others consume them, the client should use a separate session for its producing thread.

Once a connection has been started, any session with one or more registered message listeners is dedicated to the thread of control that delivers messages to it. It is erroneous for client code to use this session or any of its constituent objects from another thread of control. The only exception to this rule is the use of the session or connection close method.

It should be easy for most clients to partition their work naturally into sessions. This model allows clients to start simply and incrementally add message processing complexity as their need for concurrency grows.

The close method is the only session method that can be called while some other session method is being executed in another thread.

A session may be specified as transacted. Each transacted session supports a single series of transactions. Each transaction groups a set of message sends and a set of message receives into an atomic unit of work. In effect, transactions organize a session's input message stream and output message stream into series of atomic units. When a transaction commits, its atomic unit of input is acknowledged and its associated atomic unit of output is sent. If a transaction rollback is done, the transaction's sent messages are destroyed and the session's input is automatically recovered.

The content of a transaction's input and output units is simply those messages that have been produced and consumed within the session's current transaction.

A transaction is completed using either its session's commit method or its session's rollback method. The completion of a session's current transaction automatically begins the next. The result is that a transacted session always has a current transaction within which its work is done.

The Java Transaction Service (JTS) or some other transaction monitor may be used to combine a session's transaction with transactions on other resources (databases, other JMS sessions, etc.). Since Java distributed transactions are controlled via the Java Transaction API (JTA), use of the session's commit and rollback methods in this context is prohibited.

The JMS API does not require support for JTA; however, it does define how a provider supplies this support.

Although it is also possible for a JMS client to handle distributed transactions directly, it is unlikely that many JMS clients will do this. Support for JTA in the JMS API is targeted at systems vendors who will be integrating the JMS API into their application server products.

See Also:
  • Session
  • QueueSession
  • TopicSession
  • XASession

  • Field Details

    • INDIVIDUAL_ACKNOWLEDGE

      public static final int INDIVIDUAL_ACKNOWLEDGE
      Only acknowledge an individual message - using message.acknowledge() as opposed to CLIENT_ACKNOWLEDGE which acknowledges all messages consumed by a session at when acknowledge() is called
      See Also:

    • MAX_ACK_CONSTANT

      public static final int MAX_ACK_CONSTANT
      See Also:

    • acknowledgementMode

      protected int acknowledgementMode

    • connection

      protected final ActiveMQConnection connection

    • info

      protected final SessionInfo info

    • consumerIdGenerator

      protected final LongSequenceGenerator consumerIdGenerator

    • producerIdGenerator

      protected final LongSequenceGenerator producerIdGenerator

    • deliveryIdGenerator

      protected final LongSequenceGenerator deliveryIdGenerator

    • executor

      protected final ActiveMQSessionExecutor executor

    • started

      protected final AtomicBoolean started

    • consumers

      protected final CopyOnWriteArrayList<ActiveMQMessageConsumer> consumers

    • producers

      protected final CopyOnWriteArrayList<ActiveMQMessageProducer> producers

    • closed

      protected boolean closed

    • asyncDispatch

      protected boolean asyncDispatch

    • sessionAsyncDispatch

      protected boolean sessionAsyncDispatch

    • debug

      protected final boolean debug

    • sendMutex

      protected final Object sendMutex

    • redeliveryGuard

      protected final Object redeliveryGuard

  • Constructor Details

    • ActiveMQSession

      protected ActiveMQSession(ActiveMQConnection connection, SessionId sessionId, int acknowledgeMode, boolean asyncDispatch, boolean sessionAsyncDispatch) throws jakarta.jms.JMSException
      Construct the Session
      Parameters:
      connection -
      sessionId -
      acknowledgeMode - n.b if transacted - the acknowledgeMode == Session.SESSION_TRANSACTED
      asyncDispatch -
      sessionAsyncDispatch -
      Throws:
      jakarta.jms.JMSException - on internal error

    • ActiveMQSession

      protected ActiveMQSession(ActiveMQConnection connection, SessionId sessionId, int acknowledgeMode, boolean asyncDispatch) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

  • Method Details

    • setTransactionContext

      public void setTransactionContext(TransactionContext transactionContext)
      Sets the transaction context of the session.
      Parameters:
      transactionContext - - provides the means to control a JMS transaction.

    • getTransactionContext

      public TransactionContext getTransactionContext()
      Returns the transaction context of the session.
      Returns:
      transactionContext - session's transaction context.

    • getStats

      public StatsImpl getStats()
      Specified by:
      getStats in interface StatsCapable
      Returns:
      the Stats for this object

    • getSessionStats

      public JMSSessionStatsImpl getSessionStats()
      Returns the session's statistics.
      Returns:
      stats - session's statistics.

    • createBytesMessage

      public jakarta.jms.BytesMessage createBytesMessage() throws jakarta.jms.JMSException
      Creates a BytesMessage object. A BytesMessage object is used to send a message containing a stream of uninterpreted bytes.
      Specified by:
      createBytesMessage in interface jakarta.jms.Session
      Returns:
      the an ActiveMQBytesMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createMapMessage

      public jakarta.jms.MapMessage createMapMessage() throws jakarta.jms.JMSException
      Creates a MapMessage object. A MapMessage object is used to send a self-defining set of name-value pairs, where names are String objects and values are primitive values in the Java programming language.
      Specified by:
      createMapMessage in interface jakarta.jms.Session
      Returns:
      an ActiveMQMapMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createMessage

      public jakarta.jms.Message createMessage() throws jakarta.jms.JMSException
      Creates a Message object. The Message interface is the root interface of all JMS messages. A Message object holds all the standard message header information. It can be sent when a message containing only header information is sufficient.
      Specified by:
      createMessage in interface jakarta.jms.Session
      Returns:
      an ActiveMQMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createObjectMessage

      public jakarta.jms.ObjectMessage createObjectMessage() throws jakarta.jms.JMSException
      Creates an ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.
      Specified by:
      createObjectMessage in interface jakarta.jms.Session
      Returns:
      an ActiveMQObjectMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createObjectMessage

      public jakarta.jms.ObjectMessage createObjectMessage(Serializable object) throws jakarta.jms.JMSException
      Creates an initialized ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.
      Specified by:
      createObjectMessage in interface jakarta.jms.Session
      Parameters:
      object - the object to use to initialize this message
      Returns:
      an ActiveMQObjectMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createStreamMessage

      public jakarta.jms.StreamMessage createStreamMessage() throws jakarta.jms.JMSException
      Creates a StreamMessage object. A StreamMessage object is used to send a self-defining stream of primitive values in the Java programming language.
      Specified by:
      createStreamMessage in interface jakarta.jms.Session
      Returns:
      an ActiveMQStreamMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createTextMessage

      public jakarta.jms.TextMessage createTextMessage() throws jakarta.jms.JMSException
      Creates a TextMessage object. A TextMessage object is used to send a message containing a String object.
      Specified by:
      createTextMessage in interface jakarta.jms.Session
      Returns:
      an ActiveMQTextMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createTextMessage

      public jakarta.jms.TextMessage createTextMessage(String text) throws jakarta.jms.JMSException
      Creates an initialized TextMessage object. A TextMessage object is used to send a message containing a String.
      Specified by:
      createTextMessage in interface jakarta.jms.Session
      Parameters:
      text - the string used to initialize this message
      Returns:
      an ActiveMQTextMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createBlobMessage

      public BlobMessage createBlobMessage(URL url) throws jakarta.jms.JMSException
      Creates an initialized BlobMessage object. A BlobMessage object is used to send a message containing a URL which points to some network addressible BLOB.
      Parameters:
      url - the network addressable URL used to pass directly to the consumer
      Returns:
      a BlobMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createBlobMessage

      public BlobMessage createBlobMessage(URL url, boolean deletedByBroker) throws jakarta.jms.JMSException
      Creates an initialized BlobMessage object. A BlobMessage object is used to send a message containing a URL which points to some network addressible BLOB.
      Parameters:
      url - the network addressable URL used to pass directly to the consumer
      deletedByBroker - indicates whether or not the resource is deleted by the broker when the message is acknowledged
      Returns:
      a BlobMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createBlobMessage

      public BlobMessage createBlobMessage(File file) throws jakarta.jms.JMSException
      Creates an initialized BlobMessage object. A BlobMessage object is used to send a message containing the File content. Before the message is sent the file conent will be uploaded to the broker or some other remote repository depending on the getBlobTransferPolicy().
      Parameters:
      file - the file to be uploaded to some remote repo (or the broker) depending on the strategy
      Returns:
      a BlobMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • createBlobMessage

      public BlobMessage createBlobMessage(InputStream in) throws jakarta.jms.JMSException
      Creates an initialized BlobMessage object. A BlobMessage object is used to send a message containing the File content. Before the message is sent the file conent will be uploaded to the broker or some other remote repository depending on the getBlobTransferPolicy().

      The caller of this method is responsible for closing the input stream that is used, however the stream can not be closed until after the message has been sent. To have this class manage the stream and close it automatically, use the method createBlobMessage(File)

      Parameters:
      in - the stream to be uploaded to some remote repo (or the broker) depending on the strategy
      Returns:
      a BlobMessage
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

    • getTransacted

      public boolean getTransacted() throws jakarta.jms.JMSException
      Indicates whether the session is in transacted mode.
      Specified by:
      getTransacted in interface jakarta.jms.Session
      Returns:
      true if the session is in transacted mode
      Throws:
      jakarta.jms.JMSException - if there is some internal error.

    • getAcknowledgeMode

      public int getAcknowledgeMode() throws jakarta.jms.JMSException
      Returns the acknowledgement mode of the session. The acknowledgement mode is set at the time that the session is created. If the session is transacted, the acknowledgement mode is ignored.
      Specified by:
      getAcknowledgeMode in interface jakarta.jms.Session
      Returns:
      If the session is not transacted, returns the current acknowledgement mode for the session. If the session is transacted, returns SESSION_TRANSACTED.
      Throws:
      jakarta.jms.JMSException
      Since:
      1.1 exception JMSException if there is some internal error.
      See Also:
      • Connection.createSession(boolean,int)

    • commit

      public void commit() throws jakarta.jms.JMSException
      Commits all messages done in this transaction and releases any locks currently held.
      Specified by:
      commit in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to commit the transaction due to some internal error.
      jakarta.jms.TransactionRolledBackException - if the transaction is rolled back due to some internal error during commit.
      jakarta.jms.IllegalStateException - if the method is not called by a transacted session.

    • rollback

      public void rollback() throws jakarta.jms.JMSException
      Rolls back any messages done in this transaction and releases any locks currently held.
      Specified by:
      rollback in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to roll back the transaction due to some internal error.
      jakarta.jms.IllegalStateException - if the method is not called by a transacted session.

    • close

      public void close() throws jakarta.jms.JMSException
      Closes the session.

      Since a provider may allocate some resources on behalf of a session outside the JVM, clients should close the resources when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

      There is no need to close the producers and consumers of a closed session.

      This call will block until a receive call or message listener in progress has completed. A blocked message consumer receive call returns null when this session is closed.

      Closing a transacted session must roll back the transaction in progress.

      This method is the only Session method that can be called concurrently.

      Invoking any other Session method on a closed session must throw a JMSException.IllegalStateException. Closing a closed session must not throw an exception.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to close the session due to some internal error.

    • dispose

      public void dispose() throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • configureMessage

      protected void configureMessage(ActiveMQMessage message) throws jakarta.jms.IllegalStateException
      Checks that the session is not closed then configures the message
      Throws:
      jakarta.jms.IllegalStateException

    • checkClosed

      protected void checkClosed() throws jakarta.jms.IllegalStateException
      Check if the session is closed. It is used for ensuring that the session is open before performing various operations.
      Throws:
      jakarta.jms.IllegalStateException - if the Session is closed

    • isClosed

      public boolean isClosed()
      Checks if the session is closed.
      Returns:
      true if the session is closed, false otherwise.

    • recover

      public void recover() throws jakarta.jms.JMSException
      Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.

      All consumers deliver messages in a serial order. Acknowledging a received message automatically acknowledges all messages that have been delivered to the client.

      Restarting a session causes it to take the following actions:

      • Stop message delivery
      • Mark all messages that might have been delivered but not acknowledged as "redelivered"
      • Restart the delivery sequence including all unacknowledged messages that had been previously delivered. Redelivered messages do not have to be delivered in exactly their original delivery order.
      Specified by:
      recover in interface jakarta.jms.Session
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to stop and restart message delivery due to some internal error.
      jakarta.jms.IllegalStateException - if the method is called by a transacted session.

    • getMessageListener

      public jakarta.jms.MessageListener getMessageListener() throws jakarta.jms.JMSException
      Returns the session's distinguished message listener (optional).
      Specified by:
      getMessageListener in interface jakarta.jms.Session
      Returns:
      the message listener associated with this session
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to get the message listener due to an internal error.
      See Also:
      • Session.setMessageListener(jakarta.jms.MessageListener)
      • ServerSessionPool
      • ServerSession

    • setMessageListener

      public void setMessageListener(jakarta.jms.MessageListener listener) throws jakarta.jms.JMSException
      Sets the session's distinguished message listener (optional).

      When the distinguished message listener is set, no other form of message receipt in the session can be used; however, all forms of sending messages are still supported.

      If this session has been closed, then an IllegalStateException is thrown, if trying to set a new listener. However setting the listener to null is allowed, to clear the listener, even if this session has been closed prior.

      This is an expert facility not used by regular JMS clients.

      Specified by:
      setMessageListener in interface jakarta.jms.Session
      Parameters:
      listener - the message listener to associate with this session
      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to set the message listener due to an internal error.
      See Also:
      • Session.getMessageListener()
      • ServerSessionPool
      • ServerSession

    • run

      public void run()
      Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.
      Specified by:
      run in interface Runnable
      Specified by:
      run in interface jakarta.jms.Session
      See Also:
      • ServerSession

    • createProducer

      public jakarta.jms.MessageProducer createProducer(jakarta.jms.Destination destination) throws jakarta.jms.JMSException
      Creates a MessageProducer to send messages to the specified destination.

      A client uses a MessageProducer object to send messages to a destination. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageProducer object.

      Specified by:
      createProducer in interface jakarta.jms.Session
      Parameters:
      destination - the Destination to send to, or null if this is a producer which does not have a specified destination.
      Returns:
      the MessageProducer
      Throws:
      jakarta.jms.JMSException - if the session fails to create a MessageProducer due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified.
      Since:
      1.1

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination) throws jakarta.jms.JMSException
      Creates a MessageConsumer for the specified destination. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.
      Specified by:
      createConsumer in interface jakarta.jms.Session
      Parameters:
      destination - the Destination to access.
      Returns:
      the MessageConsumer
      Throws:
      jakarta.jms.JMSException - if the session fails to create a consumer due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified.
      Since:
      1.1

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination, String messageSelector) throws jakarta.jms.JMSException
      Creates a MessageConsumer for the specified destination, using a message selector. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.

      A client uses a MessageConsumer object to receive messages that have been sent to a destination.

      Specified by:
      createConsumer in interface jakarta.jms.Session
      Parameters:
      destination - the Destination to access
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      Returns:
      the MessageConsumer
      Throws:
      jakarta.jms.JMSException - if the session fails to create a MessageConsumer due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified.
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.
      Since:
      1.1

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination, jakarta.jms.MessageListener messageListener) throws jakarta.jms.JMSException
      Creates a MessageConsumer for the specified destination. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.
      Parameters:
      destination - the Destination to access.
      messageListener - the listener to use for async consumption of messages
      Returns:
      the MessageConsumer
      Throws:
      jakarta.jms.JMSException - if the session fails to create a consumer due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified.
      Since:
      1.1

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination, String messageSelector, jakarta.jms.MessageListener messageListener) throws jakarta.jms.JMSException
      Creates a MessageConsumer for the specified destination, using a message selector. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.

      A client uses a MessageConsumer object to receive messages that have been sent to a destination.

      Parameters:
      destination - the Destination to access
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      messageListener - the listener to use for async consumption of messages
      Returns:
      the MessageConsumer
      Throws:
      jakarta.jms.JMSException - if the session fails to create a MessageConsumer due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified.
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.
      Since:
      1.1

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination, String messageSelector, boolean noLocal) throws jakarta.jms.JMSException
      Creates MessageConsumer for the specified destination, using a message selector. This method can specify whether messages published by its own connection should be delivered to it, if the destination is a topic.

      Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.

      A client uses a MessageConsumer object to receive messages that have been published to a destination.

      In some cases, a connection may both publish and subscribe to a topic. The consumer NoLocal attribute allows a consumer to inhibit the delivery of messages published by its own connection. The default value for this attribute is False. The noLocal value must be supported by destinations that are topics.

      Specified by:
      createConsumer in interface jakarta.jms.Session
      Parameters:
      destination - the Destination to access
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      noLocal - - if true, and the destination is a topic, inhibits the delivery of messages published by its own connection. The behavior for NoLocal is not specified if the destination is a queue.
      Returns:
      the MessageConsumer
      Throws:
      jakarta.jms.JMSException - if the session fails to create a MessageConsumer due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified.
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.
      Since:
      1.1

    • createConsumer

      public jakarta.jms.MessageConsumer createConsumer(jakarta.jms.Destination destination, String messageSelector, boolean noLocal, jakarta.jms.MessageListener messageListener) throws jakarta.jms.JMSException
      Creates MessageConsumer for the specified destination, using a message selector. This method can specify whether messages published by its own connection should be delivered to it, if the destination is a topic.

      Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.

      A client uses a MessageConsumer object to receive messages that have been published to a destination.

      In some cases, a connection may both publish and subscribe to a topic. The consumer NoLocal attribute allows a consumer to inhibit the delivery of messages published by its own connection. The default value for this attribute is False. The noLocal value must be supported by destinations that are topics.

      Parameters:
      destination - the Destination to access
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      noLocal - - if true, and the destination is a topic, inhibits the delivery of messages published by its own connection. The behavior for NoLocal is not specified if the destination is a queue.
      messageListener - the listener to use for async consumption of messages
      Returns:
      the MessageConsumer
      Throws:
      jakarta.jms.JMSException - if the session fails to create a MessageConsumer due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified.
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.
      Since:
      1.1

    • createQueue

      public jakarta.jms.Queue createQueue(String queueName) throws jakarta.jms.JMSException
      Creates a queue identity given a Queue name.

      This facility is provided for the rare cases where clients need to dynamically manipulate queue identity. It allows the creation of a queue identity with a provider-specific name. Clients that depend on this ability are not portable.

      Note that this method is not for creating the physical queue. The physical creation of queues is an administrative task and is not to be initiated by the JMS API. The one exception is the creation of temporary queues, which is accomplished with the createTemporaryQueue method.

      Specified by:
      createQueue in interface jakarta.jms.QueueSession
      Specified by:
      createQueue in interface jakarta.jms.Session
      Parameters:
      queueName - the name of this Queue
      Returns:
      a Queue with the given name
      Throws:
      jakarta.jms.JMSException - if the session fails to create a queue due to some internal error.
      Since:
      1.1

    • createTopic

      public jakarta.jms.Topic createTopic(String topicName) throws jakarta.jms.JMSException
      Creates a topic identity given a Topic name.

      This facility is provided for the rare cases where clients need to dynamically manipulate topic identity. This allows the creation of a topic identity with a provider-specific name. Clients that depend on this ability are not portable.

      Note that this method is not for creating the physical topic. The physical creation of topics is an administrative task and is not to be initiated by the JMS API. The one exception is the creation of temporary topics, which is accomplished with the createTemporaryTopic method.

      Specified by:
      createTopic in interface jakarta.jms.Session
      Specified by:
      createTopic in interface jakarta.jms.TopicSession
      Parameters:
      topicName - the name of this Topic
      Returns:
      a Topic with the given name
      Throws:
      jakarta.jms.JMSException - if the session fails to create a topic due to some internal error.
      Since:
      1.1

    • 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

    • 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

    • createDurableSubscriber

      public jakarta.jms.TopicSubscriber createDurableSubscriber(jakarta.jms.Topic topic, String name) throws jakarta.jms.JMSException
      Creates a durable subscriber to the specified topic.

      If a client needs to receive all the messages published on a topic, including the ones published while the subscriber is inactive, it uses a durable TopicSubscriber. The JMS provider retains a record of this durable subscription and insures that all messages from the topic's publishers are retained until they are acknowledged by this durable subscriber or they have expired.

      Sessions with durable subscribers must always provide the same client identifier. In addition, each client must specify a name that uniquely identifies (within client identifier) each durable subscription it creates. Only one session at a time can have a TopicSubscriber for a particular durable subscription.

      A client can change an existing durable subscription by creating a durable TopicSubscriber with the same name and a new topic and/or message selector. Changing a durable subscriber is equivalent to unsubscribing (deleting) the old one and creating a new one.

      In some cases, a connection may both publish and subscribe to a topic. The subscriber NoLocal attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false.

      Specified by:
      createDurableSubscriber in interface jakarta.jms.Session
      Specified by:
      createDurableSubscriber in interface jakarta.jms.TopicSession
      Parameters:
      topic - the non-temporary Topic to subscribe to
      name - the name used to identify this subscription
      Returns:
      the TopicSubscriber
      Throws:
      jakarta.jms.JMSException - if the session fails to create a subscriber due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid topic is specified.
      Since:
      1.1

    • createDurableSubscriber

      public jakarta.jms.TopicSubscriber createDurableSubscriber(jakarta.jms.Topic topic, String name, String messageSelector, boolean noLocal) throws jakarta.jms.JMSException
      Creates a durable subscriber to the specified topic, using a message selector and specifying whether messages published by its own connection should be delivered to it.

      If a client needs to receive all the messages published on a topic, including the ones published while the subscriber is inactive, it uses a durable TopicSubscriber. The JMS provider retains a record of this durable subscription and insures that all messages from the topic's publishers are retained until they are acknowledged by this durable subscriber or they have expired.

      Sessions with durable subscribers must always provide the same client identifier. In addition, each client must specify a name which uniquely identifies (within client identifier) each durable subscription it creates. Only one session at a time can have a TopicSubscriber for a particular durable subscription. An inactive durable subscriber is one that exists but does not currently have a message consumer associated with it.

      A client can change an existing durable subscription by creating a durable TopicSubscriber with the same name and a new topic and/or message selector. Changing a durable subscriber is equivalent to unsubscribing (deleting) the old one and creating a new one.

      Specified by:
      createDurableSubscriber in interface jakarta.jms.Session
      Specified by:
      createDurableSubscriber in interface jakarta.jms.TopicSession
      Parameters:
      topic - the non-temporary Topic to subscribe to
      name - the name used to identify this subscription
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      noLocal - if set, inhibits the delivery of messages published by its own connection
      Returns:
      the Queue Browser
      Throws:
      jakarta.jms.JMSException - if the session fails to create a subscriber due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid topic is specified.
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.
      Since:
      1.1

    • createBrowser

      public jakarta.jms.QueueBrowser createBrowser(jakarta.jms.Queue queue) throws jakarta.jms.JMSException
      Creates a QueueBrowser object to peek at the messages on the specified queue.
      Specified by:
      createBrowser in interface jakarta.jms.QueueSession
      Specified by:
      createBrowser in interface jakarta.jms.Session
      Parameters:
      queue - the queue to access
      Returns:
      the Queue Browser
      Throws:
      jakarta.jms.JMSException - if the session fails to create a browser due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified
      Since:
      1.1

    • createBrowser

      public jakarta.jms.QueueBrowser createBrowser(jakarta.jms.Queue queue, String messageSelector) throws jakarta.jms.JMSException
      Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.
      Specified by:
      createBrowser in interface jakarta.jms.QueueSession
      Specified by:
      createBrowser in interface jakarta.jms.Session
      Parameters:
      queue - the queue to access
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      Returns:
      the Queue Browser
      Throws:
      jakarta.jms.JMSException - if the session fails to create a browser due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid destination is specified
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.
      Since:
      1.1

    • createTemporaryQueue

      public jakarta.jms.TemporaryQueue createTemporaryQueue() throws jakarta.jms.JMSException
      Creates a TemporaryQueue object. Its lifetime will be that of the Connection unless it is deleted earlier.
      Specified by:
      createTemporaryQueue in interface jakarta.jms.QueueSession
      Specified by:
      createTemporaryQueue in interface jakarta.jms.Session
      Returns:
      a temporary queue identity
      Throws:
      jakarta.jms.JMSException - if the session fails to create a temporary queue due to some internal error.
      Since:
      1.1

    • createTemporaryTopic

      public jakarta.jms.TemporaryTopic createTemporaryTopic() throws jakarta.jms.JMSException
      Creates a TemporaryTopic object. Its lifetime will be that of the Connection unless it is deleted earlier.
      Specified by:
      createTemporaryTopic in interface jakarta.jms.Session
      Specified by:
      createTemporaryTopic in interface jakarta.jms.TopicSession
      Returns:
      a temporary topic identity
      Throws:
      jakarta.jms.JMSException - if the session fails to create a temporary topic due to some internal error.
      Since:
      1.1

    • createReceiver

      public jakarta.jms.QueueReceiver createReceiver(jakarta.jms.Queue queue) throws jakarta.jms.JMSException
      Creates a QueueReceiver object to receive messages from the specified queue.
      Specified by:
      createReceiver in interface jakarta.jms.QueueSession
      Parameters:
      queue - the Queue to access
      Returns:
      a new QueueBrowser instance.
      Throws:
      jakarta.jms.JMSException - if the session fails to create a receiver due to some internal error.
      jakarta.jms.JMSException
      jakarta.jms.InvalidDestinationException - if an invalid queue is specified.

    • createReceiver

      public jakarta.jms.QueueReceiver createReceiver(jakarta.jms.Queue queue, String messageSelector) throws jakarta.jms.JMSException
      Creates a QueueReceiver object to receive messages from the specified queue using a message selector.
      Specified by:
      createReceiver in interface jakarta.jms.QueueSession
      Parameters:
      queue - the Queue to access
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      Returns:
      QueueReceiver
      Throws:
      jakarta.jms.JMSException - if the session fails to create a receiver due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid queue is specified.
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.

    • createSender

      public jakarta.jms.QueueSender createSender(jakarta.jms.Queue queue) throws jakarta.jms.JMSException
      Creates a QueueSender object to send messages to the specified queue.
      Specified by:
      createSender in interface jakarta.jms.QueueSession
      Parameters:
      queue - the Queue to access, or null if this is an unidentified producer
      Returns:
      QueueSender
      Throws:
      jakarta.jms.JMSException - if the session fails to create a sender due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid queue is specified.

    • createSubscriber

      public jakarta.jms.TopicSubscriber createSubscriber(jakarta.jms.Topic topic) throws jakarta.jms.JMSException
      Creates a nondurable subscriber to the specified topic.

      A client uses a TopicSubscriber object to receive messages that have been published to a topic.

      Regular TopicSubscriber objects are not durable. They receive only messages that are published while they are active.

      In some cases, a connection may both publish and subscribe to a topic. The subscriber NoLocal attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false.

      Specified by:
      createSubscriber in interface jakarta.jms.TopicSession
      Parameters:
      topic - the Topic to subscribe to
      Returns:
      TopicSubscriber
      Throws:
      jakarta.jms.JMSException - if the session fails to create a subscriber due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid topic is specified.

    • createSubscriber

      public jakarta.jms.TopicSubscriber createSubscriber(jakarta.jms.Topic topic, String messageSelector, boolean noLocal) throws jakarta.jms.JMSException
      Creates a nondurable subscriber to the specified topic, using a message selector or specifying whether messages published by its own connection should be delivered to it.

      A client uses a TopicSubscriber object to receive messages that have been published to a topic.

      Regular TopicSubscriber objects are not durable. They receive only messages that are published while they are active.

      Messages filtered out by a subscriber's message selector will never be delivered to the subscriber. From the subscriber's perspective, they do not exist.

      In some cases, a connection may both publish and subscribe to a topic. The subscriber NoLocal attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false.

      Specified by:
      createSubscriber in interface jakarta.jms.TopicSession
      Parameters:
      topic - the Topic to subscribe to
      messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
      noLocal - if set, inhibits the delivery of messages published by its own connection
      Returns:
      TopicSubscriber
      Throws:
      jakarta.jms.JMSException - if the session fails to create a subscriber due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid topic is specified.
      jakarta.jms.InvalidSelectorException - if the message selector is invalid.

    • createPublisher

      public jakarta.jms.TopicPublisher createPublisher(jakarta.jms.Topic topic) throws jakarta.jms.JMSException
      Creates a publisher for the specified topic.

      A client uses a TopicPublisher object to publish messages on a topic. Each time a client creates a TopicPublisher on a topic, it defines a new sequence of messages that have no ordering relationship with the messages it has previously sent.

      Specified by:
      createPublisher in interface jakarta.jms.TopicSession
      Parameters:
      topic - the Topic to publish to, or null if this is an unidentified producer
      Returns:
      TopicPublisher
      Throws:
      jakarta.jms.JMSException - if the session fails to create a publisher due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid topic is specified.

    • unsubscribe

      public void unsubscribe(String name) throws jakarta.jms.JMSException
      Unsubscribes a durable subscription that has been created by a client.

      This method deletes the state being maintained on behalf of the subscriber by its provider.

      It is erroneous for a client to delete a durable subscription while there is an active MessageConsumer or TopicSubscriber for the subscription, or while a consumed message is part of a pending transaction or has not been acknowledged in the session.

      Specified by:
      unsubscribe in interface jakarta.jms.Session
      Specified by:
      unsubscribe in interface jakarta.jms.TopicSession
      Parameters:
      name - the name used to identify this subscription
      Throws:
      jakarta.jms.JMSException - if the session fails to unsubscribe to the durable subscription due to some internal error.
      jakarta.jms.InvalidDestinationException - if an invalid subscription name is specified.
      Since:
      1.1

    • dispatch

      public void dispatch(MessageDispatch messageDispatch)
      Specified by:
      dispatch in interface ActiveMQDispatcher

    • acknowledge

      public void acknowledge() throws jakarta.jms.JMSException
      Acknowledges all consumed messages of the session of this consumed message.

      All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

      Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

      A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

      Messages that have been received but not acknowledged may be redelivered.

      Throws:
      jakarta.jms.JMSException - if the JMS provider fails to acknowledge the messages due to some internal error.
      jakarta.jms.IllegalStateException - if this method is called on a closed session.
      See Also:
      • Session.CLIENT_ACKNOWLEDGE

    • addConsumer

      protected void addConsumer(ActiveMQMessageConsumer consumer) throws jakarta.jms.JMSException
      Add a message consumer.
      Parameters:
      consumer - - message consumer.
      Throws:
      jakarta.jms.JMSException

    • removeConsumer

      protected void removeConsumer(ActiveMQMessageConsumer consumer)
      Remove the message consumer.
      Parameters:
      consumer - - consumer to be removed.
      Throws:
      jakarta.jms.JMSException

    • addProducer

      protected void addProducer(ActiveMQMessageProducer producer) throws jakarta.jms.JMSException
      Adds a message producer.
      Parameters:
      producer - - message producer to be added.
      Throws:
      jakarta.jms.JMSException

    • removeProducer

      protected void removeProducer(ActiveMQMessageProducer producer)
      Removes a message producer.
      Parameters:
      producer - - message producer to be removed.
      Throws:
      jakarta.jms.JMSException

    • start

      protected void start() throws jakarta.jms.JMSException
      Start this Session.
      Throws:
      jakarta.jms.JMSException

    • stop

      protected void stop() throws jakarta.jms.JMSException
      Stops this session.
      Throws:
      jakarta.jms.JMSException

    • getSessionId

      protected SessionId getSessionId()
      Returns the session id.
      Returns:
      value - session id.

    • getNextConsumerId

      protected ConsumerId getNextConsumerId()
      Returns:
      a unique ConsumerId instance.

    • getNextProducerId

      protected ProducerId getNextProducerId()
      Returns:
      a unique ProducerId instance.

    • send

      protected void send(ActiveMQMessageProducer producer, ActiveMQDestination destination, jakarta.jms.Message message, int deliveryMode, int priority, long timeToLive, MemoryUsage producerWindow, int sendTimeout, AsyncCallback onComplete) throws jakarta.jms.JMSException
      Sends the message for dispatch by the broker.
      Parameters:
      producer - - message producer.
      destination - - message destination.
      message - - message to be sent.
      deliveryMode - - JMS message delivery mode.
      priority - - message priority.
      timeToLive - - message expiration.
      producerWindow -
      onComplete -
      Throws:
      jakarta.jms.JMSException

    • send

      protected void send(ActiveMQMessageProducer producer, ActiveMQDestination destination, jakarta.jms.Message message, int deliveryMode, int priority, long timeToLive, boolean disableMessageID, boolean disableMessageTimestamp, MemoryUsage producerWindow, int sendTimeout, AsyncCallback onComplete) throws jakarta.jms.JMSException
      Sends the message for dispatch by the broker.
      Parameters:
      producer - - message producer.
      destination - - message destination.
      message - - message to be sent.
      deliveryMode - - JMS message delivery mode.
      priority - - message priority.
      timeToLive - - message expiration.
      disableTimestamp - - disable timestamp.
      disableMessageID - - optionally, disable messageID.
      producerWindow -
      onComplete -
      Throws:
      jakarta.jms.JMSException

    • doStartTransaction

      protected void doStartTransaction() throws jakarta.jms.JMSException
      Send TransactionInfo to indicate transaction has started
      Throws:
      jakarta.jms.JMSException - if some internal error occurs

    • hasUncomsumedMessages

      public boolean hasUncomsumedMessages()
      Checks whether the session has unconsumed messages.
      Returns:
      true - if there are unconsumed messages.

    • isTransacted

      public boolean isTransacted()
      Checks whether the session uses transactions.
      Returns:
      true - if the session uses transactions.

    • isClientAcknowledge

      protected boolean isClientAcknowledge()
      Checks whether the session used client acknowledgment.
      Returns:
      true - if the session uses client acknowledgment.

    • isAutoAcknowledge

      public boolean isAutoAcknowledge()
      Checks whether the session used auto acknowledgment.
      Returns:
      true - if the session uses client acknowledgment.

    • isDupsOkAcknowledge

      public boolean isDupsOkAcknowledge()
      Checks whether the session used dup ok acknowledgment.
      Returns:
      true - if the session uses client acknowledgment.

    • isIndividualAcknowledge

      public boolean isIndividualAcknowledge()

    • getDeliveryListener

      public ActiveMQSession.DeliveryListener getDeliveryListener()
      Returns the message delivery listener.
      Returns:
      deliveryListener - message delivery listener.

    • setDeliveryListener

      public void setDeliveryListener(ActiveMQSession.DeliveryListener deliveryListener)
      Sets the message delivery listener.
      Parameters:
      deliveryListener - - message delivery listener.

    • getSessionInfo

      protected SessionInfo getSessionInfo() throws jakarta.jms.JMSException
      Returns the SessionInfo bean.
      Returns:
      info - SessionInfo bean.
      Throws:
      jakarta.jms.JMSException

    • asyncSendPacket

      public void asyncSendPacket(Command command) throws jakarta.jms.JMSException
      Send the asynchronous command.
      Parameters:
      command - - command to be executed.
      Throws:
      jakarta.jms.JMSException

    • syncSendPacket

      public Response syncSendPacket(Command command) throws jakarta.jms.JMSException
      Send the synchronous command.
      Parameters:
      command - - command to be executed.
      Returns:
      Response
      Throws:
      jakarta.jms.JMSException

    • getNextDeliveryId

      public long getNextDeliveryId()

    • redispatch

      public void redispatch(ActiveMQDispatcher dispatcher, MessageDispatchChannel unconsumedMessages) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • isRunning

      public boolean isRunning()

    • isAsyncDispatch

      public boolean isAsyncDispatch()

    • setAsyncDispatch

      public void setAsyncDispatch(boolean asyncDispatch)

    • isSessionAsyncDispatch

      public boolean isSessionAsyncDispatch()
      Returns:
      Returns the sessionAsyncDispatch.

    • setSessionAsyncDispatch

      public void setSessionAsyncDispatch(boolean sessionAsyncDispatch)
      Parameters:
      sessionAsyncDispatch - The sessionAsyncDispatch to set.

    • getTransformer

      public MessageTransformer getTransformer()

    • getConnection

      public ActiveMQConnection getConnection()

    • setTransformer

      public void setTransformer(MessageTransformer transformer)
      Sets the transformer used to transform messages before they are sent on to the JMS bus or when they are received from the bus but before they are delivered to the JMS client

    • getBlobTransferPolicy

      public BlobTransferPolicy getBlobTransferPolicy()

    • setBlobTransferPolicy

      public void setBlobTransferPolicy(BlobTransferPolicy blobTransferPolicy)
      Sets the policy used to describe how out-of-band BLOBs (Binary Large OBjects) are transferred from producers to brokers to consumers

    • getUnconsumedMessages

      public List<MessageDispatch> getUnconsumedMessages()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • checkMessageListener

      public void checkMessageListener() throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • setOptimizeAcknowledge

      protected void setOptimizeAcknowledge(boolean value)

    • setPrefetchSize

      protected void setPrefetchSize(ConsumerId id, int prefetch)

    • close

      protected void close(ConsumerId id)

    • isInUse

      public boolean isInUse(ActiveMQTempDestination destination)

    • getLastDeliveredSequenceId

      public long getLastDeliveredSequenceId()
      highest sequence id of the last message delivered by this session. Passed to the broker in the close command, maintained by dispose()
      Returns:
      lastDeliveredSequenceId

    • sendAck

      protected void sendAck(MessageAck ack) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • sendAck

      protected void sendAck(MessageAck ack, boolean lazy) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • getScheduler

      protected Scheduler getScheduler() throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • getConnectionExecutor

      protected ThreadPoolExecutor getConnectionExecutor()