Class QueueManagerConnections

java.lang.Object
com.ibm.mq.explorer.ui.extensions.QueueManagerConnections

public class QueueManagerConnections extends Object
Class to provide an external API for adding connections to remote queue managers.
  • Field Details

    • SCCSID

      public static final String SCCSID
      CMVC descriptors - expanded during extraction
      See Also:
    • OPTIONS_REFRESH_INTERVAL

      public static final String OPTIONS_REFRESH_INTERVAL
      Key for options Hashtable to specify the refresh interval, the value should be an Integer. If this key is missing from the options Hashtable, then the current preference for the refresh interval for remote queue managers will be used.
      See Also:
    • OPTIONS_AUTORECONNECT

      public static final String OPTIONS_AUTORECONNECT
      Key for options Hashtable to specify whether to auto-reconnect this queue manager, the value should be a Boolean. If this key is missing from the options Hashtable then auto-reconnect will be defaulted to off.
      See Also:
    • OPTIONS_SHOW_DIALOGS_ON_ERROR

      public static final String OPTIONS_SHOW_DIALOGS_ON_ERROR
      Key for options Hashtable to specify whether dialogs should be shown to the user if the connection cannot be made, the value should be a Boolean. If missing from the Hashtable then dialogs are not shown to the user, and the call just returned to the caller.
      See Also:
    • CONN_OPTIONS_SECURITY_EXIT

      public static final String CONN_OPTIONS_SECURITY_EXIT
      Key for connOptions Hashtable to specify the security exit name to use, value should be a String
      See Also:
    • CONN_OPTIONS_SECURITY_EXIT_USER_DATA

      public static final String CONN_OPTIONS_SECURITY_EXIT_USER_DATA
      Key for connOptions Hashtable to specify the security exit user data to use, value should be a String
      See Also:
    • CONN_OPTIONS_EXIT_CLASSPATH

      public static final String CONN_OPTIONS_EXIT_CLASSPATH
      Key for connOptions Hashtable to specify the security exit classpath to use, value should be a String
      See Also:
    • CONN_OPTIONS_USER_ID

      public static final String CONN_OPTIONS_USER_ID
      Key for connOptions Hashtable to specify the user id to use, value should be a String
      See Also:
    • CONN_OPTIONS_PASSWORD

      public static final String CONN_OPTIONS_PASSWORD
      Key for connOptions Hashtable to specify the user password to use, value should be a String
      See Also:
    • CONN_OPTIONS_SSL_CIPHER_SUITE

      public static final String CONN_OPTIONS_SSL_CIPHER_SUITE
      Key for connOptions Hashtable to specify the SSL cipher suite to use, value should be a String
      See Also:
    • CONN_OPTIONS_SSL_PEER_NAME

      public static final String CONN_OPTIONS_SSL_PEER_NAME
      Key for connOptions Hashtable to specify the SSL peer name to use, value should be a String
      See Also:
    • CONN_OPTIONS_SSL_RESET_COUNT

      public static final String CONN_OPTIONS_SSL_RESET_COUNT
      Key for connOptions Hashtable to specify the SSL reset count to use, value should be an Integer
      See Also:
    • CONN_OPTIONS_SSL_TRUSTED_STORE

      public static final String CONN_OPTIONS_SSL_TRUSTED_STORE
      Key for connOptions Hashtable to specify the SSL trusted store name to use, value should be a String
      See Also:
    • CONN_OPTIONS_SSL_TRUSTED_STORE_PW

      public static final String CONN_OPTIONS_SSL_TRUSTED_STORE_PW
      Key for connOptions Hashtable to specify the SSL trusted store password to use, value should be a String. Optional.
      See Also:
    • CONN_OPTIONS_SSL_PERSONAL_STORE

      public static final String CONN_OPTIONS_SSL_PERSONAL_STORE
      Key for connOptions Hashtable to specify the SSL personal store name to use, value should be a String. Optional.
      See Also:
    • CONN_OPTIONS_SSL_PERSONAL_STORE_PW

      public static final String CONN_OPTIONS_SSL_PERSONAL_STORE_PW
      Key for connOptions Hashtable to specify the SSL personal store password to use, value should be a String. Required if CONN_OPTIONS_SSL_PERSONAL_STORE is defined.
      See Also:
  • Constructor Details

    • QueueManagerConnections

      public QueueManagerConnections(String qmName, URL chanDefTable, Hashtable<String,?> connOptions, Hashtable<String,?> options)
      Constructor to add a queue manager to MQ Explorer, using a channel definition table
      Parameters:
      qmName - is the name of the queue manager
      chanDefTable - is the channel definition table
      options - is the list of options to use
      connOptions - is a list of connection related options
    • QueueManagerConnections

      public QueueManagerConnections(String qmName, String connName, String chlName, Hashtable<String,?> connOptions, Hashtable<String,?> options)
      Constructor to add a queue manager to MQ Explorer, using a client connection channel
      Parameters:
      qmName - is the name of the queue manager
      connName - is the connection name (hostname or IP address with port address)
      chlName - is the client connection channel name
      connOptions - is a list of connection related options
      options - is the list of options to use
    • QueueManagerConnections

      public QueueManagerConnections(String qmName, String[] connNames, String chlName, Hashtable<String,?> connOptions, Hashtable<String,?> options)
      Constructor to add a queue manager to MQ Explorer, using a client connection channel
      Parameters:
      qmName - is the name of the queue manager
      connNames - is a list of connection names (hostname or IP address with port address)
      chlName - is the client connection channel name
      connOptions - is a list of connection related options
      options - is the list of options to use
    • QueueManagerConnections

      public QueueManagerConnections(MQQmgrExtObject existingQM, String targetQ, String targetQM, Hashtable<String,?> options)
      Constructor to add a queue manager to MQ Explorer, via an existing queue manager connection
      Parameters:
      existingQM - is an existing queue manager, already added to MQ Explorer
      targetQ - is the target queue name, owned by the target queue manager
      targetQM - is the target queue manager
      options - is the list of options to use
  • Method Details

    • connect

      Make the connection.
      Returns:
      the MQQmgrExtObject for the connected queue manager, or null if failed to connect
      Throws:
      QueueManagerConnectionException
    • isFIPSEnabled

      public static boolean isFIPSEnabled()
      Return whether MQ Explorer will use FIPS when making a connection to a remote queue manager using SSL
      Returns:
      boolean true if FIPS will be used, otherwise false
    • getExistingQueueManagers

      public static MQQmgrExtObject[] getExistingQueueManagers()
      Return an array of existing queue managers known to MQ Explorer (local or remote). If there are no known queue managers, an empty array is returned.
      Returns:
      array of known MQQmgrExtObject objects
    • isQueueManagerVisible

      public static boolean isQueueManagerVisible(MQQmgrExtObject mqQmgrExtObject)
      Return whether the specified queue manager is currently visible (not hidden)
      Parameters:
      mqQmgrExtObject - the queue manager to test
      Returns:
      true if the queue manager is visible, false otherwise
    • isQueueManagerConnected

      public static boolean isQueueManagerConnected(MQQmgrExtObject mqQmgrExtObject)
      Return whether the specified queue manager is currently connected
      Parameters:
      mqQmgrExtObject - the queue manager to test
      Returns:
      true if the queue manager is connected, false otherwise
    • isQueueManagerLocal

      public static boolean isQueueManagerLocal(MQQmgrExtObject mqQmgrExtObject)
      Return whether the specified queue manager is local
      Parameters:
      mqQmgrExtObject - the queue manager to test
      Returns:
      true if the queue manager is local, false otherwise
    • removeRemoteQueueManager

      public static boolean removeRemoteQueueManager(MQQmgrExtObject mqQmgrExtObject) throws QueueManagerConnectionException
      Remove a remote queue manager from MQ Explorer
      Parameters:
      mqQmgrExtObject - the remote queue manager to remove
      Returns:
      true if the queue manager is removed, false otherwise
      Throws:
      QueueManagerConnectionException