JMS API 2.0.1 · javax.jms.TopicSession

Method Summary

Modifier and Type	Method and Description
public TopicSubscriber	createDurableSubscriber(Topic the non-temporary `Topic` to subscribe to topic, String the name used to identify this subscription name) Redeclares javax.jms.Session.createDurableSubscriber. Creates an unshared durable subscription on the specified topic (if one does not already exist) and creates a consumer on that durable subscription.
public TopicSubscriber	createDurableSubscriber(Topic the non-temporary `Topic` to subscribe to topic, String the name used to identify this subscription name, String 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. messageSelector, boolean 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. noLocal) Redeclares javax.jms.Session.createDurableSubscriber. 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.
public TopicPublisher	createPublisher(Topic the `Topic` to publish to, or null if this is an unidentified producer topic) Creates a publisher for the specified topic.
public TopicSubscriber	createSubscriber(Topic the `Topic` to subscribe to topic) Creates a nondurable subscriber to the specified topic.
public TopicSubscriber	createSubscriber(Topic the `Topic` to subscribe to topic, String 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. messageSelector, boolean if set, inhibits the delivery of messages published by its own connection noLocal) 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.
public TemporaryTopic	Returns: a temporary topic identity createTemporaryTopic() Redeclares javax.jms.Session.createTemporaryTopic. Creates a `TemporaryTopic` object.
public Topic	Returns: a `Topic` with the given name createTopic(String the name of this `Topic` topicName) Redeclares javax.jms.Session.createTopic. Creates a topic identity given a `Topic` name.
public void	unsubscribe(String the name used to identify this subscription name) Redeclares javax.jms.Session.unsubscribe. Unsubscribes a durable subscription that has been created by a client.

Method Detail

createDurableSubscriber back to summary

createDurableSubscriber	back to summary
public TopicSubscriber createDurableSubscriber(Topic topic, String name) throws JMSException Redeclares javax.jms.Session.createDurableSubscriber. 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 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 `unsubscribe` method. This method may only be used with non-shared durable subscriptions. Any durable subscription created using this method will be non-shared. 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 non-shared 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 and message selector, and there is no consumer already active (i.e. not closed) on the durable subscription, and no consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, 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, or consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, 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, and no consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, then the durable subscription will be deleted and a new one created. 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. Parameters topic:Topic the non-temporary `Topic` to subscribe to name:String the name used to identify this subscription Exceptions JMSException: if the session fails to create the non-shared durable subscription and `TopicSubscriber` due to some internal error if the client identifier is unset 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 InvalidDestinationException: if an invalid topic is specified.

public TopicSubscriber createDurableSubscriber(Topic topic, String name) throws JMSException

Redeclares javax.jms.Session.createDurableSubscriber.

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 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 unsubscribe method.

This method may only be used with non-shared durable subscriptions. Any durable subscription created using this method will be non-shared. 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 non-shared 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 and message selector, and there is no consumer already active (i.e. not closed) on the durable subscription, and no consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, 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, or consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, 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, and no consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, then the durable subscription will be deleted and a new one created.

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.

Parameters

topic:Topic: the non-temporary Topic to subscribe to
name:String: the name used to identify this subscription

Exceptions

JMSException:

if the session fails to create the non-shared durable subscription and TopicSubscriber due to some internal error
if the client identifier is unset
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

InvalidDestinationException:

if an invalid topic is specified.

createDurableSubscriber back to summary

createDurableSubscriber	back to summary
public TopicSubscriber createDurableSubscriber(Topic topic, String name, String messageSelector, boolean noLocal) throws JMSException Redeclares javax.jms.Session.createDurableSubscriber. 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 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 `unsubscribe` method. This method may only be used with non-shared durable subscriptions. Any durable subscription created using this method will be non-shared. 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 non-shared 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 and message selector, and there is no consumer already active (i.e. not closed) on the durable subscription, and no consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, 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, or consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, 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, and no consumed messages from that subscription are still part of a pending transaction or are not yet acknowledged in the session, then the durable subscription will be deleted and a new one created. 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. 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. 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. Parameters topic:Topic the non-temporary `Topic` to subscribe to name:String the name used to identify this subscription messageSelector:String 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:boolean 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. Exceptions JMSException: if the session fails to create the non-shared durable subscription and `TopicSubscriber` due to some internal error if the client identifier is unset 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 InvalidDestinationException: if an invalid topic is specified. InvalidSelectorException: if the message selector is invalid.

public TopicSubscriber createDurableSubscriber(Topic topic, String name, String messageSelector, boolean noLocal) throws JMSException

Redeclares javax.jms.Session.createDurableSubscriber.

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 will continue to accumulate messages until it is deleted using the unsubscribe method.

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.

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.

Parameters

topic:Topic: the non-temporary Topic to subscribe to
name:String: the name used to identify this subscription
messageSelector:String: 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:boolean: 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.

Exceptions

JMSException:

if the session fails to create the non-shared durable subscription and TopicSubscriber due to some internal error
if the client identifier is unset
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

InvalidDestinationException:

if an invalid topic is specified.

InvalidSelectorException:

if the message selector is invalid.

createPublisher back to summary

createPublisher	back to summary
public TopicPublisher createPublisher(Topic topic) throws JMSException Creates a publisher for the specified topic. A client uses a `TopicPublisher` object to publish messages on a topic. Each time a client creates a `TopicPublisher` on a topic, it defines a new sequence of messages that have no ordering relationship with the messages it has previously sent. Parameters topic:Topic the `Topic` to publish to, or null if this is an unidentified producer Exceptions JMSException: if the session fails to create a publisher due to some internal error. InvalidDestinationException: if an invalid topic is specified.

