Package com.tibco.tibems.ufo

Class TibjmsUFOTopicConnection

java.lang.Object

com.tibco.tibems.ufo.TibjmsUFOConnection

com.tibco.tibems.ufo.TibjmsUFOTopicConnection

All Implemented Interfaces:

com.tibco.tibems.ufo.TibjmsUFOxConst, java.lang.AutoCloseable, Connection, TopicConnection

public class TibjmsUFOTopicConnection
extends TibjmsUFOConnection
implements TopicConnection

UFO Implementation of javax.jms.TopicConnection.

Field Summary

Fields inherited from interface com.tibco.tibems.ufo.TibjmsUFOxConst

_CONN_URL_PREFIX, _CONN_URL_SUFFIX, _DEFAULT_BROKER, _GENERIC_, _PRIORITY_DEFAULT, _QUEUE_, _RECONNECTION_DELAY, _TEMP_DEST_PREFIX, _TOPIC_, _URL_SEPARATOR_

Method Summary

Modifier and Type	Method	Description
ConnectionConsumer	createConnectionConsumer(Topic topic, java.lang.String messageSelector, ServerSessionPool sessionPool, int maxMessages)	Not supported by UFO Implementation.
ConnectionConsumer	createDurableConnectionConsumer(Topic topic, java.lang.String subscriptionName, java.lang.String messageSelector, ServerSessionPool sessionPool, int maxMessages)	Not supported by UFO Implementation.
TopicSession	createTopicSession(boolean transacted, int acknowledgeMode)	Creates a TopicSession object, specifying transacted and acknowledgeMode.

Methods inherited from class com.tibco.tibems.ufo.TibjmsUFOConnection

close, createConnectionConsumer, createSession, createSession, createSession, createSharedConnectionConsumer, createSharedDurableConnectionConsumer, getClientID, getExceptionListener, getMetaData, recoverConnection, setClientID, setExceptionListener, start, stop, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.jms.Connection

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

Method Detail

createTopicSession

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

Description copied from interface: TopicConnection

Creates a TopicSession object, specifying transacted and acknowledgeMode.

The effect of setting the transacted and acknowledgeMode arguments depends on whether this method is called in a Java SE environment, in the Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is called in the Jakarta EE web or EJB container then the effect of setting the transacted} and acknowledgeMode arguments also depends on whether or not there is an active JTA transaction in progress.

In a Java SE environment or in the Jakarta EE application client container:

• If transacted is set to true then the session will use a local transaction which may subsequently be committed or rolled back by calling the session's commit or rollback methods. The argument acknowledgeMode is ignored.
• If transacted is set to false then the session will be non-transacted. In this case the argument acknowledgeMode is used to specify how messages received by this session will be acknowledged. The permitted values are Session.CLIENT_ACKNOWLEDGE, Session.AUTO_ACKNOWLEDGE and Session.DUPS_OK_ACKNOWLEDGE. For a definition of the meaning of these acknowledgement modes see the links below.

In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:

• Both arguments transacted and acknowledgeMode are ignored. The session will participate in the JTA transaction and will be committed or rolled back when that transaction is committed or rolled back, not by calling the session's commit or rollback methods. Since both arguments are ignored, developers are recommended to use createSession(), which has no arguments, instead of this method.

In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:

• If transacted is set to false and acknowledgeMode is set to JMSContext.AUTO_ACKNOWLEDGE or Session.DUPS_OK_ACKNOWLEDGE then the session will be non-transacted and messages will be acknowledged according to the value of acknowledgeMode.
• If transacted is set to false and acknowledgeMode is set to JMSContext.CLIENT_ACKNOWLEDGE then the Jakarta Messaging provider is recommended to ignore the specified parameters and instead provide a non-transacted, auto-acknowledged session. However the Jakarta Messaging provider may alternatively provide a non-transacted session with client acknowledgement.
• If transacted is set to true, then the Jakarta Messaging provider is recommended to ignore the specified parameters and instead provide a non-transacted, auto-acknowledged session. However the Jakarta Messaging provider may alternatively provide a local transacted session.
• Applications are recommended to set transacted to false and acknowledgeMode to JMSContext.AUTO_ACKNOWLEDGE or Session.DUPS_OK_ACKNOWLEDGE since since applications which set transacted to false and set acknowledgeMode to JMSContext.CLIENT_ACKNOWLEDGE, or which set transacted to true, may not be portable.

Applications running in the Jakarta EE web and EJB containers must not attempt to create more than one active (not closed) Session object per connection. If this method is called in a Jakarta EE web or EJB container when an active Session object already exists for this connection then a JMSException may be thrown.

Specified by:

createTopicSession in interface TopicConnection

Parameters:

transacted - indicates whether the session will use a local transaction, except in the cases described above when this value is ignored.

acknowledgeMode - when transacted is false, indicates how messages received by the session will be acknowledged, except in the cases described above when this value is ignored.

Returns:

a newly created TopicSession

Throws:

JMSException - if the TopicConnection object fails to create a TopicSession due to

• some internal error,
• lack of support for the specific transaction and acknowledgement mode, or
• because this method is being called in a Jakarta EE web or EJB application and an active session already exists for this connection.

See Also:

Session.AUTO_ACKNOWLEDGE, Session.CLIENT_ACKNOWLEDGE, Session.DUPS_OK_ACKNOWLEDGE

createConnectionConsumer

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

Not supported by UFO Implementation.

Specified by:

createConnectionConsumer in interface TopicConnection

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 - if the TopicConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.

InvalidDestinationException - if an invalid topic is specified.

InvalidSelectorException - if the message selector is invalid.

See Also:

ConnectionConsumer

createDurableConnectionConsumer

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

Not supported by UFO Implementation.

Specified by:

createDurableConnectionConsumer in interface Connection

Specified by:

createDurableConnectionConsumer in interface TopicConnection

Overrides:

createDurableConnectionConsumer in class TibjmsUFOConnection

Parameters:

topic - topic to access

subscriptionName - the name used to identify the unshared durable subscription

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:

IllegalStateException - if called on a QueueConnection

InvalidDestinationException - if an invalid destination is specified.

InvalidSelectorException - if the message selector is invalid.

JMSException - if the Connection object fails to create a connection consumer for one of the following reasons:

• an internal error has occurred
• invalid arguments for sessionPool and messageSelector or
• 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:

ConnectionConsumer