SIBGatewayLink MBean

Partial ObjectName:
WebSphere:*,type=SIBGatewayLink


MBean SIBGatewayLink

Management interface for the SIB Gateway Link component


Attribute Summary

java.lang.StringtargetInboundTransportChain
           Get the active target inbound transport chain
java.lang.StringbootstrapEndpoints
           Get the active bootstrap endpoints
java.lang.StringauthenticationAlias
           Get the active authentication alias

Operation Summary

java.lang.StringgetOverallStatus()
           Returns the overall status of the Gateway Link.
java.lang.StringgetStatus()
           Returns the status of the Gateway Link.
java.lang.BooleanisActive()
           Returns the activity of the Gateway Link.
voidstartLink()
           Starts the Gateway Link.
voidstopLink()
           Stops the Gateway Link.
java.lang.StringgetBusName()
           Get the bus for which this link is in.
java.lang.StringgetForeignBusName()
           Get the foreign bus name for which this link is receiving messages from.
java.lang.StringgetLinkName()
           Get the name of the link.
java.lang.StringgetEngineName()
           Get the name of the messaging engine the link is hosted on.
com.ibm.websphere.sib.admin.SIBLinkReceiver[]listLinkReceivers()
           List the link receivers for this link.
com.ibm.websphere.sib.admin.SIBLinkReceiverStream[]getReceiverStreams(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver)
           The link receiver streams.
com.ibm.websphere.sib.admin.SIBLinkReceiverMessage[]getReceiverMessages(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.Integer maxMsgs)
           Get the messages from the given stream.
com.ibm.websphere.sib.admin.SIBLinkReceiverMessagegetReceiverMessage(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.String id)
           Get the message from the given stream.
com.ibm.websphere.sib.admin.SIBLinkReceiverMessageDetailgetReceiverMessageDetail(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.String id)
           Get the message detail from the given stream.
byte[]getReceiverMessageData(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.String id, java.lang.Integer maxBytes)
           Get the message body data from the given stream.
java.lang.StringgetHealthReason(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, java.util.Locale locale)
           Get the health reason for the given link receiver.
java.lang.StringgetHealthReason(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.util.Locale locale)
           Get the health reason for the given link receiver stream.

Notification Summary

SIB.link.start
           An inter-bus ME to ME connection has been started.
SIB.link.stop
           An inter-bus ME to ME connection has been stopped.
SIB.link.depth.threshold.reached
           The number of messages stored at a link to a remote bus has made a depth change that causes messages to either start flowing or stop flowing into it.

Attribute Detail

targetInboundTransportChain

public java.lang.String targetInboundTransportChain

     Get the active target inbound transport chain

     

Since:

7.0

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


bootstrapEndpoints

public java.lang.String bootstrapEndpoints

     Get the active bootstrap endpoints

     

Since:

7.0

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


authenticationAlias

public java.lang.String authenticationAlias

     Get the active authentication alias

     

Since:

7.0

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


Operation Detail

getOverallStatus

public java.lang.String getOverallStatus()

     Returns the overall status of the Gateway Link.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getStatus

public java.lang.String getStatus()

     Returns the status of the Gateway Link.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


isActive

public java.lang.Boolean isActive()

     Returns the activity of the Gateway Link.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


startLink

public void startLink()

     Starts the Gateway Link.

Security Roles:

     administrator
     operator


stopLink

public void stopLink()

     Stops the Gateway Link.

Security Roles:

     administrator
     operator


getBusName

public java.lang.String getBusName()

     Get the bus for which this link is in.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getForeignBusName

public java.lang.String getForeignBusName()

     Get the foreign bus name for which this link is receiving messages from.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getLinkName

public java.lang.String getLinkName()

     Get the name of the link.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getEngineName

public java.lang.String getEngineName()

     Get the name of the messaging engine the link is hosted on.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listLinkReceivers

public com.ibm.websphere.sib.admin.SIBLinkReceiver[] listLinkReceivers()

     List the link receivers for this link.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getReceiverStreams

public com.ibm.websphere.sib.admin.SIBLinkReceiverStream[] getReceiverStreams(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver)

     The link receiver streams.

Parameters:

     linkReceiver - Link receiver to get the streams from.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getReceiverMessages

public com.ibm.websphere.sib.admin.SIBLinkReceiverMessage[] getReceiverMessages(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.Integer maxMsgs)

     Get the messages from the given stream.

Parameters:

     linkReceiver - Link receiver.
     linkReceiverStream - Link receiver stream.
     maxMsgs - Maximum number of messages to return.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getReceiverMessage

public com.ibm.websphere.sib.admin.SIBLinkReceiverMessage getReceiverMessage(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.String id)

     Get the message from the given stream.

Parameters:

     linkReceiver - Link receiver.
     linkReceiverStream - Link receiver stream.
     id - Id of the message.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getReceiverMessageDetail

public com.ibm.websphere.sib.admin.SIBLinkReceiverMessageDetail getReceiverMessageDetail(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.String id)

     Get the message detail from the given stream.

Parameters:

     linkReceiver - Link receiver.
     linkReceiverStream - Link receiver stream.
     id - Id of the message.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getReceiverMessageData

public byte[] getReceiverMessageData(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.lang.String id, java.lang.Integer maxBytes)

     Get the message body data from the given stream.

Parameters:

     linkReceiver - Link receiver.
     linkReceiverStream - Link receiver stream.
     id - Id of the message.
     maxBytes - Maximum number of bytes to return.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getHealthReason

public java.lang.String getHealthReason(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, java.util.Locale locale)

     Get the health reason for the given link receiver.

Parameters:

     linkReceiver - Link receiver.
     locale - Locale of message to return.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getHealthReason

public java.lang.String getHealthReason(com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver, com.ibm.websphere.sib.admin.SIBLinkReceiverStream linkReceiverStream, java.util.Locale locale)

     Get the health reason for the given link receiver stream.

Parameters:

     linkReceiver - Link receiver.
     linkReceiverStream - Link receiver stream.
     locale - Locale of message to return.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


Notification Detail

SIB.link.start

     An inter-bus ME to ME connection has been started. 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## foreign.bus.name, remote.messaging.engine.name, remote.messaging.engine.uuid

Severity:

6  (Normal, Cleared, or Informative)


SIB.link.stop

     An inter-bus ME to ME connection has been stopped. 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## foreign.bus.name, remote.messaging.engine.name, remote.messaging.engine.uuid stop.reason (which may be communications.terminated or local.me.shutdown)

Severity:

6  (Normal, Cleared, or Informative)


SIB.link.depth.threshold.reached

     The number of messages stored at a link to a remote bus has made a depth change that causes messages to either start flowing or stop flowing into it. 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## link.name, link.UUID, foreign.bus.name, remote.messaging.engine.uuid, depth.threshold.reached (which may be depth.threshold.reached.high or depth.threshold.reached.low), messages (Count of messages at the message point)

Severity:

5  (Warning)


Copyright IBM Corporation 2002, 2012