Connection (Message Queue, 5.1 API Specification)
Date: 2019-01-27

com.sun.messaging.jms

## Interface Connection

- All Superinterfaces:
    java.lang.AutoCloseable, javax.jms.Connection

      public interface Connection
      extends javax.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 and Description
    --- | ---
    `javax.jms.Session` | `createSession(int acknowledgeMode)` Creates a `Session` 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 javax.jms.Connection

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

- - ### Method Detail

    - #### createSession

          javax.jms.Session createSession(int acknowledgeMode)
                                   throws javax.jms.JMSException

      Creates a `Session` object.
      Specified by:
        `createSession` in interface `javax.jms.Connection`
      Parameters:
        `acknowledgeMode` - indicates whether the consumer or the client will acknowledge any messages it receives; Legal values are `Session.AUTO_ACKNOWLEDGE`, `Session.CLIENT_ACKNOWLEDGE`, `Session.DUPS_OK_ACKNOWLEDGE`, and `com.sun.messaging.jms.Session.NO_ACKNOWLEDGE`
      Returns:
        a newly created session
      Throws:
        `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.
        `javax.jms.JMSException`
      See Also:
        `Session.AUTO_ACKNOWLEDGE`, `Session.CLIENT_ACKNOWLEDGE`, `Session.DUPS_OK_ACKNOWLEDGE`, `Session.NO_ACKNOWLEDGE`

    - #### setEventListener

          void setEventListener(EventListener listener)
                         throws javax.jms.JMSException

      Set MQ connection event listener to the current connection.
      Parameters:
        `listener` - EventListener
      Throws:
        `JMSException`
        `javax.jms.JMSException`

    - #### setConsumerEventListener

          void setConsumerEventListener(Destination dest,
                                        EventListener listener)
                                 throws javax.jms.JMSException

      Set consumer event listener on a destination to the current connection.
      Parameters:
        `dest` - the destination on which consumer event is interested
        `listener` - EventListener
      Throws:
        `JMSException`
        `javax.jms.JMSException`
      Since:
        4.5

    - #### removeConsumerEventListener

          void removeConsumerEventListener(Destination dest)
                                    throws javax.jms.JMSException

      Remove a MQ consumer event listener from the current connection.
      Parameters:
        `dest` - the destination on which addConsumerEventListener() was called previously
        `listener` - EventListener
      Throws:
        `JMSException`
        `javax.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.

Copyright (c) 2010, 2017 Oracle and/or its affiliates. All rights reserved.