Package com.sun.messaging.jms
Interface Connection
-
- All Superinterfaces:
java.lang.AutoCloseable
,jakarta.jms.Connection
public interface Connection extends jakarta.jms.Connection
This interafce provides the following API for the MQ applications:1. Provide API to create a MQ NO_ACKNOWLEDGE session.
2. Provide API to set the connection event listener.
3. Provide API to query broker adress and HA state.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description jakarta.jms.Session
createSession(int acknowledgeMode)
Creates aSession
object.java.lang.String
getBrokerAddress()
Get the broker's address that the connection is connected (related) to.boolean
isConnectedToHABroker()
Get the current connection state.void
removeConsumerEventListener(Destination dest)
Remove a MQ consumer event listener from the current connection.void
setConsumerEventListener(Destination dest, EventListener listener)
Set consumer event listener on a destination to the current connection.void
setEventListener(EventListener listener)
Set MQ connection event listener to the current connection.-
Methods inherited from interface jakarta.jms.Connection
close, createConnectionConsumer, createDurableConnectionConsumer, createSession, createSession, createSharedConnectionConsumer, createSharedDurableConnectionConsumer, getClientID, getExceptionListener, getMetaData, setClientID, setExceptionListener, start, stop
-
-
-
-
Method Detail
-
createSession
jakarta.jms.Session createSession(int acknowledgeMode) throws jakarta.jms.JMSException
Creates aSession
object.- Specified by:
createSession
in interfacejakarta.jms.Connection
- Parameters:
acknowledgeMode
- indicates whether the consumer or the client will acknowledge any messages it receives; Legal values areSession.AUTO_ACKNOWLEDGE
,Session.CLIENT_ACKNOWLEDGE
,Session.DUPS_OK_ACKNOWLEDGE
, andcom.sun.messaging.jms.Session.NO_ACKNOWLEDGE
- Returns:
- a newly created session
- Throws:
jakarta.jms.JMSException
- if theConnection
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
,Session.NO_ACKNOWLEDGE
-
setEventListener
void setEventListener(EventListener listener) throws jakarta.jms.JMSException
Set MQ connection event listener to the current connection.- Parameters:
listener
- EventListener- Throws:
jakarta.jms.JMSException
-
setConsumerEventListener
void setConsumerEventListener(Destination dest, EventListener listener) throws jakarta.jms.JMSException
Set consumer event listener on a destination to the current connection.- Parameters:
dest
- the destination on which consumer event is interestedlistener
- EventListener- Throws:
jakarta.jms.JMSException
- Since:
- 4.5
-
removeConsumerEventListener
void removeConsumerEventListener(Destination dest) throws jakarta.jms.JMSException
Remove a MQ consumer event listener from the current connection.- Parameters:
dest
- the destination on which addConsumerEventListener() was called previously- Throws:
jakarta.jms.JMSException
- Since:
- 4.5
-
getBrokerAddress
java.lang.String getBrokerAddress()
Get the broker's address that the connection is connected (related) to.- Returns:
- the broker's address that the connection is connected (related) to.
-
isConnectedToHABroker
boolean isConnectedToHABroker()
Get the current connection state.- Returns:
- true if the connection is connected to a HA broker. false if not connected to a HA broker.
-
-