QueueConnection (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.jms
Interface QueueConnection

All Superinterfaces:: Connection

All Known Subinterfaces:: XAQueueConnection

public interface QueueConnection
extends Connection
extends Connection

A QueueConnection object is an active connection to a point-to-point JMS provider. A client uses a QueueConnection object to create one or more QueueSession objects for producing and consuming messages.

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

The QueueConnection object should be used to support existing code that has already used it.

A QueueConnection cannot be used to create objects specific to the publish/subscribe domain. The createDurableConnectionConsumer method inherits from Connection, but must throw an IllegalStateException if used from QueueConnection.

Version:: 1.1 - April 9, 2002
Author:: Mark Hapner, Rich Burridge, Kate Stout
See Also:: Connection, ConnectionFactory, QueueConnectionFactory

Method Summary

ConnectionConsumer createConnectionConsumer(Queue queue, String messageSelector, ServerSessionPool sessionPool, int maxMessages)
Creates a connection consumer for this connection (optional operation).

QueueSession createQueueSession(boolean transacted, int acknowledgeMode)
Creates a QueueSession object.

Methods inherited from interface javax.jms.Connection

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

Method Summary
`ConnectionConsumer`	`createConnectionConsumer(Queue queue, String messageSelector, ServerSessionPool sessionPool, int maxMessages)` Creates a connection consumer for this connection (optional operation).
`QueueSession`	`createQueueSession(boolean transacted, int acknowledgeMode)` Creates a `QueueSession` object.

Methods inherited from interface javax.jms.Connection
`close, createConnectionConsumer, createDurableConnectionConsumer, createSession, getClientID, getExceptionListener, getMetaData, setClientID, setExceptionListener, start, stop`

Method Detail

createQueueSession

QueueSession createQueueSession(boolean transacted,
                                int acknowledgeMode)
                                throws JMSException

Creates a QueueSession 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 queue session
Throws:: JMSException - if the QueueConnection 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

ConnectionConsumer createConnectionConsumer(Queue queue,
                                            String messageSelector,
                                            ServerSessionPool sessionPool,
                                            int maxMessages)
                                            throws JMSException

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

Parameters:: queue - the queue 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 QueueConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.; InvalidDestinationException - if an invalid queue is specified.; InvalidSelectorException - if the message selector is invalid.
See Also:: ConnectionConsumer