| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Connection object is a client's active connection to its JMS provider.
A connection serves several purposes:
ConnectionMetaData object.
ExceptionListener object.
Because the creation of a connection involves setting up authentication and communication, a connection is a relatively heavyweight object. Most clients will do all their messaging with a single connection. Other more advanced applications may use several connections. The JMS API does not architect a reason for using multiple connections; however, there may be operational reasons for doing so.
A JMS client typically creates a connection, one or more sessions, and a number of message producers and consumers. When a connection is created, it is in stopped mode. That means that no messages are being delivered.
It is typical to leave the connection in stopped mode until setup
is complete (that is, until all message consumers have been
created). At that point, the client calls
the connection's start method, and messages begin arriving at
the connection's consumers. This setup
convention minimizes any client confusion that may result from
asynchronous message delivery while the client is still in the process
of setting itself up.
A connection can be started immediately, and the setup can be done afterwards. Clients that do this must be prepared to handle asynchronous message delivery while they are still in the process of setting up.
A message producer can send messages while a connection is stopped.
| Constructor Summary | |
Connection()
Use JmsConnectionFactory.createConnection()
|
|
| Method Summary | |
VoidFuture
|
close(callback)
Closes the connection. |
Session
|
createSession(transacted, acknowledgeMode)
Creates a Session object.
|
String
|
getClientID()
Gets the client identifier for this connection. |
ExceptionListener
|
getExceptionListener()
Gets the ExceptionListener object for this connection.
|
ConnectionMetaData
|
getMetaData()
Fetches the metadata associated with the connection. |
void
|
setClientID()
Sets the client identifier for this connection. |
void
|
setExceptionListener(listener)
Sets an exception listener for this connection. |
VoidFuture
|
start(callback)
Starts (or restarts) a connection's delivery of incoming messages. |
VoidFuture
|
stop(callback)
Temporarily stops a connection's delivery of incoming messages. |
| Constructor Detail |
Connection()
JmsConnectionFactory.createConnection()
| Method Detail |
VoidFuture close(callback)
Since a provider typically allocates significant resources outside the JVM on behalf of a connection, clients should close these resources when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.
There is no need to close the sessions, producers, and consumers of a closed connection.
Closing a connection causes all temporary destinations to be deleted.
When this method is invoked, it should not return until message
processing has been shut down in an orderly fashion. This means that all
message
listeners that may have been running have returned, and that all pending
receives have returned. A close terminates all pending message receives
on the connection's sessions' consumers. The receives may return with a
message or with null, depending on whether there was a message available
at the time of the close. If one or more of the connection's sessions'
message listeners is processing a message at the time when connection
close is invoked, all the facilities of the connection and
its sessions must remain available to those listeners until they return
control to the JMS provider.
Closing a connection causes any of its sessions' transactions
in progress to be rolled back. In the case where a session's
work is coordinated by an external transaction manager, a session's
commit and rollback methods are
not used and the result of a closed session's work is determined
later by the transaction manager.
Closing a connection does NOT force an
acknowledgment of client-acknowledged sessions.
Invoking the acknowledge method of a received message
from a closed connection's session must throw an
IllegalStateException. Closing a closed connection must
NOT throw an exception.
callback - called when the operation has completed or thrown an exception
VoidFuture
JMSException if the JMS provider fails to close the
connection due to some internal error. For
example, a failure to release resources
or to close a socket connection can cause
this exception to be thrown.
Session createSession(transacted, acknowledgeMode)
Session object.
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.
Session a newly created session
JMSException if the Connection object fails
to create a session due to some internal error or
lack of support for the specific transaction
and acknowledgement mode.
String getClientID()
This value is specific to the JMS provider. It is either preconfigured
by an administrator in a ConnectionFactory object
or assigned dynamically by the application by calling the
setClientID method.
String the unique client identifier
ExceptionListener getExceptionListener()
ExceptionListener object for this connection.
Not every Connection has an ExceptionListener
associated with it.
ExceptionListener
ConnectionMetaData getMetaData()
ConnectionMetaData
void setClientID()
void
void setExceptionListener(listener)
If a JMS provider detects a serious problem with a connection, it
informs the connection's ExceptionListener, if one has been
registered. It does this by invoking the listener function passing it a
JMSException
object describing the problem.
A function can be passed as the listener function, or an object with a
function defined on the onException property.
An exception listener allows a client to be notified of a problem asynchronously. Some connections only consume messages, so they would have no other way to learn their connection has failed.
A connection serializes execution of its
ExceptionListener.
A JMS provider should attempt to resolve connection problems itself before it notifies the client of them.
Function, ExceptionListener listener - the exception listener
void
VoidFuture start(callback)
start on a connection that has already been
started is ignored.
callback - called when the operation has completed or thrown an exception
VoidFuture
VoidFuture stop(callback)
start
method. When the connection is stopped,
delivery to all the connection's message consumers is inhibited:
synchronous receives block, and messages are not delivered to message
listeners.
This call blocks until receives and/or message listeners in progress have completed.
Stopping a connection has no effect on its ability to send messages.
A call to stop on a connection that has already been
stopped is ignored.
A call to stop must not return until delivery of messages
has paused. This means that a client can rely on the fact that none of
its message listeners will be called and that all threads of control
waiting for receive calls to return will not return with a
message until the
connection is restarted. The receive timers for a stopped connection
continue to advance, so receives may time out while the connection is
stopped.
If message listeners are running when stop is invoked,
the stop call must
wait until all of them have returned before it may return. While these
message listeners are completing, they must have the full services of the
connection available to them.
callback - called when the operation has completed or thrown an exception
VoidFuture