WebSphere:*,type=SIBGatewayLink
MBean SIBGatewayLink
Management interface for the SIB Gateway Link component
Attribute Summary | |
---|---|
java.lang.String | targetInboundTransportChain Get the active target inbound transport chain |
java.lang.String | bootstrapEndpoints Get the active bootstrap endpoints |
java.lang.String | authenticationAlias Get the active authentication alias |
Operation Summary | |
---|---|
java.lang.String | getOverallStatus() Returns the overall status of the Gateway Link. |
java.lang.String | getStatus() Returns the status of the Gateway Link. |
java.lang.Boolean | isActive() Returns the activity of the Gateway Link. |
void | startLink() Starts the Gateway Link. |
void | stopLink() Stops the Gateway Link. |
java.lang.String | getBusName() Get the bus for which this link is in. |
java.lang.String | getForeignBusName() Get the foreign bus name for which this link is receiving messages from. |
java.lang.String | getLinkName() Get the name of the link. |
java.lang.String | getEngineName() 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( The link receiver streams. |
com.ibm.websphere.sib.admin.SIBLinkReceiverMessage[] | getReceiverMessages( Get the messages from the given stream. |
com.ibm.websphere.sib.admin.SIBLinkReceiverMessage | getReceiverMessage( Get the message from the given stream. |
com.ibm.websphere.sib.admin.SIBLinkReceiverMessageDetail | getReceiverMessageDetail( Get the message detail from the given stream. |
byte[] | getReceiverMessageData( Get the message body data from the given stream. |
java.lang.String | getHealthReason( Get the health reason for the given link receiver. |
java.lang.String | getHealthReason( 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 |
---|
public java.lang.String targetInboundTransportChain
Get the active target inbound transport chain
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String bootstrapEndpoints
Get the active bootstrap endpoints
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String authenticationAlias
Get the active authentication alias
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Operation Detail |
---|
public java.lang.String getOverallStatus()
Returns the overall status of the Gateway Link.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String getStatus()
Returns the status of the Gateway Link.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.Boolean isActive()
Returns the activity of the Gateway Link.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void startLink()
Starts the Gateway Link.
administrator
operator
public void stopLink()
Stops the Gateway Link.
administrator
operator
public java.lang.String getBusName()
Get the bus for which this link is in.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String getForeignBusName()
Get the foreign bus name for which this link is receiving messages from.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String getLinkName()
Get the name of the link.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String getEngineName()
Get the name of the messaging engine the link is hosted on.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public com.ibm.websphere.sib.admin.SIBLinkReceiver[] listLinkReceivers()
List the link receivers for this link.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public com.ibm.websphere.sib.admin.SIBLinkReceiverStream[] getReceiverStreams(
com.ibm.websphere.sib.admin.SIBLinkReceiver linkReceiver
)
The link receiver streams.
linkReceiver
-
Link receiver to get the streams from.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
linkReceiver
-
Link receiver. linkReceiverStream
-
Link receiver stream. maxMsgs
-
Maximum number of messages to return.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
linkReceiver
-
Link receiver. linkReceiverStream
-
Link receiver stream. id
-
Id of the message.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
linkReceiver
-
Link receiver. linkReceiverStream
-
Link receiver stream. id
-
Id of the message.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
linkReceiver
-
Link receiver. linkReceiverStream
-
Link receiver stream. id
-
Id of the message. maxBytes
-
Maximum number of bytes to return.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
linkReceiver
-
Link receiver. locale
-
Locale of message to return.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
linkReceiver
-
Link receiver. linkReceiverStream
-
Link receiver stream. locale
-
Locale of message to return.
Since:
7.0
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Notification Detail |
---|
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
6
(Normal, Cleared, or Informative)
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)
6
(Normal, Cleared, or Informative)
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)
5
(Warning)