SIBLinkTransmitter MBean

Partial ObjectName:
WebSphere:*,type=SIBLinkTransmitter


MBean SIBLinkTransmitter

Management interface for the SIB Link Transmitter component


Operation Summary

java.lang.StringgetBusName()
           Get the bus for which this link transmitter is in.
java.lang.StringgetForeignBusName()
           Get the foreign bus name for which this link transmitter is transmitting messages to.
java.lang.StringgetLinkType()
           Get the link type, SIBVirtualGatewayLink or SIBVirtualMQLink.
java.lang.StringgetTransmitterType()
           Get the transmitter type, QUEUE or PUBLICATION.
java.lang.StringgetTargetDestination()
           Get the target destination for a PUBLICATION transmitter.
java.lang.StringgetLinkName()
           Get the name of the link.
java.lang.StringgetEngineName()
           Get the name of the messaging engine the link transmitter is hosted on.
java.lang.StringgetState()
           The state of the link transmitter.
java.lang.StringgetHealthReason(java.util.Locale locale)
           The health reason of the link transmitter.
java.lang.StringgetHealthReason(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.util.Locale locale)
           The health reason of the link transmitter stream.
java.lang.LonggetTimeSinceLastMessageSent()
           The time in milliseconds since the last message was sent.
java.lang.LonggetDepth()
           The depth of messages on the link transmitter.
java.lang.LonggetNumberOfMessagesSent()
           The number of messages sent on the link transmitter.
java.lang.BooleanisPutInhibited()
           Is the link transmitter put inhibited?
com.ibm.websphere.sib.admin.SIBLinkTransmitterStream[]getStreams()
           Get the link transmitter message streams
com.ibm.websphere.sib.admin.SIBLinkTransmissionMessage[]getTransmissionMessages(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.Integer maxMsgs)
           Get the transmission messages from the given stream.
com.ibm.websphere.sib.admin.SIBLinkTransmissionMessagegetTransmissionMessage(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)
           Get the given transmission message from the given stream.
com.ibm.websphere.sib.admin.SIBLinkTransmissionMessageDetailgetTransmissionMessageDetail(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)
           Get the given transmission message detail from the given stream.
byte[]getTransmissionMessageData(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id, java.lang.Integer numBytes)
           Get the given transmission message data from the given stream.
voidrerouteAllMessages()
           Reroute all messages from the link transmitter.
voiddeleteAllMessages()
           Delete all messages from the link transmitter.
voidmoveAllMessagesToExceptionDestination()
           Move all messages from the link transmitter to the local exception destination.
voiddeleteMessage(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)
           Delete the given message from the link transmitter.
voidmoveMessageToExceptionDestination(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)
           Move the given message from the link transmitter to the local exception destination.

Operation Detail

getBusName

public java.lang.String getBusName()

     Get the bus for which this link transmitter is in.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getForeignBusName

public java.lang.String getForeignBusName()

     Get the foreign bus name for which this link transmitter is transmitting messages to.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getLinkType

public java.lang.String getLinkType()

     Get the link type, SIBVirtualGatewayLink or SIBVirtualMQLink.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTransmitterType

public java.lang.String getTransmitterType()

     Get the transmitter type, QUEUE or PUBLICATION.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTargetDestination

public java.lang.String getTargetDestination()

     Get the target destination for a PUBLICATION transmitter.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getLinkName

public java.lang.String getLinkName()

     Get the name of the link.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getEngineName

public java.lang.String getEngineName()

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

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getState

public java.lang.String getState()

     The state of the link transmitter.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getHealthReason

public java.lang.String getHealthReason(java.util.Locale locale)

     The health reason of the link transmitter.

Parameters:

     locale - Locale of message to return.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getHealthReason

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

     The health reason of the link transmitter stream.

Parameters:

     linkTransmitterStream - Link transmitter stream.
     locale - Locale of message to return.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTimeSinceLastMessageSent

public java.lang.Long getTimeSinceLastMessageSent()

     The time in milliseconds since the last message was sent.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getDepth

public java.lang.Long getDepth()

     The depth of messages on the link transmitter.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getNumberOfMessagesSent

public java.lang.Long getNumberOfMessagesSent()

     The number of messages sent on the link transmitter.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


isPutInhibited

public java.lang.Boolean isPutInhibited()

     Is the link transmitter put inhibited?

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getStreams

public com.ibm.websphere.sib.admin.SIBLinkTransmitterStream[] getStreams()

     Get the link transmitter message streams

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTransmissionMessages

public com.ibm.websphere.sib.admin.SIBLinkTransmissionMessage[] getTransmissionMessages(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.Integer maxMsgs)

     Get the transmission messages from the given stream.

Parameters:

     linkTransmitterStream - Link transmitter stream.
     maxMsgs - Maximum number of messages to return.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTransmissionMessage

public com.ibm.websphere.sib.admin.SIBLinkTransmissionMessage getTransmissionMessage(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)

     Get the given transmission message from the given stream.

Parameters:

     linkTransmitterStream - Link transmitter stream.
     id - Id of message

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTransmissionMessageDetail

public com.ibm.websphere.sib.admin.SIBLinkTransmissionMessageDetail getTransmissionMessageDetail(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)

     Get the given transmission message detail from the given stream.

Parameters:

     linkTransmitterStream - Link transmitter stream.
     id - Id of message

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTransmissionMessageData

public byte[] getTransmissionMessageData(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id, java.lang.Integer numBytes)

     Get the given transmission message data from the given stream.

Parameters:

     linkTransmitterStream - Link transmitter stream.
     id - Id of message
     numBytes - Maximum amount of data.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


rerouteAllMessages

public void rerouteAllMessages()

     Reroute all messages from the link transmitter.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


deleteAllMessages

public void deleteAllMessages()

     Delete all messages from the link transmitter.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


moveAllMessagesToExceptionDestination

public void moveAllMessagesToExceptionDestination()

     Move all messages from the link transmitter to the local exception destination.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


deleteMessage

public void deleteMessage(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)

     Delete the given message from the link transmitter.

Parameters:

     linkTransmitterStream - Link transmitter stream.
     id - Id of message

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


moveMessageToExceptionDestination

public void moveMessageToExceptionDestination(com.ibm.websphere.sib.admin.SIBLinkTransmitterStream linkTransmitterStream, java.lang.String id)

     Move the given message from the link transmitter to the local exception destination.

Parameters:

     linkTransmitterStream - Link transmitter stream.
     id - Id of message

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


Copyright IBM Corporation 2002, 2012