Package org.apache.activemq.artemis.jms.client

Class ActiveMQJMSContext

java.lang.Object
org.apache.activemq.artemis.jms.client.ActiveMQJMSContext
All Implemented Interfaces:
JMSContext, AutoCloseable
Direct Known Subclasses:
ActiveMQRAJMSContext, ActiveMQXAJMSContext
public class ActiveMQJMSContext extends Object implements JMSContext
ActiveMQ Artemis implementation of a JMSContext.

  • Constructor Details

  • Method Details

    • getContext

      public JMSContext getContext()

    • getSession

      public Session getSession()

    • getXAResource

      public XAResource getXAResource()

    • createContext

      public JMSContext createContext(int sessionMode)
      Description copied from interface: JMSContext
      Creates a new JMSContext with the specified session mode using the same connection as this JMSContext and creating a new session.

      This method does not start the connection. If the connection has not already been started then it will be automatically started when a JMSConsumer is created on any of the JMSContext objects for that connection.

      • If sessionMode is set to JMSContext.SESSION_TRANSACTED then the session will use a local transaction which may subsequently be committed or rolled back by calling the JMSContext's commit or rollback methods.
      • If sessionMode is set to any of JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE or JMSContext.DUPS_OK_ACKNOWLEDGE. then the session will be non-transacted and messages received by this session will be acknowledged according to the value of sessionMode. For a definition of the meaning of these acknowledgement modes see the links below.

      This method must not be used by applications running in the Jakarta EE web or EJB containers because doing so would violate the restriction that such an application must not attempt to create more than one active (not closed) Session object per connection. If this method is called in a Jakarta EE web or EJB container then a JMSRuntimeException will be thrown.

      Specified by:
      createContext in interface JMSContext
      Parameters:
      sessionMode - indicates which of four possible session modes will be used. The permitted values are JMSContext.SESSION_TRANSACTED, JMSContext.CLIENT_ACKNOWLEDGE, JMSContext.AUTO_ACKNOWLEDGE and JMSContext.DUPS_OK_ACKNOWLEDGE.
      Returns:
      a newly created JMSContext
      See Also:

    • createProducer

      public JMSProducer createProducer()
      Description copied from interface: JMSContext
      Creates a new JMSProducer object which can be used to configure and send messages
      Specified by:
      createProducer in interface JMSContext
      Returns:
      A new JMSProducer object
      See Also:

    • getClientID

      public String getClientID()
      Description copied from interface: JMSContext
      Gets the client identifier for the JMSContext's connection.

      This value is specific to the Jakarta Messaging provider. It is either preconfigured by an administrator in a ConnectionFactory object or assigned dynamically by the application by calling the setClientID method.

      Specified by:
      getClientID in interface JMSContext
      Returns:
      the unique client identifier

    • setClientID

      public void setClientID(String clientID)
      Description copied from interface: JMSContext
      Sets the client identifier for the JMSContext's connection.

      The preferred way to assign a Jakarta Messaging client's client identifier is for it to be configured in a client-specific ConnectionFactory object and transparently assigned to the Connection object it creates.

      Alternatively, a client can set the client identifier for the JMSContext's connection using a provider-specific value. The facility to set its client identifier explicitly is not a mechanism for overriding the identifier that has been administratively configured. It is provided for the case where no administratively specified identifier exists. If one does exist, an attempt to change it by setting it must throw an IllegalStateRuntimeException. If a client sets the client identifier explicitly, it must do so immediately after it creates the JMSContext and before any other action on the JMSContext is taken. After this point, setting the client identifier is a programming error that should throw an IllegalStateRuntimeException.

      The purpose of the client identifier is to associate the JMSContext's connection and its objects with a state maintained on behalf of the client by a provider. The only such state identified by the Jakarta Messaging API is that required to support durable subscriptions.

      If another connection with the same clientID is already running when this method is called, the Jakarta Messaging provider should detect the duplicate ID and throw an InvalidClientIDException.

      This method must not be used in a Jakarta EE web or EJB application. Doing so may cause a JMSRuntimeException to be thrown though this is not guaranteed.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      setClientID in interface JMSContext
      Parameters:
      clientID - the unique client identifier

    • getMetaData

      public ConnectionMetaData getMetaData()
      Description copied from interface: JMSContext
      Gets the connection metadata for the JMSContext's connection.
      Specified by:
      getMetaData in interface JMSContext
      Returns:
      the connection metadata
      See Also:

    • getExceptionListener

      public ExceptionListener getExceptionListener()
      Description copied from interface: JMSContext
      Gets the ExceptionListener object for the JMSContext's connection. Not every Connection has an ExceptionListener associated with it.
      Specified by:
      getExceptionListener in interface JMSContext
      Returns:
      the ExceptionListener for the JMSContext's connection, or null if no ExceptionListener is associated with that connection.
      See Also:

    • setExceptionListener

      public void setExceptionListener(ExceptionListener listener)
      Description copied from interface: JMSContext
      Sets an exception listener for the JMSContext's connection.

      If a Jakarta Messaging provider detects a serious problem with a connection, it informs the connection's ExceptionListener, if one has been registered. It does this by calling the listener's onException method, passing it a JMSRuntimeException object describing the problem.

      An exception listener allows a client to be notified of a problem asynchronously. Some connections only consume messages, so they would have no other way to learn their connection has failed.

      A connection serializes execution of its ExceptionListener.

      A Jakarta Messaging provider should attempt to resolve connection problems itself before it notifies the client of them.

      This method must not be used in a Jakarta EE web or EJB application. Doing so may cause a JMSRuntimeException to be thrown though this is not guaranteed.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      setExceptionListener in interface JMSContext
      Parameters:
      listener - the exception listener

    • start

      public void start()
      Description copied from interface: JMSContext
      Starts (or restarts) delivery of incoming messages by the JMSContext's connection. A call to start on a connection that has already been started is ignored. Also, it is normally not necessary for application to call this method, since the underlying connection used by the JMSContext will be started automatically when a consumer is created.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      start in interface JMSContext
      See Also:

    • stop

      public void stop()
      Description copied from interface: JMSContext
      Temporarily stops the delivery of incoming messages by the JMSContext's connection. Delivery can be restarted using the start method. When the connection is stopped, delivery to all the connection's message consumers is inhibited: synchronous receives block, and messages are not delivered to message listeners.

      Stopping a connection has no effect on its ability to send messages. A call to stop on a connection that has already been stopped is ignored.

      A call to stop must not return until delivery of messages has paused. This means that a client can rely on the fact that none of its message listeners will be called and that all threads of control waiting for receive calls to return will not return with a message until the connection is restarted. The receive timers for a stopped connection continue to advance, so receives may time out while the connection is stopped.

      If message listeners are running when stop is invoked, the stop call must wait until all of them have returned before it may return. While these message listeners are completing, they must have the full services of the connection available to them.

      However if the stop method is called from a message listener on its own JMSContext, or any other JMSContext that uses the same connection, then it will either fail and throw a jakarta.jms.IllegalStateRuntimeException, or it will succeed and stop the connection, blocking until all other message listeners that may have been running have returned.

      Since two alternative behaviors are permitted in this case, applications should avoid calling stop from a message listener on its own JMSContext, or any other JMSContext that uses the same connection, because this is not portable.

      For the avoidance of doubt, if an exception listener for the JMSContext's connection is running when stop is invoked, there is no requirement for the stop call to wait until the exception listener has returned before it may return.

      This method must not be used in a Jakarta EE web or EJB application. Doing so may cause a JMSRuntimeException to be thrown though this is not guaranteed.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      stop in interface JMSContext
      See Also:

    • setAutoStart

      public void setAutoStart(boolean autoStart)
      Description copied from interface: JMSContext
      Specifies whether the underlying connection used by this JMSContext will be started automatically when a consumer is created. This is the default behaviour, and it may be disabled by calling this method with a value of false.

      This method does not itself either start or stop the connection.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      setAutoStart in interface JMSContext
      Parameters:
      autoStart - Whether the underlying connection used by this JMSContext will be automatically started when a consumer is created.
      See Also:

    • getAutoStart

      public boolean getAutoStart()
      Description copied from interface: JMSContext
      Returns whether the underlying connection used by this JMSContext will be started automatically when a consumer is created.
      Specified by:
      getAutoStart in interface JMSContext
      Returns:
      whether the underlying connection used by this JMSContext will be started automatically when a consumer is created.
      See Also:

    • close

      public void close()
      Description copied from interface: JMSContext
      Closes the JMSContext

      This closes the underlying session and any underlying producers and consumers. If there are no other active (not closed) JMSContext objects using the underlying connection then this method also closes the underlying connection.

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

      Closing a connection causes all temporary destinations to be deleted.

      When this method is invoked, it should not return until message processing has been shut down in an orderly fashion. This means that all message listeners that may have been running have returned, and that all pending receives have returned. A close terminates all pending message receives on the connection's sessions' consumers. The receives may return with a message or with null, depending on whether there was a message available at the time of the close. If one or more of the connection's sessions' message listeners is processing a message at the time when connection close is invoked, all the facilities of the connection and its sessions must remain available to those listeners until they return control to the Jakarta Messaging provider.

      However if the close method is called from a message listener on its own JMSContext, then it will either fail and throw a jakarta.jms.IllegalStateRuntimeException, or it will succeed and close the JMSContext. If close succeeds and the session mode of the JMSContext is set to AUTO_ACKNOWLEDGE, the current message will still be acknowledged automatically when the onMessage call completes.

      Since two alternative behaviors are permitted in this case, applications should avoid calling close from a message listener on its own JMSContext because this is not portable.

      This method must not return until any incomplete asynchronous send operations for this JMSContext have been completed and any CompletionListener callbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.

      For the avoidance of doubt, if an exception listener for the JMSContext's connection is running when close is invoked, there is no requirement for the close call to wait until the exception listener has returned before it may return.

      Closing a connection causes any of its sessions' transactions in progress to be rolled back. In the case where a session's work is coordinated by an external transaction manager, a session's commit and rollback methods are not used and the result of a closed session's work is determined later by the transaction manager.

      Closing a connection does NOT force an acknowledgment of client-acknowledged sessions.

      Invoking the acknowledge method of a received message from a closed connection's session must throw an IllegalStateRuntimeException. Closing a closed connection must NOT throw an exception.

      A CompletionListener callback method must not call close on its own JMSContext. Doing so will cause an IllegalStateRuntimeException to be thrown.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface JMSContext

    • createBytesMessage

      public BytesMessage createBytesMessage()
      Description copied from interface: JMSContext
      Creates a BytesMessage object. A BytesMessage object is used to send a message containing a stream of uninterpreted bytes.
      Specified by:
      createBytesMessage in interface JMSContext
      Returns:
      The created BytesMessage object

    • createMapMessage

      public MapMessage createMapMessage()
      Description copied from interface: JMSContext
      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.

      The message object returned may be sent using any Session or JMSContext. It is not restricted to being sent using the JMSContext used to create it.

      The message object returned may be optimised for use with the Jakarta Messaging provider used to create it. However it can be sent using any Jakarta Messaging provider, not just the Jakarta Messaging provider used to create it.

      Specified by:
      createMapMessage in interface JMSContext
      Returns:
      The created MapMessage object.

    • createMessage

      public Message createMessage()
      Description copied from interface: JMSContext
      Creates a Message object. The Message interface is the root interface of all Jakarta Messaging messages. A Message object holds all the standard message header information. It can be sent when a message containing only header information is sufficient.

      The message object returned may be sent using any Session or JMSContext. It is not restricted to being sent using the JMSContext used to create it.

      The message object returned may be optimised for use with the Jakarta Messaging provider used to create it. However it can be sent using any Jakarta Messaging provider, not just the Jakarta Messaging provider used to create it.

      Specified by:
      createMessage in interface JMSContext
      Returns:
      The created Message object.

    • createObjectMessage

      public ObjectMessage createObjectMessage()
      Description copied from interface: JMSContext
      Creates an ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.

      The message object returned may be sent using any Session or JMSContext. It is not restricted to being sent using the JMSContext used to create it.

      The message object returned may be optimised for use with the Jakarta Messaging provider used to create it. However it can be sent using any Jakarta Messaging provider, not just the Jakarta Messaging provider used to create it.

      Specified by:
      createObjectMessage in interface JMSContext
      Returns:
      The created ObjectMessage object.

    • createObjectMessage

      public ObjectMessage createObjectMessage(Serializable object)
      Description copied from interface: JMSContext
      Creates an initialized ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.

      The message object returned may be sent using any Session or JMSContext. It is not restricted to being sent using the JMSContext used to create it.

      The message object returned may be optimised for use with the Jakarta Messaging provider used to create it. However it can be sent using any Jakarta Messaging provider, not just the Jakarta Messaging provider used to create it.

      Specified by:
      createObjectMessage in interface JMSContext
      Parameters:
      object - the object to use to initialize this message
      Returns:
      The created ObjectMessage object.

    • createStreamMessage

      public StreamMessage createStreamMessage()
      Description copied from interface: JMSContext
      Creates a StreamMessage object. A StreamMessage object is used to send a self-defining stream of primitive values in the Java programming language.

      The message object returned may be sent using any Session or JMSContext. It is not restricted to being sent using the JMSContext used to create it.

      The message object returned may be optimised for use with the Jakarta Messaging provider used to create it. However it can be sent using any Jakarta Messaging provider, not just the Jakarta Messaging provider used to create it.

      Specified by:
      createStreamMessage in interface JMSContext
      Returns:
      The created StreamMessage object.

    • createTextMessage

      public TextMessage createTextMessage()
      Description copied from interface: JMSContext
      Creates a TextMessage object. A TextMessage object is used to send a message containing a String object.

      The message object returned may be sent using any Session or JMSContext. It is not restricted to being sent using the JMSContext used to create it.

      The message object returned may be optimised for use with the Jakarta Messaging provider used to create it. However it can be sent using any Jakarta Messaging provider, not just the Jakarta Messaging provider used to create it.

      Specified by:
      createTextMessage in interface JMSContext
      Returns:
      The created TextMessage object.

    • createTextMessage

      public TextMessage createTextMessage(String text)
      Description copied from interface: JMSContext
      Creates an initialized TextMessage object. A TextMessage object is used to send a message containing a String.

      The message object returned may be sent using any Session or JMSContext. It is not restricted to being sent using the JMSContext used to create it.

      The message object returned may be optimised for use with the Jakarta Messaging provider used to create it. However it can be sent using any Jakarta Messaging provider, not just the Jakarta Messaging provider used to create it.

      Specified by:
      createTextMessage in interface JMSContext
      Parameters:
      text - the string used to initialize this message
      Returns:
      The created TextMessage object.

    • getTransacted

      public boolean getTransacted()
      Description copied from interface: JMSContext
      Indicates whether the JMSContext's session is in transacted mode.
      Specified by:
      getTransacted in interface JMSContext
      Returns:
      true if the session is in transacted mode

    • getSessionMode

      public int getSessionMode()
      Description copied from interface: JMSContext
      Returns the session mode of the JMSContext's session. This can be set at the time that the JMSContext is created. Possible values are JMSContext.SESSION_TRANSACTED, JMSContext.AUTO_ACKNOWLEDGE, JMSContext.CLIENT_ACKNOWLEDGE and JMSContext.DUPS_OK_ACKNOWLEDGE

      If a session mode was not specified when the JMSContext was created a value of JMSContext.AUTO_ACKNOWLEDGE will be returned.

      Specified by:
      getSessionMode in interface JMSContext
      Returns:
      the session mode of the JMSContext's session
      See Also:

    • commit

      public void commit()
      Description copied from interface: JMSContext
      Commits all messages done in this transaction and releases any locks currently held.

      This method must not return until any incomplete asynchronous send operations for this JMSContext have been completed and any CompletionListener callbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.

      A CompletionListener callback method must not call commit on its own JMSContext. Doing so will cause an IllegalStateRuntimeException to be thrown.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      commit in interface JMSContext

    • rollback

      public void rollback()
      Description copied from interface: JMSContext
      Rolls back any messages done in this transaction and releases any locks currently held.

      This method must not return until any incomplete asynchronous send operations for this JMSContext have been completed and any CompletionListener callbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.

      A CompletionListener callback method must not call rollback on its own JMSContext. Doing so will cause an IllegalStateRuntimeException to be thrown.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      rollback in interface JMSContext

    • recover

      public void recover()
      Description copied from interface: JMSContext
      Stops message delivery in the JMSContext's 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.

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      recover in interface JMSContext

    • createConsumer

      public JMSConsumer createConsumer(Destination destination)
      Description copied from interface: JMSContext
      Creates a JMSConsumer for the specified destination.

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

      There is no need to explicitly call the JMSContext.start() method as it is done automatically when the consumer is created, unless the autoStart property is set to false with JMSContext.setAutoStart(boolean).

      Specified by:
      createConsumer in interface JMSContext
      Parameters:
      destination - the Destination to access.
      Returns:
      The created JMSConsumer object.

    • createConsumer

      public JMSConsumer createConsumer(Destination destination, String messageSelector)
      Description copied from interface: JMSContext
      Creates a JMSConsumer for the specified destination, using a message selector.

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

      There is no need to explicitly call the JMSContext.start() method as it is done automatically when the consumer is created, unless the autoStart property is set to false with JMSContext.setAutoStart(boolean).

      Specified by:
      createConsumer in interface JMSContext
      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 JMSConsumer.
      Returns:
      The created JMSConsumer object.

    • createConsumer

      public JMSConsumer createConsumer(Destination destination, String messageSelector, boolean noLocal)
      Description copied from interface: JMSContext
      Creates a JMSConsumer for the specified destination, specifying a message selector and the noLocal parameter.

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

      The noLocal argument is for use when the destination is a topic and the JMSContext's connection is also being used to publish messages to that topic. If noLocal is set to true then the JMSConsumer will not receive messages published to the topic by its own connection. The default value of this argument is false. If the destination is a queue then the effect of setting noLocal to true is not specified.

      There is no need to explicitly call the JMSContext.start() method as it is done automatically when the consumer is created, unless the autoStart property is set to false with JMSContext.setAutoStart(boolean).

      Specified by:
      createConsumer in interface JMSContext
      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 JMSConsumer.
      noLocal - if true, and the destination is a topic, then the JMSConsumer will not receive messages published to the topic by its own connection
      Returns:
      The created JMSConsumer object.

    • createQueue

      public Queue createQueue(String queueName)
      Description copied from interface: JMSContext
      Creates a Queue object which encapsulates a specified provider-specific queue name.

      The use of provider-specific queue names in an application may render the application non-portable. Portable applications are recommended to not use this method but instead look up an administratively-defined Queue object using JNDI.

      Note that this method simply creates an object that encapsulates the name of a queue. It does not create the physical queue in the Jakarta Messaging provider. Jakarta Messaging does not provide a method to create the physical queue, since this would be specific to a given Jakarta Messaging provider. Creating a physical queue is provider-specific and is typically an administrative task performed by an administrator, though some providers may create them automatically when needed. The one exception to this is the creation of a temporary queue, which is done using the createTemporaryQueue method.

      Specified by:
      createQueue in interface JMSContext
      Parameters:
      queueName - A provider-specific queue name
      Returns:
      a Queue object which encapsulates the specified name

    • createTopic

      public Topic createTopic(String topicName)
      Description copied from interface: JMSContext
      Creates a Topic object which encapsulates a specified provider-specific topic name.

      The use of provider-specific topic names in an application may render the application non-portable. Portable applications are recommended to not use this method but instead look up an administratively-defined Topic object using JNDI.

      Note that this method simply creates an object that encapsulates the name of a topic. It does not create the physical topic in the Jakarta Messaging provider. Jakarta Messaging does not provide a method to create the physical topic, since this would be specific to a given Jakarta Messaging provider. Creating a physical topic is provider-specific and is typically an administrative task performed by an administrator, though some providers may create them automatically when needed. The one exception to this is the creation of a temporary topic, which is done using the createTemporaryTopic method.

      Specified by:
      createTopic in interface JMSContext
      Parameters:
      topicName - A provider-specific topic name
      Returns:
      a Topic object which encapsulates the specified name

    • createDurableConsumer

      public JMSConsumer createDurableConsumer(Topic topic, String name)
      Description copied from interface: JMSContext
      Creates an unshared durable subscription on the specified topic (if one does not already exist) and creates a consumer on that durable subscription. This method creates the durable subscription without a message selector and with a noLocal value of false.

      A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The Jakarta Messaging provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.

      A durable subscription will continue to accumulate messages until it is deleted using the unsubscribe method.

      This method may only be used with unshared durable subscriptions. Any durable subscription created using this method will be unshared. This means that only one active (i.e. not closed) consumer on the subscription may exist at a time. The term "consumer" here means a TopicSubscriber, MessageConsumer or JMSConsumer object in any client.

      An unshared durable subscription is identified by a name specified by the client and by the client identifier, which must be set. An application which subsequently wishes to create a consumer on that unshared durable subscription must use the same client identifier.

      If an unshared durable subscription already exists with the same name and client identifier, and the same topic, message selector and noLocal value has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this method creates a JMSConsumer on the existing durable subscription.

      If an unshared durable subscription already exists with the same name and client identifier, and there is a consumer already active (i.e. not closed) on the durable subscription, then a JMSRuntimeException will be thrown.

      If an unshared durable subscription already exists with the same name and client identifier but a different topic, message selector or noLocal value has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this is equivalent to unsubscribing (deleting) the old one and creating a new one.

      A shared durable subscription and an unshared durable subscription may not have the same name and client identifier. If a shared durable subscription already exists with the same name and client identifier then a JMSRuntimeException is thrown.

      There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId. Such subscriptions would be completely separate.

      Specified by:
      createDurableConsumer in interface JMSContext
      Parameters:
      topic - the non-temporary Topic to subscribe to
      name - the name used to identify this subscription
      Returns:
      The created JMSConsumer object.

    • createDurableConsumer

      public JMSConsumer createDurableConsumer(Topic topic, String name, String messageSelector, boolean noLocal)
      Description copied from interface: JMSContext
      Creates an unshared durable subscription on the specified topic (if one does not already exist), specifying a message selector and the noLocal parameter, and creates a consumer on that durable subscription.

      A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The Jakarta Messaging provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.

      A durable subscription will continue to accumulate messages until it is deleted using the unsubscribe method.

      This method may only be used with unshared durable subscriptions. Any durable subscription created using this method will be unshared. This means that only one active (i.e. not closed) consumer on the subscription may exist at a time. The term "consumer" here means a TopicSubscriber, MessageConsumer or JMSConsumer object in any client.

      An unshared durable subscription is identified by a name specified by the client and by the client identifier, which must be set. An application which subsequently wishes to create a consumer on that unshared durable subscription must use the same client identifier.

      If an unshared durable subscription already exists with the same name and client identifier, and the same topic, message selector and noLocal value has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this method creates a JMSConsumer on the existing durable subscription.

      If an unshared durable subscription already exists with the same name and client identifier, and there is a consumer already active (i.e. not closed) on the durable subscription, then a JMSRuntimeException will be thrown.

      If an unshared durable subscription already exists with the same name and client identifier but a different topic, message selector or noLocal value has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this is equivalent to unsubscribing (deleting) the old one and creating a new one.

      If noLocal is set to true then any messages published to the topic using this JMSContext's connection, or any other connection with the same client identifier, will not be added to the durable subscription.

      A shared durable subscription and an unshared durable subscription may not have the same name and client identifier. If a shared durable subscription already exists with the same name and client identifier then a JMSRuntimeException is thrown.

      There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId. Such subscriptions would be completely separate.

      This method is identical to the corresponding createDurableSubscriber method except that it returns a MessageConsumer rather than a TopicSubscriber to represent the consumer.

      Specified by:
      createDurableConsumer in interface JMSContext
      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 added to the durable subscription. A value of null or an empty string indicates that there is no message selector for the durable subscription.
      noLocal - if true then any messages published to the topic using this session's connection, or any other connection with the same client identifier, will not be added to the durable subscription.
      Returns:
      The created JMSConsumer object.

    • createSharedDurableConsumer

      public JMSConsumer createSharedDurableConsumer(Topic topic, String name)
      Description copied from interface: JMSContext
      Creates a shared durable subscription on the specified topic (if one does not already exist), specifying a message selector, and creates a consumer on that durable subscription. This method creates the durable subscription without a message selector.

      A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The Jakarta Messaging provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.

      A durable subscription will continue to accumulate messages until it is deleted using the unsubscribe method.

      This method may only be used with shared durable subscriptions. Any durable subscription created using this method will be shared. This means that multiple active (i.e. not closed) consumers on the subscription may exist at the same time. The term "consumer" here means a MessageConsumer or JMSConsumer object in any client.

      A shared durable subscription is identified by a name specified by the client and by the client identifier (which may be unset). An application which subsequently wishes to create a consumer on that shared durable subscription must use the same client identifier.

      If a shared durable subscription already exists with the same name and client identifier (if set), and the same topic and message selector has been specified, then this method creates a JMSConsumer on the existing shared durable subscription.

      If a shared durable subscription already exists with the same name and client identifier (if set) but a different topic or message selector has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this is equivalent to unsubscribing (deleting) the old one and creating a new one.

      If a shared durable subscription already exists with the same name and client identifier (if set) but a different topic or message selector has been specified, and there is a consumer already active (i.e. not closed) on the durable subscription, then a JMSRuntimeException will be thrown.

      A shared durable subscription and an unshared durable subscription may not have the same name and client identifier (if set). If an unshared durable subscription already exists with the same name and client identifier (if set) then a JMSRuntimeException is thrown.

      If a message selector is specified then only messages with properties matching the message selector expression will be added to the subscription.

      There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId (which may be unset). Such subscriptions would be completely separate.

      There is no need to explicitly call the JMSContext.start() method as it is done automatically when the consumer is created, unless the autoStart property is set to false with JMSContext.setAutoStart(boolean).

      Specified by:
      createSharedDurableConsumer in interface JMSContext
      Parameters:
      topic - the non-temporary Topic to subscribe to
      name - the name used to identify this subscription
      Returns:
      The created JMSConsumer object.

    • createSharedDurableConsumer

      public JMSConsumer createSharedDurableConsumer(Topic topic, String name, String messageSelector)
      Description copied from interface: JMSContext
      Creates a shared durable subscription on the specified topic (if one does not already exist), specifying a message selector, and creates a consumer on that durable subscription.

      A durable subscription is used by an application which needs to receive all the messages published on a topic, including the ones published when there is no active consumer associated with it. The Jakarta Messaging provider retains a record of this durable subscription and ensures that all messages from the topic's publishers are retained until they are delivered to, and acknowledged by, a consumer on this durable subscription or until they have expired.

      A durable subscription will continue to accumulate messages until it is deleted using the unsubscribe method.

      This method may only be used with shared durable subscriptions. Any durable subscription created using this method will be shared. This means that multiple active (i.e. not closed) consumers on the subscription may exist at the same time. The term "consumer" here means a MessageConsumer or JMSConsumer object in any client.

      A shared durable subscription is identified by a name specified by the client and by the client identifier (which may be unset). An application which subsequently wishes to create a consumer on that shared durable subscription must use the same client identifier.

      If a shared durable subscription already exists with the same name and client identifier (if set), and the same topic and message selector have been specified, then this method creates a JMSConsumer on the existing shared durable subscription.

      If a shared durable subscription already exists with the same name and client identifier (if set), but a different topic or message selector has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this is equivalent to unsubscribing (deleting) the old one and creating a new one.

      If a shared durable subscription already exists with the same name and client identifier (if set) but a different topic or message selector has been specified, and there is a consumer already active (i.e. not closed) on the durable subscription, then a JMSRuntimeException will be thrown.

      A shared durable subscription and an unshared durable subscription may not have the same name and client identifier (if set). If an unshared durable subscription already exists with the same name and client identifier (if set) then a JMSRuntimeException is thrown.

      There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId (which may be unset). Such subscriptions would be completely separate.

      There is no need to explicitly call the JMSContext.start() method as it is done automatically when the consumer is created, unless the autoStart property is set to false with JMSContext.setAutoStart(boolean).

      Specified by:
      createSharedDurableConsumer in interface JMSContext
      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 added to the durable subscription. A value of null or an empty string indicates that there is no message selector for the durable subscription.
      Returns:
      The created JMSConsumer object.

    • createSharedConsumer

      public JMSConsumer createSharedConsumer(Topic topic, String sharedSubscriptionName)
      Description copied from interface: JMSContext
      Creates a shared non-durable subscription with the specified name on the specified topic (if one does not already exist) and creates a consumer on that subscription. This method creates the non-durable subscription without a message selector.

      If a shared non-durable subscription already exists with the same name and client identifier (if set), and the same topic and message selector has been specified, then this method creates a JMSConsumer on the existing subscription.

      A non-durable shared subscription is used by a client which needs to be able to share the work of receiving messages from a topic subscription amongst multiple consumers. A non-durable shared subscription may therefore have more than one consumer. Each message from the subscription will be delivered to only one of the consumers on that subscription. Such a subscription is not persisted and will be deleted (together with any undelivered messages associated with it) when there are no consumers on it. The term "consumer" here means a MessageConsumer or JMSConsumer object in any client.

      A shared non-durable subscription is identified by a name specified by the client and by the client identifier (which may be unset). An application which subsequently wishes to create a consumer on that shared non-durable subscription must use the same client identifier.

      If a shared non-durable subscription already exists with the same name and client identifier (if set) but a different topic or message selector value has been specified, and there is a consumer already active (i.e. not closed) on the subscription, then a JMSRuntimeException will be thrown.

      There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId (which may be unset). Such subscriptions would be completely separate.

      There is no need to explicitly call the JMSContext.start() method as it is done automatically when the consumer is created, unless the autoStart property is set to false with JMSContext.setAutoStart(boolean).

      Specified by:
      createSharedConsumer in interface JMSContext
      Parameters:
      topic - the Topic to subscribe to
      sharedSubscriptionName - the name used to identify the shared non-durable subscription
      Returns:
      The created JMSConsumer object.

    • createSharedConsumer

      public JMSConsumer createSharedConsumer(Topic topic, String sharedSubscriptionName, String messageSelector)
      Description copied from interface: JMSContext
      Creates a shared non-durable subscription with the specified name on the specified topic (if one does not already exist) specifying a message selector, and creates a consumer on that subscription.

      If a shared non-durable subscription already exists with the same name and client identifier (if set), and the same topic and message selector has been specified, then this method creates a JMSConsumer on the existing subscription.

      A non-durable shared subscription is used by a client which needs to be able to share the work of receiving messages from a topic subscription amongst multiple consumers. A non-durable shared subscription may therefore have more than one consumer. Each message from the subscription will be delivered to only one of the consumers on that subscription. Such a subscription is not persisted and will be deleted (together with any undelivered messages associated with it) when there are no consumers on it. The term "consumer" here means a MessageConsumer or JMSConsumer object in any client.

      A shared non-durable subscription is identified by a name specified by the client and by the client identifier (which may be unset). An application which subsequently wishes to create a consumer on that shared non-durable subscription must use the same client identifier.

      If a shared non-durable subscription already exists with the same name and client identifier (if set) but a different topic or message selector has been specified, and there is a consumer already active (i.e. not closed) on the subscription, then a JMSRuntimeException will be thrown.

      There is no restriction on durable subscriptions and shared non-durable subscriptions having the same name and clientId (which may be unset). Such subscriptions would be completely separate.

      There is no need to explicitly call the JMSContext.start() method as it is done automatically when the consumer is created, unless the autoStart property is set to false with JMSContext.setAutoStart(boolean).

      Specified by:
      createSharedConsumer in interface JMSContext
      Parameters:
      topic - the Topic to subscribe to
      sharedSubscriptionName - the name used to identify the shared non-durable subscription
      messageSelector - only messages with properties matching the message selector expression are added to the shared non-durable subscription. A value of null or an empty string indicates that there is no message selector for the shared non-durable subscription.
      Returns:
      The created JMSConsumer object.

    • createBrowser

      public QueueBrowser createBrowser(Queue queue)
      Description copied from interface: JMSContext
      Creates a QueueBrowser object to peek at the messages on the specified queue.
      Specified by:
      createBrowser in interface JMSContext
      Parameters:
      queue - the queue to access
      Returns:
      The created QueueBrowser object.

    • createBrowser

      public QueueBrowser createBrowser(Queue queue, String messageSelector)
      Description copied from interface: JMSContext
      Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.
      Specified by:
      createBrowser in interface JMSContext
      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 created QueueBrowser object.

    • createTemporaryQueue

      public TemporaryQueue createTemporaryQueue()
      Description copied from interface: JMSContext
      Creates a TemporaryQueue object. Its lifetime will be that of the JMSContext's Connection unless it is deleted earlier.
      Specified by:
      createTemporaryQueue in interface JMSContext
      Returns:
      a temporary queue identity

    • createTemporaryTopic

      public TemporaryTopic createTemporaryTopic()
      Description copied from interface: JMSContext
      Creates a TemporaryTopic object. Its lifetime will be that of the JMSContext's Connection unless it is deleted earlier.
      Specified by:
      createTemporaryTopic in interface JMSContext
      Returns:
      a temporary topic identity

    • unsubscribe

      public void unsubscribe(String name)
      Description copied from interface: JMSContext
      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.

      A durable subscription is identified by a name specified by the client and by the client identifier if set. If the client identifier was set when the durable subscription was created then a client which subsequently wishes to use this method to delete a durable subscription must use the same client identifier.

      It is erroneous for a client to delete a durable subscription while there is an active (not closed) consumer on that subscription, or while a consumed message is part of a pending transaction or has not been acknowledged in the session.

      If the active consumer is represented by a JMSConsumer then calling close on either that object or the JMSContext used to create it will render the consumer inactive and allow the subscription to be deleted.

      If the active consumer was created by calling setMessageListener on the JMSContext then calling close on the JMSContext will render the consumer inactive and allow the subscription to be deleted.

      If the active consumer is represented by a MessageConsumer or TopicSubscriber then calling close on that object or on the Session or Connection used to create it will render the consumer inactive and allow the subscription to be deleted.

      Specified by:
      unsubscribe in interface JMSContext
      Parameters:
      name - the name used to identify this subscription

    • acknowledge

      public void acknowledge()
      Description copied from interface: JMSContext
      Acknowledges all messages consumed by the JMSContext's session.

      This method is for use when the session has an acknowledgement mode of CLIENT_ACKNOWLEDGE. If the session is transacted or has an acknowledgement mode of AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE calling this method has no effect.

      This method has identical behaviour to the acknowledge method on Message. A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group. In both cases it makes no difference which of these two methods is used.

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

      This method must not be used if the JMSContext is container-managed (injected). Doing so will cause a IllegalStateRuntimeException to be thrown.

      Specified by:
      acknowledge in interface JMSContext
      See Also:

    • getUsedSession

      public Session getUsedSession()
      This is to be used on tests only. It's not part of the interface and it's not guaranteed to be kept on the API contract.

    • getThreadAwareContext

      public ThreadAwareContext getThreadAwareContext()