Class PulsarSession
- All Implemented Interfaces:
AutoCloseable,Runnable,javax.jms.QueueSession,javax.jms.Session,javax.jms.TopicSession
-
Field Summary
Fields inherited from interface javax.jms.Session
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidclose()Closes the session.voidcommit()Commits all messages done in this transaction and releases any locks currently held.javax.jms.QueueBrowsercreateBrowser(javax.jms.Queue queue) Creates aQueueBrowserobject to peek at the messages on the specified queue.javax.jms.QueueBrowsercreateBrowser(javax.jms.Queue queue, String messageSelector) Creates aQueueBrowserobject to peek at the messages on the specified queue using a message selector.Creates aBytesMessageobject.createConsumer(javax.jms.Destination destination) Creates aMessageConsumerfor the specified destination.createConsumer(javax.jms.Destination destination, String messageSelector) Creates aMessageConsumerfor the specified destination, using a message selector.createConsumer(javax.jms.Destination destination, String messageSelector, boolean noLocal) Creates aMessageConsumerfor the specified destination, specifying a message selector and thenoLocalparameter.javax.jms.MessageConsumercreateDurableConsumer(javax.jms.Topic topic, String name) Creates an unshared durable subscription on the specified topic (if one does not already exist) and creates a consumer on that durable subscription.createDurableConsumer(javax.jms.Topic topic, String name, String messageSelector, boolean noLocal) Creates an unshared durable subscription on the specified topic (if one does not already exist), specifying a message selector and thenoLocalparameter, and creates a consumer on that durable subscription.javax.jms.TopicSubscribercreateDurableSubscriber(javax.jms.Topic topic, String name) Creates an unshared durable subscription on the specified topic (if one does not already exist) and creates a consumer on that durable subscription.javax.jms.TopicSubscribercreateDurableSubscriber(javax.jms.Topic topic, String name, String messageSelector, boolean noLocal) Creates an unshared durable subscription on the specified topic (if one does not already exist), specifying a message selector and thenoLocalparameter, and creates a consumer on that durable subscription.javax.jms.MapMessageCreates aMapMessageobject.javax.jms.MapMessagecreateMapMessage(Map<String, Object> body) javax.jms.MessageCreates aMessageobject.javax.jms.ObjectMessageCreates anObjectMessageobject.javax.jms.ObjectMessagecreateObjectMessage(Serializable object) Creates an initializedObjectMessageobject.com.datastax.oss.pulsar.jms.PulsarMessageProducercreateProducer(javax.jms.Destination destination) Creates aMessageProducerto send messages to the specified destination.javax.jms.TopicPublishercreatePublisher(javax.jms.Topic topic) createQueue(String queueName) Creates aQueueobject which encapsulates a specified provider-specific queue name.javax.jms.QueueReceivercreateReceiver(javax.jms.Queue queue) javax.jms.QueueReceivercreateReceiver(javax.jms.Queue queue, String s) javax.jms.QueueSendercreateSender(javax.jms.Queue queue) createSession(int sessionMode, Map<String, Object> customConfiguration) Build a new Sessopm that shares the same Connection, asJMSContext.createContext(int).javax.jms.MessageConsumercreateSharedConsumer(javax.jms.Topic topic, String sharedSubscriptionName) 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.createSharedConsumer(javax.jms.Topic topic, String sharedSubscriptionName, String messageSelector) 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.javax.jms.MessageConsumercreateSharedDurableConsumer(javax.jms.Topic topic, String name) Creates a shared durable subscription on the specified topic (if one does not already exist), specifying a message selector and thenoLocalparameter, and creates a consumer on that durable subscription.createSharedDurableConsumer(javax.jms.Topic topic, String name, String messageSelector) 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.javax.jms.StreamMessageCreates aStreamMessageobject.javax.jms.TopicSubscribercreateSubscriber(javax.jms.Topic topic) javax.jms.TopicSubscribercreateSubscriber(javax.jms.Topic topic, String s, boolean b) javax.jms.TemporaryQueueCreates aTemporaryQueueobject.javax.jms.TemporaryTopicCreates aTemporaryTopicobject.javax.jms.TextMessageCreates aTextMessageobject.javax.jms.TextMessagecreateTextMessage(String text) Creates an initializedTextMessageobject.createTopic(String topicName) Creates aTopicobject which encapsulates a specified provider-specific topic name.intReturns the acknowledgement mode of the session.javax.jms.MessageListenerReturns the session's distinguished message listener (optional).booleanIndicates whether the session is in transacted mode.longbooleanisClosed()booleanisJms20()booleanvoidvoidrecover()Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.voidregisterConsumer(PulsarMessageConsumer consumer) protected voidregisterProducerWithTransaction(com.datastax.oss.pulsar.jms.PulsarMessageProducer producer) voidrollback()Rolls back any messages done in this transaction and releases any locks currently held.voidrun()Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.voidsetJms20(boolean jms20) voidsetMessageListener(javax.jms.MessageListener listener) Sets the session's distinguished message listener (optional).voidunsubscribe(String name) Unsubscribes a durable subscription that has been created by a client.
-
Method Details
-
createSession
public PulsarSession createSession(int sessionMode, Map<String, Object> customConfiguration) throws javax.jms.JMSExceptionBuild a new Sessopm that shares the same Connection, asJMSContext.createContext(int). But you can override some configuration settings, like "consumerConfig"- Parameters:
sessionMode-customConfiguration-- Returns:
- a new Pulsar Session
- Throws:
javax.jms.JMSException
-
registerProducerWithTransaction
protected void registerProducerWithTransaction(com.datastax.oss.pulsar.jms.PulsarMessageProducer producer) -
createBytesMessage
Creates aBytesMessageobject. ABytesMessageobject is used to send a message containing a stream of uninterpreted bytes.The message object returned may be sent using any
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createBytesMessagein interfacejavax.jms.Session- Returns:
- A
BytesMessageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
createMapMessage
public javax.jms.MapMessage createMapMessage() throws javax.jms.JMSExceptionCreates aMapMessageobject. AMapMessageobject is used to send a self-defining set of name-value pairs, where names areStringobjects and values are primitive values in the Java programming language.The message object returned may be sent using any
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createMapMessagein interfacejavax.jms.Session- Returns:
- A
MapMessageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
createMapMessage
- Throws:
javax.jms.JMSException
-
createMessage
public javax.jms.Message createMessage() throws javax.jms.JMSExceptionCreates aMessageobject. TheMessageinterface is the root interface of all JMS messages. AMessageobject 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
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createMessagein interfacejavax.jms.Session- Returns:
- A
Messageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
createObjectMessage
public javax.jms.ObjectMessage createObjectMessage() throws javax.jms.JMSExceptionCreates anObjectMessageobject. AnObjectMessageobject is used to send a message that contains a serializable Java object.The message object returned may be sent using any
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createObjectMessagein interfacejavax.jms.Session- Returns:
- A
ObjectMessageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
createObjectMessage
public javax.jms.ObjectMessage createObjectMessage(Serializable object) throws javax.jms.JMSException Creates an initializedObjectMessageobject. AnObjectMessageobject is used to send a message that contains a serializable Java object.The message object returned may be sent using any
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createObjectMessagein interfacejavax.jms.Session- Parameters:
object- the object to use to initialize this message- Returns:
- A
ObjectMessageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
createStreamMessage
public javax.jms.StreamMessage createStreamMessage() throws javax.jms.JMSExceptionCreates aStreamMessageobject. AStreamMessageobject 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
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createStreamMessagein interfacejavax.jms.Session- Returns:
- A
StreamMessageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
createTextMessage
public javax.jms.TextMessage createTextMessage() throws javax.jms.JMSExceptionCreates aTextMessageobject. ATextMessageobject is used to send a message containing aStringobject.The message object returned may be sent using any
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createTextMessagein interfacejavax.jms.Session- Returns:
- A
TextMessageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
createTextMessage
Creates an initializedTextMessageobject. ATextMessageobject is used to send a message containing aString.The message object returned may be sent using any
SessionorJMSContext. It is not restricted to being sent using theJMSContextused to create it.The message object returned may be optimised for use with the JMS provider used to create it. However it can be sent using any JMS provider, not just the JMS provider used to create it.
- Specified by:
createTextMessagein interfacejavax.jms.Session- Parameters:
text- the string used to initialize this message- Returns:
- A
TextMessageobject. - Throws:
javax.jms.JMSException- if the JMS provider fails to create this message due to some internal error.
-
getTransacted
public boolean getTransacted() throws javax.jms.JMSExceptionIndicates whether the session is in transacted mode.- Specified by:
getTransactedin interfacejavax.jms.Session- Returns:
- true if the session is in transacted mode
- Throws:
javax.jms.JMSException- if the JMS provider fails to return the transaction mode due to some internal error.
-
getAcknowledgeMode
public int getAcknowledgeMode() throws javax.jms.JMSExceptionReturns 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:
getAcknowledgeModein interfacejavax.jms.Session- Returns:
- If the session is not transacted, returns the current acknowledgement mode for the session. If the session is transacted, returns SESSION_TRANSACTED.
- Throws:
javax.jms.JMSException- if the JMS provider fails to return the acknowledgment mode due to some internal error.- Since:
- JMS 1.1
- See Also:
-
Connection.createSession(boolean, int)
-
getTransactionStickyKey
public long getTransactionStickyKey() -
commit
public void commit() throws javax.jms.JMSExceptionCommits 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
Sessionhave been completed and anyCompletionListenercallbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.A
CompletionListenercallback method must not callcommiton its ownSession. Doing so will cause anIllegalStateExceptionto be thrown.- Specified by:
commitin interfacejavax.jms.Session- Throws:
javax.jms.IllegalStateException-- the session is not using a local transaction
- this method has been called by a
CompletionListenercallback method on its ownSession
javax.jms.JMSException- if the JMS provider fails to commit the transaction due to some internal error.javax.jms.TransactionRolledBackException- if the transaction is rolled back due to some internal error during commit.
-
rollback
public void rollback() throws javax.jms.JMSExceptionRolls 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
Sessionhave been completed and anyCompletionListenercallbacks have returned. Incomplete sends should be allowed to complete normally unless an error occurs.A
CompletionListenercallback method must not callcommiton its ownSession. Doing so will cause anIllegalStateExceptionto be thrown.- Specified by:
rollbackin interfacejavax.jms.Session- Throws:
javax.jms.IllegalStateException-- the session is not using a local transaction
- this method has been called by a
CompletionListenercallback method on its ownSession
javax.jms.JMSException- if the JMS provider fails to roll back the transaction due to some internal error.
-
close
public void close() throws javax.jms.JMSExceptionCloses 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
receivecall or message listener in progress has completed. A blocked message consumerreceivecall returnsnullwhen 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 ajavax.jms.IllegalStateException, or it will succeed and close theSession, blocking until any pending receive call in progress has completed. If close succeeds and the acknowledge mode of theSessionis set toAUTO_ACKNOWLEDGE, the current message will still be acknowledged automatically when theonMessagecall completes.Since two alternative behaviors are permitted in this case, applications should avoid calling close from a message listener on its own
Sessionbecause this is not portable.This method must not return until any incomplete asynchronous send operations for this
Sessionhave been completed and anyCompletionListenercallbacks 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
closeis invoked, there is no requirement for theclosecall 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
Sessionmethod that can be called concurrently.A
CompletionListenercallback method must not callcloseon its ownSession. Doing so will cause anIllegalStateExceptionto be thrown.Invoking any other
Sessionmethod on a closed session must throw aIllegalStateException. Closing a closed session must not throw an exception.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfacejavax.jms.Session- Throws:
javax.jms.IllegalStateException-- this method has been called by a
MessageListeneron its ownSession - this method has been called by a
CompletionListenercallback method on its ownSession
- this method has been called by a
javax.jms.JMSException- if the JMS provider fails to close the session due to some internal error.
-
recover
public void recover() throws javax.jms.JMSExceptionStops 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:
recoverin interfacejavax.jms.Session- Throws:
javax.jms.JMSException- if the JMS provider fails to stop and restart message delivery due to some internal error.javax.jms.IllegalStateException- if the method is called by a transacted session.
-
getMessageListener
public javax.jms.MessageListener getMessageListener() throws javax.jms.JMSExceptionReturns the session's distinguished message listener (optional).This method must not be used in a Java EE web or EJB application. Doing so may cause a
JMSExceptionto be thrown though this is not guaranteed.- Specified by:
getMessageListenerin interfacejavax.jms.Session- Returns:
- the distinguished message listener associated with this session
- Throws:
javax.jms.JMSException- if the JMS 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 Java EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)
- See Also:
-
Session.setMessageListener(javax.jms.MessageListener)ServerSessionPoolServerSession
-
setMessageListener
public void setMessageListener(javax.jms.MessageListener listener) throws javax.jms.JMSException Sets the session's distinguished message listener (optional).When the distinguished message listener is set, no other form of message receipt in the session can be used; however, all forms of sending messages are still supported.
This is an expert facility not used by ordinary JMS clients.
This method must not be used in a Java EE web or EJB application. Doing so may cause a
JMSExceptionto be thrown though this is not guaranteed.- Specified by:
setMessageListenerin interfacejavax.jms.Session- Parameters:
listener- the message listener to associate with this session- Throws:
javax.jms.JMSException- if the JMS 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 Java EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)
- See Also:
-
Session.getMessageListener()ServerSessionPoolServerSession
-
run
public void run()Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.This method must not be used in a Java EE web or EJB application. Doing so may cause a
JMSRuntimeExceptionto be thrown though this is not guaranteed. -
createProducer
public com.datastax.oss.pulsar.jms.PulsarMessageProducer createProducer(javax.jms.Destination destination) throws javax.jms.JMSException Creates aMessageProducerto send messages to the specified destination.A client uses a
MessageProducerobject to send messages to a destination. SinceQueueandTopicboth inherit fromDestination, they can be used in the destination parameter to create aMessageProducerobject.- Specified by:
createProducerin interfacejavax.jms.Session- Parameters:
destination- theDestinationto send to, or null if this is a producer which does not have a specified destination.- Returns:
- A
MessageProducerto send messages. - Throws:
javax.jms.JMSException- if the session fails to create a MessageProducer due to some internal error.javax.jms.InvalidDestinationException- if an invalid destination is specified.- Since:
- JMS 1.1
-
createConsumer
public PulsarMessageConsumer createConsumer(javax.jms.Destination destination) throws javax.jms.JMSException Creates aMessageConsumerfor the specified destination. SinceQueueandTopicboth inherit fromDestination, they can be used in the destination parameter to create aMessageConsumer.- Specified by:
createConsumerin interfacejavax.jms.Session- Parameters:
destination- theDestinationto access.- Returns:
- A
MessageConsumerfor the specified destination. - Throws:
javax.jms.JMSException- if the session fails to create a consumer due to some internal error.javax.jms.InvalidDestinationException- if an invalid destination is specified.- Since:
- JMS 1.1
-
createConsumer
public PulsarMessageConsumer createConsumer(javax.jms.Destination destination, String messageSelector) throws javax.jms.JMSException Creates aMessageConsumerfor the specified destination, using a message selector. SinceQueueandTopicboth inherit fromDestination, they can be used in the destination parameter to create aMessageConsumer.A client uses a
MessageConsumerobject to receive messages that have been sent to a destination.- Specified by:
createConsumerin interfacejavax.jms.Session- Parameters:
destination- theDestinationto accessmessageSelector- 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
MessageConsumerfor the specified destination. - Throws:
javax.jms.JMSException- if the session fails to create a MessageConsumer due to some internal error.javax.jms.InvalidDestinationException- if an invalid destination is specified.javax.jms.InvalidSelectorException- if the message selector is invalid.- Since:
- JMS 1.1
-
createConsumer
public PulsarMessageConsumer createConsumer(javax.jms.Destination destination, String messageSelector, boolean noLocal) throws javax.jms.JMSException Creates aMessageConsumerfor the specified destination, specifying a message selector and thenoLocalparameter.Since
QueueandTopicboth inherit fromDestination, they can be used in the destination parameter to create aMessageConsumer.A client uses a
MessageConsumerobject to receive messages that have been published to a destination.The
noLocalargument is for use when the destination is a topic and the session's connection is also being used to publish messages to that topic. IfnoLocalis set to true then theMessageConsumerwill 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 settingnoLocalto true is not specified.- Specified by:
createConsumerin interfacejavax.jms.Session- Parameters:
destination- theDestinationto accessmessageSelector- 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 theMessageConsumerwill not receive messages published to the topic by its own connection.- Returns:
- A
MessageConsumerfor the specified destination. - Throws:
javax.jms.JMSException- if the session fails to create a MessageConsumer due to some internal error.javax.jms.InvalidDestinationException- if an invalid destination is specified.javax.jms.InvalidSelectorException- if the message selector is invalid.- Since:
- JMS 1.1
-
createQueue
Creates aQueueobject 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
Queueobject 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 JMS provider. JMS does not provide a method to create the physical queue, since this would be specific to a given JMS 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
createTemporaryQueuemethod.- Specified by:
createQueuein interfacejavax.jms.QueueSession- Specified by:
createQueuein interfacejavax.jms.Session- Parameters:
queueName- A provider-specific queue name- Returns:
- a Queue object which encapsulates the specified name
- Throws:
javax.jms.JMSException- if a Queue object cannot be created due to some internal error
-
createTopic
Creates aTopicobject 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
Topicobject 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 JMS provider. JMS does not provide a method to create the physical topic, since this would be specific to a given JMS 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
createTemporaryTopicmethod.- Specified by:
createTopicin interfacejavax.jms.Session- Specified by:
createTopicin interfacejavax.jms.TopicSession- Parameters:
topicName- A provider-specific topic name- Returns:
- a Topic object which encapsulates the specified name
- Throws:
javax.jms.JMSException- if a Topic object cannot be created due to some internal error
-
createDurableSubscriber
public javax.jms.TopicSubscriber createDurableSubscriber(javax.jms.Topic topic, String name) throws javax.jms.JMSException 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 anoLocalvalue offalse.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 JMS 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
unsubscribemethod.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,MessageConsumerorJMSConsumerobject 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
noLocalvalue has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this method creates aTopicSubscriberon 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
JMSExceptionwill be thrown.If an unshared durable subscription already exists with the same name and client identifier but a different topic, message selector or
noLocalvalue 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
JMSExceptionis 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
createDurableConsumermethod except that it returns aTopicSubscriberrather than aMessageConsumerto represent the consumer.- Specified by:
createDurableSubscriberin interfacejavax.jms.Session- Specified by:
createDurableSubscriberin interfacejavax.jms.TopicSession- Parameters:
topic- the non-temporaryTopicto subscribe toname- the name used to identify this subscription- Returns:
- An unshared durable subscription on the specified topic.
- Throws:
javax.jms.InvalidDestinationException- if an invalid topic is specified.javax.jms.IllegalStateException- if the client identifier is unsetjavax.jms.JMSException-- if the session fails to create the unshared durable subscription and
TopicSubscriberdue 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
- if the session fails to create the unshared durable subscription and
- Since:
- JMS 1.1
-
createDurableSubscriber
public javax.jms.TopicSubscriber createDurableSubscriber(javax.jms.Topic topic, String name, String messageSelector, boolean noLocal) throws javax.jms.JMSException Creates an unshared durable subscription on the specified topic (if one does not already exist), specifying a message selector and thenoLocalparameter, 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 JMS 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
unsubscribemethod.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,MessageConsumerorJMSConsumerobject 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
noLocalvalue has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this method creates aTopicSubscriberon 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
JMSExceptionwill be thrown.If an unshared durable subscription already exists with the same name and client identifier but a different topic, message selector or
noLocalvalue 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
noLocalis 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
JMSExceptionis 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
createDurableConsumermethod except that it returns aTopicSubscriberrather than aMessageConsumerto represent the consumer.- Specified by:
createDurableSubscriberin interfacejavax.jms.Session- Specified by:
createDurableSubscriberin interfacejavax.jms.TopicSession- Parameters:
topic- the non-temporaryTopicto subscribe toname- the name used to identify this subscriptionmessageSelector- 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:
javax.jms.InvalidDestinationException- if an invalid topic is specified.javax.jms.InvalidSelectorException- if the message selector is invalid.javax.jms.IllegalStateException- if the client identifier is unsetjavax.jms.JMSException-- if the session fails to create the unshared durable subscription and
TopicSubscriberdue 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
- if the session fails to create the unshared durable subscription and
- Since:
- JMS 1.1
-
createDurableConsumer
public javax.jms.MessageConsumer createDurableConsumer(javax.jms.Topic topic, String name) throws javax.jms.JMSException 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 anoLocalvalue offalse.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 JMS 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
unsubscribemethod.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,MessageConsumerorJMSConsumerobject 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
noLocalvalue has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this method creates aMessageConsumeron 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
JMSExceptionwill be thrown.If an unshared durable subscription already exists with the same name and client identifier but a different topic, message selector or
noLocalvalue 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
JMSExceptionis 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
createDurableSubscribermethod except that it returns aMessageConsumerrather than aTopicSubscriberto represent the consumer.- Specified by:
createDurableConsumerin interfacejavax.jms.Session- Parameters:
topic- the non-temporaryTopicto subscribe toname- the name used to identify this subscription- Returns:
- An unshared durable subscription on the specified topic.
- Throws:
javax.jms.InvalidDestinationException- if an invalid topic is specified.javax.jms.IllegalStateException- if the client identifier is unsetjavax.jms.JMSException-- if the session fails to create the unshared durable subscription and
MessageConsumerdue 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
- if the session fails to create the unshared durable subscription and
- Since:
- JMS 2.0
-
createDurableConsumer
public PulsarMessageConsumer createDurableConsumer(javax.jms.Topic topic, String name, String messageSelector, boolean noLocal) throws javax.jms.JMSException Creates an unshared durable subscription on the specified topic (if one does not already exist), specifying a message selector and thenoLocalparameter, 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 JMS 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
unsubscribemethod.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,MessageConsumerorJMSConsumerobject 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
noLocalvalue has been specified, and there is no consumer already active (i.e. not closed) on the durable subscription then this method creates aMessageConsumeron 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
JMSExceptionwill be thrown.If an unshared durable subscription already exists with the same name and client identifier but a different topic, message selector or
noLocalvalue 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
noLocalis 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
JMSExceptionis 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
createDurableSubscribermethod except that it returns aMessageConsumerrather than aTopicSubscriberto represent the consumer.- Specified by:
createDurableConsumerin interfacejavax.jms.Session- Parameters:
topic- the non-temporaryTopicto subscribe toname- the name used to identify this subscriptionmessageSelector- 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:
javax.jms.InvalidDestinationException- if an invalid topic is specified.javax.jms.InvalidSelectorException- if the message selector is invalid.javax.jms.IllegalStateException- if the client identifier is unsetjavax.jms.JMSException-- if the session fails to create the unshared durable subscription and
MessageConsumerdue 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
- if the session fails to create the unshared durable subscription and
- Since:
- JMS 2.0
-
createBrowser
public javax.jms.QueueBrowser createBrowser(javax.jms.Queue queue) throws javax.jms.JMSException Creates aQueueBrowserobject to peek at the messages on the specified queue.- Specified by:
createBrowserin interfacejavax.jms.QueueSession- Specified by:
createBrowserin interfacejavax.jms.Session- Parameters:
queue- thequeueto access- Returns:
- A
QueueBrowserobject to peek at the messages on the specified queue. - Throws:
javax.jms.JMSException- if the session fails to create a browser due to some internal error.javax.jms.InvalidDestinationException- if an invalid destination is specified- Since:
- JMS 1.1
-
createBrowser
public javax.jms.QueueBrowser createBrowser(javax.jms.Queue queue, String messageSelector) throws javax.jms.JMSException Creates aQueueBrowserobject to peek at the messages on the specified queue using a message selector.- Specified by:
createBrowserin interfacejavax.jms.QueueSession- Specified by:
createBrowserin interfacejavax.jms.Session- Parameters:
queue- thequeueto accessmessageSelector- 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
QueueBrowserobject to peek at the messages on the specified queue. - Throws:
javax.jms.JMSException- if the session fails to create a browser due to some internal error.javax.jms.InvalidDestinationException- if an invalid destination is specifiedjavax.jms.InvalidSelectorException- if the message selector is invalid.- Since:
- JMS 1.1
-
createTemporaryQueue
public javax.jms.TemporaryQueue createTemporaryQueue() throws javax.jms.JMSExceptionCreates aTemporaryQueueobject. Its lifetime will be that of theConnectionunless it is deleted earlier.- Specified by:
createTemporaryQueuein interfacejavax.jms.QueueSession- Specified by:
createTemporaryQueuein interfacejavax.jms.Session- Returns:
- a temporary queue identity
- Throws:
javax.jms.JMSException- if the session fails to create a temporary queue due to some internal error.- Since:
- JMS 1.1
-
createTemporaryTopic
public javax.jms.TemporaryTopic createTemporaryTopic() throws javax.jms.JMSExceptionCreates aTemporaryTopicobject. Its lifetime will be that of theConnectionunless it is deleted earlier.- Specified by:
createTemporaryTopicin interfacejavax.jms.Session- Specified by:
createTemporaryTopicin interfacejavax.jms.TopicSession- Returns:
- a temporary topic identity
- Throws:
javax.jms.JMSException- if the session fails to create a temporary topic due to some internal error.- Since:
- JMS 1.1
-
unsubscribe
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:
unsubscribein interfacejavax.jms.Session- Specified by:
unsubscribein interfacejavax.jms.TopicSession- Parameters:
name- the name used to identify this subscription- Throws:
javax.jms.JMSException- if the session fails to unsubscribe to the durable subscription due to some internal error.javax.jms.InvalidDestinationException- if an invalid subscription name is specified.- Since:
- JMS 1.1
-
onError
-
registerConsumer
-
isJms20
public boolean isJms20() -
setJms20
public void setJms20(boolean jms20) -
getConnection
-
isTransactionStarted
public boolean isTransactionStarted() -
createReceiver
public javax.jms.QueueReceiver createReceiver(javax.jms.Queue queue) throws javax.jms.JMSException - Specified by:
createReceiverin interfacejavax.jms.QueueSession- Throws:
javax.jms.JMSException
-
createReceiver
public javax.jms.QueueReceiver createReceiver(javax.jms.Queue queue, String s) throws javax.jms.JMSException - Specified by:
createReceiverin interfacejavax.jms.QueueSession- Throws:
javax.jms.JMSException
-
createSender
public javax.jms.QueueSender createSender(javax.jms.Queue queue) throws javax.jms.JMSException - Specified by:
createSenderin interfacejavax.jms.QueueSession- Throws:
javax.jms.JMSException
-
createSubscriber
public javax.jms.TopicSubscriber createSubscriber(javax.jms.Topic topic) throws javax.jms.JMSException - Specified by:
createSubscriberin interfacejavax.jms.TopicSession- Throws:
javax.jms.JMSException
-
createSubscriber
public javax.jms.TopicSubscriber createSubscriber(javax.jms.Topic topic, String s, boolean b) throws javax.jms.JMSException - Specified by:
createSubscriberin interfacejavax.jms.TopicSession- Throws:
javax.jms.JMSException
-
createPublisher
public javax.jms.TopicPublisher createPublisher(javax.jms.Topic topic) throws javax.jms.JMSException - Specified by:
createPublisherin interfacejavax.jms.TopicSession- Throws:
javax.jms.JMSException
-
checkNotClosed
public void checkNotClosed() throws javax.jms.JMSException- Throws:
javax.jms.JMSException
-
isClosed
public boolean isClosed()
-