public TopicPublisher createPublisher(Topic topic) throws JMSException

Creates a publisher for the specified topic.

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

Parameters

topic:Topic: the Topic to publish to, or null if this is an unidentified producer

Exceptions

JMSException:: if the session fails to create a publisher due to some internal error.
InvalidDestinationException:: if an invalid topic is specified.

createSubscriber back to summary

createSubscriber	back to summary
public TopicSubscriber createSubscriber(Topic topic) throws JMSException Creates a nondurable subscriber to the specified topic. A client uses a `TopicSubscriber` object to receive messages that have been published to a topic. Regular `TopicSubscriber` objects are not durable. They receive only messages that are published while they are active. In some cases, a connection may both publish and subscribe to a topic. The subscriber `NoLocal` attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false. Parameters topic:Topic the `Topic` to subscribe to Exceptions JMSException: if the session fails to create a subscriber due to some internal error. InvalidDestinationException: if an invalid topic is specified.

public TopicSubscriber createSubscriber(Topic topic) throws JMSException

Creates a nondurable subscriber to the specified topic.

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

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

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

Parameters

topic:Topic: the Topic to subscribe to

Exceptions

JMSException:: if the session fails to create a subscriber due to some internal error.
InvalidDestinationException:: if an invalid topic is specified.

createSubscriber back to summary

createSubscriber	back to summary
public TopicSubscriber createSubscriber(Topic topic, String messageSelector, boolean noLocal) throws JMSException Creates a nondurable subscriber to the specified topic, using a message selector or specifying whether messages published by its own connection should be delivered to it. A client uses a `TopicSubscriber` object to receive messages that have been published to a topic. Regular `TopicSubscriber` objects are not durable. They receive only messages that are published while they are active. Messages filtered out by a subscriber's message selector will never be delivered to the subscriber. From the subscriber's perspective, they do not exist. In some cases, a connection may both publish and subscribe to a topic. The subscriber `NoLocal` attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false. Parameters topic:Topic the `Topic` to subscribe to messageSelector:String 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:boolean if set, inhibits the delivery of messages published by its own connection Exceptions 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.

public TopicSubscriber createSubscriber(Topic topic, String messageSelector, boolean noLocal) throws JMSException

Creates a nondurable subscriber to the specified topic, using a message selector or specifying whether messages published by its own connection should be delivered to it.

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

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

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

Parameters

topic:Topic: the Topic to subscribe to
messageSelector:String: 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:boolean: if set, inhibits the delivery of messages published by its own connection

Exceptions

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.

createTemporaryTopic back to summary

createTemporaryTopic	back to summary
public TemporaryTopic createTemporaryTopic() throws JMSException Redeclares javax.jms.Session.createTemporaryTopic. Creates a `TemporaryTopic` object. Its lifetime will be that of the `TopicConnection` unless it is deleted earlier. Returns:TemporaryTopic a temporary topic identity Exceptions JMSException: if the session fails to create a temporary topic due to some internal error.

public TemporaryTopic createTemporaryTopic() throws JMSException

Redeclares javax.jms.Session.createTemporaryTopic.

Creates a TemporaryTopic object. Its lifetime will be that of the TopicConnection unless it is deleted earlier.

Returns:TemporaryTopic

a temporary topic identity

Exceptions

JMSException:: if the session fails to create a temporary topic due to some internal error.

createTopic back to summary

createTopic	back to summary
public Topic createTopic(String topicName) throws JMSException Redeclares javax.jms.Session.createTopic. Creates a topic identity given a `Topic` name. This facility is provided for the rare cases where clients need to dynamically manipulate topic identity. This allows the creation of a topic identity with a provider-specific name. Clients that depend on this ability are not portable. Note that this method is not for creating the physical topic. The physical creation of topics is an administrative task and is not to be initiated by the JMS API. The one exception is the creation of temporary topics, which is accomplished with the `createTemporaryTopic` method. Parameters topicName:String the name of this `Topic` Returns:Topic a `Topic` with the given name Exceptions JMSException: if the session fails to create a topic due to some internal error.

public Topic createTopic(String topicName) throws JMSException

Redeclares javax.jms.Session.createTopic.

Creates a topic identity given a Topic name.

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

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

Parameters

topicName:String: the name of this Topic

Returns:Topic

a Topic with the given name

Exceptions

JMSException:: if the session fails to create a topic due to some internal error.

unsubscribe back to summary

unsubscribe	back to summary
public void unsubscribe(String name) throws JMSException Redeclares javax.jms.Session.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. It is erroneous for a client to delete a durable subscription while there is an active `TopicSubscriber` for the subscription, or while a consumed message is part of a pending transaction or has not been acknowledged in the session. Parameters name:String the name used to identify this subscription Exceptions JMSException: if the session fails to unsubscribe to the durable subscription due to some internal error. InvalidDestinationException: if an invalid subscription name is specified.

public void unsubscribe(String name) throws JMSException

Redeclares javax.jms.Session.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.

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

Parameters

name:String: the name used to identify this subscription

Exceptions

JMSException:: if the session fails to unsubscribe to the durable subscription due to some internal error.
InvalidDestinationException:: if an invalid subscription name is specified.

public Interface TopicSession

Field Summary

Method Summary

Method Detail