File Doc Category Size Date Package
TopicConnection.java API Doc Glassfish v2 API 7232 Fri May 04 22:36:16 BST 2007 javax.jms

TopicConnection

public interface TopicConnection implements Connection

A TopicConnection object is an active connection to a publish/subscribe JMS provider. A client uses a TopicConnection object to create one or more TopicSession objects for producing and consuming messages.

A TopicConnection can be used to create a TopicSession, from which specialized topic-related objects can be created. A more general, and recommended approach is to use the Connection object.

The TopicConnection object should be used to support existing code.

version: 1.1 - February 2, 2002
author: Mark Hapner
author: Rich Burridge
author: Kate Stout
see: javax.jms.Connection
see: javax.jms.ConnectionFactory
see: javax.jms.TopicConnectionFactory

Fields Summary
Constructors Summary
Methods Summary
public ConnectionConsumer createConnectionConsumer(Topic topic, java.lang.String messageSelector, ServerSessionPool sessionPool, int maxMessages)
Creates a connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.
param
topic the topic to access
param
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.
param
sessionPool the server session pool to associate with this connection consumer
param
maxMessages the maximum number of messages that can be assigned to a server session at one time
return
the connection consumer
exception
JMSException if the TopicConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.
exception
InvalidDestinationException if an invalid topic is specified.
exception
InvalidSelectorException if the message selector is invalid.
see
javax.jms.ConnectionConsumer
public ConnectionConsumer createDurableConnectionConsumer(Topic topic, java.lang.String subscriptionName, java.lang.String messageSelector, ServerSessionPool sessionPool, int maxMessages)
Create a durable connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.
param
topic the topic to access
param
subscriptionName durable subscription name
param
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.
param
sessionPool the server session pool to associate with this durable connection consumer
param
maxMessages the maximum number of messages that can be assigned to a server session at one time
return
the durable connection consumer
exception
JMSException if the TopicConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.
exception
InvalidDestinationException if an invalid topic is specified.
exception
InvalidSelectorException if the message selector is invalid.
see
javax.jms.ConnectionConsumer
public TopicSession createTopicSession(boolean transacted, int acknowledgeMode)
Creates a TopicSession object.
param
transacted indicates whether the session is transacted
param
acknowledgeMode indicates whether the consumer or the client will acknowledge any messages it receives; ignored if the session is transacted. Legal values are Session.AUTO_ACKNOWLEDGE, Session.CLIENT_ACKNOWLEDGE, and Session.DUPS_OK_ACKNOWLEDGE.
return
a newly created topic session
exception
JMSException if the TopicConnection object fails to create a session due to some internal error or lack of support for the specific transaction and acknowledgement mode.
see
Session#AUTO_ACKNOWLEDGE
see
Session#CLIENT_ACKNOWLEDGE
see
Session#DUPS_OK_ACKNOWLEDGE