SIBMQClientLink MBean

Partial ObjectName:
WebSphere:*,type=SIBMQClientLink


MBean SIBMQClientLink

Management interface for the SIB MQ Client Link component


Operation Summary

java.lang.StringgetOverallStatus()
           Returns the overall status of the MQ Client Link.
java.util.ListgetConnectionStatus()
           Returns the status of the MQ Client Link client connections.
java.lang.StringgetQueueManagerName()
           Returns the name of the queue manager this MQ Client Link represents.
voidstartLink()
           Starts the MQ Client Link.
voidstopLink(java.lang.String mode, java.lang.String status)
           Stops the MQ Client Link with the given mode and status.
voidstopConnection(java.lang.Long connectionHandle, java.lang.String mode)
           Stops the given MQ Client Link client connection using the given mode.
java.lang.BooleanisEnabled()
           Checks to see if the specified WebSphere MQ Client Link is enabled or not.

Notification Summary

SIB.client.connection.start
           An MQClient has connected.
SIB.client.connection.stop
           An MQClient has disconnected.

Operation Detail

getOverallStatus

public java.lang.String getOverallStatus()

     Returns the overall status of the MQ Client Link.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getConnectionStatus

public java.util.List getConnectionStatus()

     Returns the status of the MQ Client Link client connections. Returns a List of SIBMQClientLinkConnectionStatus, or null if there is none. @see SIBMQClientLinkConnectionStatus.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getQueueManagerName

public java.lang.String getQueueManagerName()

     Returns the name of the queue manager this MQ Client Link represents.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


startLink

public void startLink()

     Starts the MQ Client Link.

Security Roles:

     administrator
     operator


stopLink

public void stopLink(java.lang.String mode, java.lang.String status)

     Stops the MQ Client Link with the given mode and status.

Parameters:

     mode - Stop mode (quiesce/force).
     status - Stop status (inactive/stopped).

Security Roles:

     administrator
     operator


stopConnection

public void stopConnection(java.lang.Long connectionHandle, java.lang.String mode)

     Stops the given MQ Client Link client connection using the given mode. The handle is determined from getConnectionStatus.

Parameters:

     connectionHandle - connectionHandle (handle returned by getConnectionStatus()).
     mode - mode (quiesce/force).

Security Roles:

     administrator
     operator


isEnabled

public java.lang.Boolean isEnabled()

     Checks to see if the specified WebSphere MQ Client Link is enabled or not.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


Notification Detail

SIB.client.connection.start

     An MQClient has connected. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## client.userid (The user identifier of the client making the connection), fap.type (which may be MQFAP only), communications.address (The network address in dotted decimal form of the client. This may not be the actual address of the client, if, for example it uses a gateway.)

Severity:

6  (Normal, Cleared, or Informative)


SIB.client.connection.stop

     An MQClient has disconnected. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## client.userid (The user identifier of the client making the connection), stop.reason (which may be communications.failure or client.shutdown)

Severity:

6  (Normal, Cleared, or Informative)


Copyright IBM Corporation 2002, 2012