Class MQQmgrExtObject
java.lang.Object
com.ibm.mq.explorer.ui.internal.objects.MQExtObjectBase
com.ibm.mq.explorer.ui.extensions.MQExtObject
com.ibm.mq.explorer.ui.extensions.MQQmgrExtObject
- All Implemented Interfaces:
org.eclipse.ui.IActionFilter
External object representing a UI QueueManager. This class provides enough information to
uniquely identify a queue manager object and enough details to create a connection.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Connection Type - Using Channel Definition Tablestatic final int
Connection Type - Clientstatic final int
Connection Type - Client for a multi instance queue managerstatic final int
Connection Type - not availablestatic final int
Connection Type - Serverstatic final int
Connection Type - Via Command Queuestatic final String
Copyright noticestatic final String
SCCS id - expanded when file is extracted from CMVCFields inherited from class com.ibm.mq.explorer.ui.extensions.MQExtObject
VERSION
-
Constructor Summary
ConstructorsConstructorDescriptionNull constructorMQQmgrExtObject
(MQExtObject parentObj, Object obj, String type, String objId, String objName) Constructor -
Method Summary
Modifier and TypeMethodDescriptionReturn the channel definition table being used by Explorer to connect to this queue manager.Deprecated.Return the channel name being used by Explorer to connect to this queue manager.int
Get the command level of the Queue ManagerReturn the connection name being used by Explorer to connect to this queue manager.String[]
Get the list of connection names being used by Explorer to connect to this queue manager.int
Return the type of connection that Explorer is using to this queue manager.Return the host name being used by Explorer to connect to this queue manager.com.ibm.mq.MQQueueManager
Return a MQQueueManager connection to this queue manager.int
Get the platform of the machine running the Queue Managerint
Return the port address being used by Explorer to connect to this queue manager.getUuid()
Get the UUID of the Queue ManagerReturn the via command queue name being used by Explorer to connect to this queue manager.Return the via queue manager name being used by Explorer to connect to this queue manager.boolean
isClient()
Is the queue manager a client connection?boolean
Is the queue manager connected?boolean
isLocal()
Return whether this queue manager is localboolean
isRemote()
Return whether this queue manager is remoteboolean
Return whether this queue manager is a standby instance, i.e.boolean
Return whether this queue manager is started.boolean
Determine whether this queue manager was started with the "-x" option.boolean
Return whether this queue manager is currently visible (not hidden) in MQ Explorerboolean
testAttribute
(Object target, String name, String value) test an attribute of the supplied objectMethods inherited from class com.ibm.mq.explorer.ui.extensions.MQExtObject
addObjectChangedListener, addObjectDeletedListener, getInstanceId, getInternalDataObject, getInternalObject, getMqType, getName, getObjectChangedListenerCount, getObjectDeletedListenerCount, getObjectId, getParent, objectChanged, objectDeleted, removeObjectChangedListener, removeObjectDeletedListener, setInternalDataObject, setInternalObject, setName, toString
-
Field Details
-
SCCSID
SCCS id - expanded when file is extracted from CMVC- See Also:
-
COPYRIGHT_NOTICE
Copyright notice- See Also:
-
CONNECTION_TYPE_NOT_AVAILABLE
public static final int CONNECTION_TYPE_NOT_AVAILABLEConnection Type - not available- See Also:
-
CONNECTION_TYPE_SERVER
public static final int CONNECTION_TYPE_SERVERConnection Type - Server- See Also:
-
CONNECTION_TYPE_CLIENT
public static final int CONNECTION_TYPE_CLIENTConnection Type - Client- See Also:
-
CONNECTION_TYPE_CHANNEL_DEF_TABLE
public static final int CONNECTION_TYPE_CHANNEL_DEF_TABLEConnection Type - Using Channel Definition Table- See Also:
-
CONNECTION_TYPE_VIA_CMD_Q
public static final int CONNECTION_TYPE_VIA_CMD_QConnection Type - Via Command Queue- See Also:
-
CONNECTION_TYPE_CLIENT_MULTI_INSTANCE
public static final int CONNECTION_TYPE_CLIENT_MULTI_INSTANCEConnection Type - Client for a multi instance queue manager- See Also:
-
-
Constructor Details
-
MQQmgrExtObject
public MQQmgrExtObject()Null constructor -
MQQmgrExtObject
public MQQmgrExtObject(MQExtObject parentObj, Object obj, String type, String objId, String objName) Constructor- Parameters:
objName
- Name of the objectobjId
- Object IDtype
- object typeobj
- instance objectparentObj
- parent MQExtObject
-
-
Method Details
-
getCommandLevel
public int getCommandLevel()Get the command level of the Queue Manager- Returns:
- the command level
-
isConnected
public boolean isConnected()Is the queue manager connected?- Returns:
- true if the queue manager is connected
-
isClient
public boolean isClient()Is the queue manager a client connection?- Returns:
- true if the connection to the queue manager is a client connection
-
getPlatform
public int getPlatform()Get the platform of the machine running the Queue Manager- Returns:
- the platform of the queue manager
-
getUuid
Get the UUID of the Queue Manager- Returns:
- the UUID
-
getConnectionType
public int getConnectionType()Return the type of connection that Explorer is using to this queue manager. The connection type determines which connection details are availableCONNECTION_TYPE_SERVER
uses local bindingsCONNECTION_TYPE_CLIENT
can usegetConnectionName()
,getHostName()
,getPortAddress()
, andgetChannelName()
CONNECTION_TYPE_CHANNEL_DEF_TABLE
can usegetChannelDefinitionTable()
CONNECTION_TYPE_VIA_CMD_Q
can usegetViaQueueManagerName()
andgetViaCommandQueueName()
CONNECTION_TYPE_CLIENT_MULTI_INSTANCE
can usegetConnectionName()
,getConnectionNames()
,getHostName()
,getPortAddress()
andgetChannelName()
- Returns:
- the connection type (CONNECTION_TYPE_xxx value)
-
getConnectionName
Return the connection name being used by Explorer to connect to this queue manager. The connection name includes both the host name and port address.- Returns:
- String the connection name, or null if not available
-
getConnectionNames
Get the list of connection names being used by Explorer to connect to this queue manager. Each connection name includes both the host name and port address.- Returns:
- a list of connection names or
null
if not a client connection
-
getHostName
Return the host name being used by Explorer to connect to this queue manager.- Returns:
- String the host name, or null if not available
-
getPortAddress
public int getPortAddress()Return the port address being used by Explorer to connect to this queue manager.- Returns:
- int the port address, or -1 if not available
-
getChannelName
Return the channel name being used by Explorer to connect to this queue manager.- Returns:
- String the channel name, or null if not available
-
getChannelDefintionTable
Deprecated.Return the channel definition table being used by Explorer to connect to this queue manager.- Returns:
- String the channel definition table, or null if not available
-
getChannelDefinitionTable
Return the channel definition table being used by Explorer to connect to this queue manager.- Returns:
- String the channel definition table, or null if not available
-
getViaQueueManagerName
Return the via queue manager name being used by Explorer to connect to this queue manager.- Returns:
- String the via queue manager name, or null if not available
-
getViaCommandQueueName
Return the via command queue name being used by Explorer to connect to this queue manager.- Returns:
- String the via command queue name, or null if not available
-
getMQQueueManager
public com.ibm.mq.MQQueueManager getMQQueueManager()Return a MQQueueManager connection to this queue manager. Note: This method is not available if the connection type is CONNECTION_TYPE_VIA_CMD_Q.- Returns:
- MQQueueManager connection to this queue manager
-
testAttribute
Description copied from class:com.ibm.mq.explorer.ui.internal.objects.MQExtObjectBase
test an attribute of the supplied object- Specified by:
testAttribute
in interfaceorg.eclipse.ui.IActionFilter
- Overrides:
testAttribute
in classMQExtObject
- Parameters:
target
- Target objectname
- Name of the parametervalue
- Value to test- Returns:
- boolean is attribute equal?
-
isVisible
public boolean isVisible()Return whether this queue manager is currently visible (not hidden) in MQ Explorer- Returns:
- true if the queue manager is visible, false if it is hidden
-
isLocal
public boolean isLocal()Return whether this queue manager is local- Returns:
- true if the queue manager is local, false otherwise
-
isRemote
public boolean isRemote()Return whether this queue manager is remote- Returns:
- true if the queue manager is remote, false otherwise
-
isStarted
public boolean isStarted()Return whether this queue manager is started. This will also return true if the queue manager is a standby instance as it was started with the "-x" option.- Returns:
- true if the queue manager is started, false otherwise
-
isStartedWithPermitStandby
public boolean isStartedWithPermitStandby()Determine whether this queue manager was started with the "-x" option.- Returns:
- true if the queue manager was started with "-x", false otherwise
-
isStandby
public boolean isStandby()Return whether this queue manager is a standby instance, i.e. it was started with the "-x" option and there was already an active instance.- Returns:
- true if the queue manager is a standby instance, false otherwise
-
getChannelDefinitionTable()