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

Class ActiveMQSession

    • Method Detail

      • createBytesMessage

        public BytesMessage createBytesMessage()
                                throws JMSException
        Description copied from interface: Session
        Creates a BytesMessage object. A BytesMessage object is used to send a message containing a stream of uninterpreted bytes.

        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:
        createBytesMessage in interface Session
        Returns:
        A BytesMessage object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • createMapMessage

        public MapMessage createMapMessage()
                            throws JMSException
        Description copied from interface: Session
        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 Session
        Returns:
        A MapMessage object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • createMessage

        public Message createMessage()
                      throws JMSException
        Description copied from interface: Session
        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 Session
        Returns:
        A Message object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • createObjectMessage

        public ObjectMessage createObjectMessage()
                                  throws JMSException
        Description copied from interface: Session
        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 Session
        Returns:
        A ObjectMessage object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • createObjectMessage

        public ObjectMessage createObjectMessage​(Serializable object)
                                  throws JMSException
        Description copied from interface: Session
        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 Session
        Parameters:
        object - the object to use to initialize this message
        Returns:
        A ObjectMessage object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • createStreamMessage

        public StreamMessage createStreamMessage()
                                  throws JMSException
        Description copied from interface: Session
        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 Session
        Returns:
        A StreamMessage object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • createTextMessage

        public TextMessage createTextMessage()
                              throws JMSException
        Description copied from interface: Session
        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 Session
        Returns:
        A TextMessage object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • createTextMessage

        public TextMessage createTextMessage​(String text)
                              throws JMSException
        Description copied from interface: Session
        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 Session
        Parameters:
        text - the string used to initialize this message
        Returns:
        A TextMessage object.
        Throws:
        JMSException - if the Jakarta Messaging provider fails to create this message due to some internal error.

      • getTransacted

        public boolean getTransacted()
                      throws JMSException
        Description copied from interface: Session
        Indicates whether the session is in transacted mode.
        Specified by:
        getTransacted in interface Session
        Returns:
        true if the session is in transacted mode
        Throws:
        JMSException - if the Jakarta Messaging provider fails to return the transaction mode due to some internal error.

      • getAcknowledgeMode

        public int getAcknowledgeMode()
                       throws JMSException
        Description copied from interface: Session
        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 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:
        JMSException - if the Jakarta Messaging provider fails to return the acknowledgment mode due to some internal error.
        See Also:
        Connection.createSession(boolean, int)

      • isXA

        public boolean isXA()

      • commit

        public void commit()
            throws JMSException
        Description copied from interface: Session
        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 Session 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 Session. Doing so will cause an IllegalStateException to be thrown.

        Specified by:
        commit in interface Session
        Throws:
        IllegalStateException -
        • the session is not using a local transaction
        • this method has been called by a CompletionListener callback method on its own Session
        JMSException - if the Jakarta Messaging provider fails to commit the transaction due to some internal error.
        TransactionRolledBackException - if the transaction is rolled back due to some internal error during commit.

      • rollback

        public void rollback()
              throws JMSException
        Description copied from interface: Session
        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 Session 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 Session. Doing so will cause an IllegalStateException to be thrown.

        Specified by:
        rollback in interface Session
        Throws:
        IllegalStateException -
        • the session is not using a local transaction
        • this method has been called by a CompletionListener callback method on its own Session
        JMSException - if the Jakarta Messaging provider fails to roll back the transaction due to some internal error.

      • close

        public void close()
           throws JMSException
        Description copied from interface: Session
        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.

        However if the close method is called from a message listener on its own Session, then it will either fail and throw a jakarta.jms.IllegalStateException, or it will succeed and close the Session, blocking until any pending receive call in progress has completed. If close succeeds and the acknowledge mode of the Session 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 Session because this is not portable.

        This method must not return until any incomplete asynchronous send operations for this Session 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 this session'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 transacted session must roll back the transaction in progress.

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

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

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

        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Session
        Throws:
        IllegalStateException -
        • this method has been called by a MessageListener on its own Session
        • this method has been called by a CompletionListener callback method on its own Session
        JMSException - if the Jakarta Messaging provider fails to close the session due to some internal error.

      • recover

        public void recover()
             throws JMSException
        Description copied from interface: Session
        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 Session
        Throws:
        JMSException - if the Jakarta Messaging provider fails to stop and restart message delivery due to some internal error.
        IllegalStateException - if the method is called by a transacted session.

      • getMessageListener

        public MessageListener getMessageListener()
                                   throws JMSException
        Description copied from interface: Session
        Returns the session's distinguished message listener (optional).

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

        Specified by:
        getMessageListener in interface Session
        Returns:
        the distinguished message listener associated with this session
        Throws:
        JMSException - if the Jakarta Messaging provider fails to get the session's distinguished message listener for one of the following reasons:
        • an internal error has occurred
        • this method has been called in a Jakarta EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)
        See Also:
        Session.setMessageListener(jakarta.jms.MessageListener), ServerSessionPool, ServerSession

      • setMessageListener

        public void setMessageListener​(MessageListener listener)
                        throws JMSException
        Description copied from interface: Session
        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.

        This is an expert facility not used by ordinary Jakarta Messaging clients.

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

        Specified by:
        setMessageListener in interface Session
        Parameters:
        listener - the message listener to associate with this session
        Throws:
        JMSException - if the Jakarta Messaging provider fails to set the session's distinguished message listener for one of the following reasons:
        • an internal error has occurred
        • this method has been called in a Jakarta EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)
        See Also:
        Session.getMessageListener(), ServerSessionPool, ServerSession

      • run

        public void run()
        Description copied from interface: Session
        Optional operation, intended to be used only by Application Servers, not by ordinary Jakarta Messaging clients.

        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.

        Specified by:
        run in interface Runnable
        Specified by:
        run in interface Session
        See Also:
        ServerSession

      • createProducer

        public MessageProducer createProducer​(Destination destination)
                               throws JMSException
        Description copied from interface: Session
        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 Session
        Parameters:
        destination - the Destination to send to, or null if this is a producer which does not have a specified destination.
        Returns:
        A MessageProducer to send messages.
        Throws:
        JMSException - if the session fails to create a MessageProducer due to some internal error.
        InvalidDestinationException - if an invalid destination is specified.

      • createConsumer

        public MessageConsumer createConsumer​(Destination destination)
                               throws JMSException
        Description copied from interface: Session
        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 Session
        Parameters:
        destination - the Destination to access.
        Returns:
        A MessageConsumer for the specified destination.
        Throws:
        JMSException - if the session fails to create a consumer due to some internal error.
        InvalidDestinationException - if an invalid destination is specified.

      • createConsumer

        public MessageConsumer createConsumer​(Destination destination,
                                      String messageSelector)
                               throws JMSException
        Description copied from interface: Session
        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 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:
        A MessageConsumer for the specified destination.
        Throws:
        JMSException - if the session fails to create a MessageConsumer due to some internal error.
        InvalidDestinationException - if an invalid destination is specified.
        InvalidSelectorException - if the message selector is invalid.

      • createConsumer

        public MessageConsumer createConsumer​(Destination destination,
                                      String messageSelector,
                                      boolean noLocal)
                               throws JMSException
        Description copied from interface: Session
        Creates a MessageConsumer for the specified destination, specifying a message selector and the noLocal parameter.

        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.

        The noLocal argument is for use when the destination is a topic and the session's connection is also being used to publish messages to that topic. If noLocal is set to true then the MessageConsumer 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.

        Specified by:
        createConsumer in interface 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, then the MessageConsumer will not receive messages published to the topic by its own connection.
        Returns:
        A MessageConsumer for the specified destination.
        Throws:
        JMSException - if the session fails to create a MessageConsumer due to some internal error.
        InvalidDestinationException - if an invalid destination is specified.
        InvalidSelectorException - if the message selector is invalid.

      • createQueue

        public Queue createQueue​(String queueName)
                  throws JMSException
        Description copied from interface: QueueSession
        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 Jakarta Messaging API. The one exception is the creation of temporary queues, which is accomplished with the createTemporaryQueue method.

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

      • createTopic

        public Topic createTopic​(String topicName)
                  throws JMSException
        Description copied from interface: Session
        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 Session
        Specified by:
        createTopic in interface TopicSession
        Parameters:
        topicName - A provider-specific topic name
        Returns:
        a Topic object which encapsulates the specified name
        Throws:
        JMSException - if a Topic object cannot be created due to some internal error

      • createDurableSubscriber

        public TopicSubscriber createDurableSubscriber​(Topic topic,
                                               String name)
                                        throws JMSException
        Description copied from interface: Session
        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 TopicSubscriber 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 JMSException 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 JMSException 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 createDurableConsumer method except that it returns a TopicSubscriber rather than a MessageConsumer to represent the consumer.

        Specified by:
        createDurableSubscriber in interface Session
        Specified by:
        createDurableSubscriber in interface TopicSession
        Parameters:
        topic - the non-temporary Topic to subscribe to
        name - the name used to identify this subscription
        Returns:
        An unshared durable subscription on the specified topic.
        Throws:
        InvalidDestinationException - if an invalid topic is specified.
        IllegalStateException - if the client identifier is unset
        JMSException -
        • if the session fails to create the unshared durable subscription and TopicSubscriber due to some internal error
        • if an unshared durable subscription already exists with the same name and client identifier, and there is a consumer already active
        • if a shared durable subscription already exists with the same name and client identifier

      • createDurableSubscriber

        public TopicSubscriber createDurableSubscriber​(Topic topic,
                                               String name,
                                               String messageSelector,
                                               boolean noLocal)
                                        throws JMSException
        Description copied from interface: Session
        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 TopicSubscriber 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 JMSException 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 session'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 JMSException 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 createDurableConsumer method except that it returns a TopicSubscriber rather than a MessageConsumer to represent the consumer.

        Specified by:
        createDurableSubscriber in interface Session
        Specified by:
        createDurableSubscriber in interface 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 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:
        An unshared durable subscription on the specified topic.
        Throws:
        InvalidDestinationException - if an invalid topic is specified.
        InvalidSelectorException - if the message selector is invalid.
        IllegalStateException - if the client identifier is unset
        JMSException -
        • if the session fails to create the unshared durable subscription and TopicSubscriber due to some internal error
        • if an unshared durable subscription already exists with the same name and client identifier, and there is a consumer already active
        • if a shared durable subscription already exists with the same name and client identifier

      • createSharedConsumer

        public MessageConsumer createSharedConsumer​(Topic topic,
                                            String sharedSubscriptionName)
                                     throws JMSException
        Description copied from interface: Session
        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 value has been specified, then this method creates a MessageConsumer 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 JMSException 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.

        Specified by:
        createSharedConsumer in interface Session
        Parameters:
        topic - the Topic to subscribe to
        sharedSubscriptionName - the name used to identify the shared non-durable subscription
        Returns:
        A shared non-durable subscription with the specified name on the specified topic.
        Throws:
        JMSException - if the session fails to create the shared non-durable subscription and MessageConsumer due to some internal error.
        InvalidDestinationException - if an invalid topic is specified.
        InvalidSelectorException - if the message selector is invalid.

      • createSharedConsumer

        public MessageConsumer createSharedConsumer​(Topic topic,
                                            String name,
                                            String messageSelector)
                                     throws JMSException
        Note: Needs to throw an exception if a subscriptionName is already in use by another topic, or if the messageSelector is different validate multiple subscriptions on the same session. validate multiple subscriptions on different sessions validate failure in one connection while another connection stills fine. Validate different filters in different possible scenarios
        Specified by:
        createSharedConsumer in interface Session
        Parameters:
        topic -
        name -
        messageSelector -
        Returns:
        Throws:
        JMSException
        InvalidDestinationException - if an invalid topic is specified.
        InvalidSelectorException - if the message selector is invalid.

      • createDurableConsumer

        public MessageConsumer createDurableConsumer​(Topic topic,
                                             String name)
                                      throws JMSException
        Description copied from interface: Session
        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 MessageConsumer 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 JMSException 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 JMSException 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 Session
        Parameters:
        topic - the non-temporary Topic to subscribe to
        name - the name used to identify this subscription
        Returns:
        An unshared durable subscription on the specified topic.
        Throws:
        InvalidDestinationException - if an invalid topic is specified.
        IllegalStateException - if the client identifier is unset
        JMSException -
        • if the session fails to create the unshared durable subscription and MessageConsumer due to some internal error
        • if an unshared durable subscription already exists with the same name and client identifier, and there is a consumer already active
        • if a shared durable subscription already exists with the same name and client identifier

      • createDurableConsumer

        public MessageConsumer createDurableConsumer​(Topic topic,
                                             String name,
                                             String messageSelector,
                                             boolean noLocal)
                                      throws JMSException
        Description copied from interface: Session
        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 MessageConsumer 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 JMSException 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 session'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 JMSException 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 Session
        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:
        An unshared durable subscription on the specified topic.
        Throws:
        InvalidDestinationException - if an invalid topic is specified.
        InvalidSelectorException - if the message selector is invalid.
        IllegalStateException - if the client identifier is unset
        JMSException -
        • if the session fails to create the unshared durable subscription and MessageConsumer due to some internal error
        • if an unshared durable subscription already exists with the same name and client identifier, and there is a consumer already active
        • if a shared durable subscription already exists with the same name and client identifier

      • createSharedDurableConsumer

        public MessageConsumer createSharedDurableConsumer​(Topic topic,
                                                   String name)
                                            throws JMSException
        Description copied from interface: Session
        Creates a shared 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. 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 MessageConsumer 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 JMSException 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 JMSException 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.

        Specified by:
        createSharedDurableConsumer in interface Session
        Parameters:
        topic - the non-temporary Topic to subscribe to
        name - the name used to identify this subscription
        Returns:
        A shared durable subscription on the specified topic.
        Throws:
        JMSException -
        • if the session fails to create the shared durable subscription and MessageConsumer due to some internal error
        • if a shared durable subscription already exists with the same name and client identifier, but a different topic or message selector, and there is a consumer already active
        • if an unshared durable subscription already exists with the same name and client identifier
        InvalidDestinationException - if an invalid topic is specified.

      • createSharedDurableConsumer

        public MessageConsumer createSharedDurableConsumer​(Topic topic,
                                                   String name,
                                                   String messageSelector)
                                            throws JMSException
        Description copied from interface: Session
        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 has been specified, then this method creates a MessageConsumer 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 JMSException 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 JMSException 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.

        Specified by:
        createSharedDurableConsumer in interface Session
        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:
        A shared durable subscription on the specified topic.
        Throws:
        JMSException -
        • if the session fails to create the shared durable subscription and MessageConsumer due to some internal error
        • if a shared durable subscription already exists with the same name and client identifier, but a different topic or message selector, and there is a consumer already active
        • if an unshared durable subscription already exists with the same name and client identifier
        InvalidDestinationException - if an invalid topic is specified.
        InvalidSelectorException - if the message selector is invalid.

      • getDeserializationBlackList

        public String getDeserializationBlackList()

      • getDeserializationWhiteList

        public String getDeserializationWhiteList()

      • createBrowser

        public QueueBrowser createBrowser​(Queue queue,
                                  String filterString)
                           throws JMSException
        Description copied from interface: QueueSession
        Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.
        Specified by:
        createBrowser in interface QueueSession
        Specified by:
        createBrowser in interface Session
        Parameters:
        queue - the Queue to access
        filterString - 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:
        A QueueBrowser object to peek at the messages on the specified queue.
        Throws:
        JMSException - if the session fails to create a browser due to some internal error.
        InvalidDestinationException - if an invalid queue is specified.
        InvalidSelectorException - if the message selector is invalid.

      • unsubscribe

        public void unsubscribe​(String name)
                 throws JMSException
        Description copied from interface: Session
        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 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 Session
        Specified by:
        unsubscribe in interface TopicSession
        Parameters:
        name - the name used to identify this subscription
        Throws:
        JMSException - if the session fails to unsubscribe to the durable subscription due to some internal error.
        InvalidDestinationException - if an invalid subscription name is specified.

      • getXAResource

        public XAResource getXAResource()

      • createReceiver

        public QueueReceiver createReceiver​(Queue queue,
                                    String messageSelector)
                             throws JMSException
        Description copied from interface: QueueSession
        Creates a QueueReceiver object to receive messages from the specified queue using a message selector.
        Specified by:
        createReceiver in interface 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:
        A QueueReceiver object to receive messages from the specified queue
        Throws:
        JMSException - if the session fails to create a receiver due to some internal error.
        InvalidDestinationException - if an invalid queue is specified.
        InvalidSelectorException - if the message selector is invalid.

      • createReceiver

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

      • createSender

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

      • createPublisher

        public TopicPublisher createPublisher​(Topic topic)
                               throws JMSException
        Description copied from interface: TopicSession
        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 TopicSession
        Parameters:
        topic - the Topic to publish to, or null if this is an unidentified producer
        Returns:
        A publisher for the specified topic.
        Throws:
        JMSException - if the session fails to create a publisher due to some internal error.
        InvalidDestinationException - if an invalid topic is specified.

      • createSubscriber

        public TopicSubscriber createSubscriber​(Topic topic,
                                        String messageSelector,
                                        boolean noLocal)
                                 throws JMSException
        Description copied from interface: TopicSession
        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 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:
        A nondurable subscriber to the specified topic.
        Throws:
        JMSException - if the session fails to create a subscriber due to some internal error.
        InvalidDestinationException - if an invalid topic is specified.
        InvalidSelectorException - if the message selector is invalid.

      • createSubscriber

        public TopicSubscriber createSubscriber​(Topic topic)
                                 throws JMSException
        Description copied from interface: TopicSession
        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 TopicSession
        Parameters:
        topic - the Topic to subscribe to
        Returns:
        A nondurable subscriber to the specified topic.
        Throws:
        JMSException - if the session fails to create a subscriber due to some internal error.
        InvalidDestinationException - if an invalid topic is specified.

      • isRecoverCalled

        public boolean isRecoverCalled()

      • setRecoverCalled

        public void setRecoverCalled​(boolean recoverCalled)

      • isEnable1xPrefixes

        public boolean isEnable1xPrefixes()