TopicConnection

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.jms
Interface TopicConnection

All Superinterfaces:: Connection (src)

All Known Subinterfaces:: JmsSessionFactory (src) , XATopicConnection (src)

All Known Implementing Classes:: JBossConnection (src) , JmsSessionFactoryImpl (src) , SpyConnection (src) , SpyXAConnection (src)

public interface TopicConnection
extends Connection (src)

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.

See Also:: Connection (src) , ConnectionFactory (src) , TopicConnectionFactory (src)

Method Summary
`ConnectionConsumer (src)`	`createConnectionConsumer(Topic (src) topic, java.lang.String messageSelector, ServerSessionPool (src) sessionPool, int maxMessages)` Creates a connection consumer for this connection (optional operation).
`ConnectionConsumer (src)`	`createDurableConnectionConsumer(Topic (src) topic, java.lang.String subscriptionName, java.lang.String messageSelector, ServerSessionPool (src) sessionPool, int maxMessages)` Create a durable connection consumer for this connection (optional operation).
`TopicSession (src)`	`createTopicSession(boolean transacted, int acknowledgeMode)` Creates a `TopicSession` object.

Methods inherited from interface javax.jms.Connection (src)

close, createConnectionConsumer, createSession, getClientID, getExceptionListener, getMetaData, setClientID, setExceptionListener, start, stop

Method Detail

createTopicSession

public TopicSession (src)  createTopicSession(boolean transacted,
                                       int acknowledgeMode)
                                throws JMSException (src)

Creates a TopicSession object.

Parameters:: transacted - indicates whether the session is transacted; 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.
Returns:: a newly created topic session
Throws:: JMSException (src) - 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 Also:: Session.AUTO_ACKNOWLEDGE, Session.CLIENT_ACKNOWLEDGE, Session.DUPS_OK_ACKNOWLEDGE

createConnectionConsumer

public ConnectionConsumer (src)  createConnectionConsumer(Topic (src)  topic,
                                                   java.lang.String messageSelector,
                                                   ServerSessionPool (src)  sessionPool,
                                                   int maxMessages)
                                            throws JMSException (src)

Creates a connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.

Parameters:: topic - the topic 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.; sessionPool - the server session pool to associate with this connection consumer; maxMessages - the maximum number of messages that can be assigned to a server session at one time
Returns:: the connection consumer
Throws:: JMSException (src) - if the TopicConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.; InvalidDestinationException (src) - if an invalid topic is specified.; InvalidSelectorException (src) - if the message selector is invalid.
See Also:: ConnectionConsumer (src)

createDurableConnectionConsumer

public ConnectionConsumer (src)  createDurableConnectionConsumer(Topic (src)  topic,
                                                          java.lang.String subscriptionName,
                                                          java.lang.String messageSelector,
                                                          ServerSessionPool (src)  sessionPool,
                                                          int maxMessages)
                                                   throws JMSException (src)

Create a durable connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.

Specified by:: createDurableConnectionConsumer in interface Connection (src)

Parameters:: topic - the topic to access; subscriptionName - durable subscription name; 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.; sessionPool - the server session pool to associate with this durable connection consumer; maxMessages - the maximum number of messages that can be assigned to a server session at one time
Returns:: the durable connection consumer
Throws:: JMSException (src) - if the TopicConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.; InvalidDestinationException (src) - if an invalid topic is specified.; InvalidSelectorException (src) - if the message selector is invalid.
See Also:: ConnectionConsumer (src)