com.ibm.mq.explorer.ui.extensions

Class MQQmgrExtObject

  • All Implemented Interfaces:
    org.eclipse.ui.IActionFilter


    public class MQQmgrExtObject
    extends MQExtObject
    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 Detail

      • SCCSID

        public static final java.lang.String SCCSID
        SCCS id - expanded when file is extracted from CMVC
        See Also:
        Constant Field Values
      • COPYRIGHT_NOTICE

        public static final java.lang.String COPYRIGHT_NOTICE
        Copyright notice
        See Also:
        Constant Field Values
      • CONNECTION_TYPE_NOT_AVAILABLE

        public static final int CONNECTION_TYPE_NOT_AVAILABLE
        Connection Type - not available
        See Also:
        Constant Field Values
      • CONNECTION_TYPE_SERVER

        public static final int CONNECTION_TYPE_SERVER
        Connection Type - Server
        See Also:
        Constant Field Values
      • CONNECTION_TYPE_CLIENT

        public static final int CONNECTION_TYPE_CLIENT
        Connection Type - Client
        See Also:
        Constant Field Values
      • CONNECTION_TYPE_CHANNEL_DEF_TABLE

        public static final int CONNECTION_TYPE_CHANNEL_DEF_TABLE
        Connection Type - Using Channel Definition Table
        See Also:
        Constant Field Values
      • CONNECTION_TYPE_VIA_CMD_Q

        public static final int CONNECTION_TYPE_VIA_CMD_Q
        Connection Type - Via Command Queue
        See Also:
        Constant Field Values
      • CONNECTION_TYPE_CLIENT_MULTI_INSTANCE

        public static final int CONNECTION_TYPE_CLIENT_MULTI_INSTANCE
        Connection Type - Client for a multi instance queue manager
        See Also:
        Constant Field Values
    • Constructor Detail

      • MQQmgrExtObject

        public MQQmgrExtObject()
        Null constructor
      • MQQmgrExtObject

        public MQQmgrExtObject(MQExtObject parentObj,
                               java.lang.Object obj,
                               java.lang.String type,
                               java.lang.String objId,
                               java.lang.String objName)
        Constructor
        Parameters:
        objName - Name of the object
        objId - Object ID
        type - object type
        obj - instance object
        parentObj - parent MQExtObject
    • Method Detail

      • 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

        public java.lang.String getUuid()
        Get the UUID of the Queue Manager
        Returns:
        the UUID
      • getConnectionName

        public java.lang.String 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

        public java.lang.String[] 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

        public java.lang.String 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

        public java.lang.String 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

        public java.lang.String getChannelDefintionTable()
        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

        public java.lang.String 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

        public java.lang.String 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

        public java.lang.String 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

        public boolean testAttribute(java.lang.Object target,
                                     java.lang.String name,
                                     java.lang.String value)
        Description copied from class: com.ibm.mq.explorer.ui.internal.objects.MQExtObjectBase
        test an attribute of the supplied object
        Specified by:
        testAttribute in interface org.eclipse.ui.IActionFilter
        Overrides:
        testAttribute in class MQExtObject
        Parameters:
        target - Target object
        name - Name of the parameter
        value - 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