Class QueueManagerConnections
java.lang.Object
com.ibm.mq.explorer.ui.extensions.QueueManagerConnections
Class to provide an external API for adding connections to remote queue managers.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Key for connOptions Hashtable to specify the security exit classpath to use, value should be a Stringstatic final String
Key for connOptions Hashtable to specify the user password to use, value should be a Stringstatic final String
Key for connOptions Hashtable to specify the security exit name to use, value should be a Stringstatic final String
Key for connOptions Hashtable to specify the security exit user data to use, value should be a Stringstatic final String
Key for connOptions Hashtable to specify the SSL cipher suite to use, value should be a Stringstatic final String
Key for connOptions Hashtable to specify the SSL peer name to use, value should be a Stringstatic final String
Key for connOptions Hashtable to specify the SSL personal store name to use, value should be a String.static final String
Key for connOptions Hashtable to specify the SSL personal store password to use, value should be a String.static final String
Key for connOptions Hashtable to specify the SSL reset count to use, value should be an Integerstatic final String
Key for connOptions Hashtable to specify the SSL trusted store name to use, value should be a Stringstatic final String
Key for connOptions Hashtable to specify the SSL trusted store password to use, value should be a String.static final String
Key for connOptions Hashtable to specify the user id to use, value should be a Stringstatic final String
Common copyright noticestatic final String
Key for options Hashtable to specify whether to auto-reconnect this queue manager, the value should be a Boolean.static final String
Key for options Hashtable to specify the refresh interval, the value should be an Integer.static final String
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.static final String
CMVC descriptors - expanded during extraction -
Constructor Summary
ConstructorsConstructorDescriptionQueueManagerConnections
(MQQmgrExtObject existingQM, String targetQ, String targetQM, Hashtable<String, ?> options) Constructor to add a queue manager to MQ Explorer, via an existing queue manager connectionQueueManagerConnections
(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 channelQueueManagerConnections
(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 channelQueueManagerConnections
(String qmName, URL chanDefTable, Hashtable<String, ?> connOptions, Hashtable<String, ?> options) Constructor to add a queue manager to MQ Explorer, using a channel definition table -
Method Summary
Modifier and TypeMethodDescriptionconnect()
Make the connection.static MQQmgrExtObject[]
Return an array of existing queue managers known to MQ Explorer (local or remote).static boolean
Return whether MQ Explorer will use FIPS when making a connection to a remote queue manager using SSLstatic boolean
isQueueManagerConnected
(MQQmgrExtObject mqQmgrExtObject) Return whether the specified queue manager is currently connectedstatic boolean
isQueueManagerLocal
(MQQmgrExtObject mqQmgrExtObject) Return whether the specified queue manager is localstatic boolean
isQueueManagerVisible
(MQQmgrExtObject mqQmgrExtObject) Return whether the specified queue manager is currently visible (not hidden)static boolean
removeRemoteQueueManager
(MQQmgrExtObject mqQmgrExtObject) Remove a remote queue manager from MQ Explorer
-
Field Details
-
COPYRIGHT_NOTICE
Common copyright notice- See Also:
-
SCCSID
CMVC descriptors - expanded during extraction- See Also:
-
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
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
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
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
Key for connOptions Hashtable to specify the security exit user data to use, value should be a String- See Also:
-
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
Key for connOptions Hashtable to specify the user id to use, value should be a String- See Also:
-
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
Key for connOptions Hashtable to specify the SSL cipher suite to use, value should be a String- See Also:
-
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
Key for connOptions Hashtable to specify the SSL reset count to use, value should be an Integer- See Also:
-
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
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
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
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 managerchanDefTable
- is the channel definition tableoptions
- is the list of options to useconnOptions
- 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 managerconnName
- is the connection name (hostname or IP address with port address)chlName
- is the client connection channel nameconnOptions
- is a list of connection related optionsoptions
- 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 managerconnNames
- is a list of connection names (hostname or IP address with port address)chlName
- is the client connection channel nameconnOptions
- is a list of connection related optionsoptions
- 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 ExplorertargetQ
- is the target queue name, owned by the target queue managertargetQM
- is the target queue manageroptions
- 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, otherwisefalse
-
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
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
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
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
-