SIBRemoteQueuePoint MBean

Partial ObjectName:
WebSphere:*,type=SIBRemoteQueuePoint


MBean SIBRemoteQueuePoint

Management interface for a SIBRemoteQueuePoint


Attribute Summary
java.lang.Stringid
           An internally generated ID for the object
java.lang.Stringname
           The name of the object
java.lang.StringremoteMessagingEngineUuid
           The Uuid of the remote messaging engine where the queue point is localized

Operation Summary
com.ibm.websphere.sib.admin.SIBRemoteConsumerReceivergetRemoteConsumerReceiver()
           Return the SIBRemoteConsumerReceiver for this remote queue point that represents all non-gathering consumers.
com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver[]listRemoteConsumerReceivers()
           Return a list of all SIBRemoteConsumerReceivers for this remote queue point.
java.lang.LonggetRemoteConsumerReceiversCompletedMessageRequests()
           Return the number of completed message requests for all SIBRemoteConsumerReceivers for this remote queue point.
voidflush(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr)
           Deprecated.  This method is deprecated.
voidcancelAllRequests(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr)
           Cancel all message requests
voidrequestFlush(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr, java.lang.Boolean discard)
           Deprecated.  This method is deprecated.
com.ibm.websphere.sib.admin.SIBRemoteMessageRequest[]listRemoteMessageRequests(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr)
           List all current remote message requests
voidremove(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr, com.ibm.websphere.sib.admin.SIBRemoteMessageRequest rmr, java.lang.Boolean discard)
           Deprecated.  This method is deprecated.
com.ibm.websphere.sib.admin.SIBOutboundTransmittergetOutboundTransmitter()
           Return the SIBOutboundTransmitter for this remote queue point.
com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream[]getStreams(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot)
           Return the list of outbound transmitter streams
com.ibm.websphere.sib.admin.SIBTransmitMessage[]listTransmitMessages(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots)
           List the transmit messages that are on this remote queue point destined for the localising queue point
com.ibm.websphere.sib.admin.SIBTransmitMessageDetailgetTransmitMessageDetail(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId)
           Get detailed information on a specific transmit message on this remote queue point
byte[]getTransmitMessageData(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId, java.lang.Integer size)
           Return data from a specific transmit message on a specific remote queue point
voiddeleteAllTransmitMessages()
           Deletes all the transmit messages on this remote queue point
voidmoveAllTransmitMessagesToExceptionDestination()
           Moves all the transmit messages on this remote queue point to the exception destination
voidreallocateAllTransmitMessages()
           Reallocate all transmit messages
voiddeleteTransmitMessage(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId)
           Deletes the specified transmit message from this remote queue point
voidmoveTransmitMessageToExceptionDestination(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId)
           Moves the specified transmit message from this remote queue point to the exception destination
voidflush(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot)
           Deprecated.  This method is deprecated.
voidclearMessages(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, java.lang.Boolean discard)
           Deprecated.  This method is deprecated.
com.ibm.websphere.sib.admin.SIBTransmitMessage[]listTransmitMessages(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot)
           Lists current transmit messages
voidremove(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBTransmitMessage tm, java.lang.Boolean discard)
           Deprecated.  This method is deprecated.

Notification Summary
SIB.remote.messagepoint.depth.threshold.reached
           The number of messages stored at a remote queue point has made a depth change that causes messages to either start flowing or stop flowing into it.

Attribute Detail

id

public java.lang.String id
An internally generated ID for the object
Since:
6.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

name

public java.lang.String name
The name of the object
Since:
6.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

remoteMessagingEngineUuid

public java.lang.String remoteMessagingEngineUuid
The Uuid of the remote messaging engine where the queue point is localized
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Operation Detail

getRemoteConsumerReceiver

public com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver getRemoteConsumerReceiver()
Return the SIBRemoteConsumerReceiver for this remote queue point that represents all non-gathering consumers. This object will exist if a remote get has been invoked against the target queue point.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

listRemoteConsumerReceivers

public com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver[] listRemoteConsumerReceivers()
Return a list of all SIBRemoteConsumerReceivers for this remote queue point. One object will exist per category of remote consumers, remote consumers are categorized based on whether they are gathering messages from multiple queue points or not. If they are gathering messages they are categorized further based on the SIB destination used to determine the set of queue points to gather from. See the SIBRemoteConsumerReceiver interface for further details.
Since:
7.0
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getRemoteConsumerReceiversCompletedMessageRequests

public java.lang.Long getRemoteConsumerReceiversCompletedMessageRequests()
Return the number of completed message requests for all SIBRemoteConsumerReceivers for this remote queue point.
Since:
7.0
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

flush

public void flush(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr)
Deprecated.  This method is deprecated.

Parameters:
rcr - The object returned from a call to the getRemoteConsumerReceiver operation
Security Roles:
administrator
operator

cancelAllRequests

public void cancelAllRequests(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr)
Cancel all message requests
Parameters:
rcr - The object returned from a call to the getRemoteConsumerReceiver operation
Security Roles:
administrator
operator

requestFlush

public void requestFlush(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr, java.lang.Boolean discard)
Deprecated.  This method is deprecated.

Parameters:
rcr - The object returned from a call to the getRemoteConsumerReceiver operation
discard - If true, specifies that any indoubt messages should be discarded
Security Roles:
administrator
operator

listRemoteMessageRequests

public com.ibm.websphere.sib.admin.SIBRemoteMessageRequest[] listRemoteMessageRequests(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr)
List all current remote message requests
Parameters:
rcr - The object returned from a call to the getRemoteConsumerReceiver operation
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

remove

public void remove(com.ibm.websphere.sib.admin.SIBRemoteConsumerReceiver rcr, com.ibm.websphere.sib.admin.SIBRemoteMessageRequest rmr, java.lang.Boolean discard)
Deprecated.  This method is deprecated.

Remove a specified remote message request.
Parameters:
rcr - The object returned from a call to the getRemoteConsumerReceiver operation
rmr - An object returned from a call to the listRemoteMessageRequests operation
discard - If true, specifies that any pending messages should be discarded, otherwise they will be sent to the exception destination.
Security Roles:
administrator
operator

getOutboundTransmitter

public com.ibm.websphere.sib.admin.SIBOutboundTransmitter getOutboundTransmitter()
Return the SIBOutboundTransmitter for this remote queue point. This object will exist if a remote put has been invoked against the target queue point.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getStreams

public com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream[] getStreams(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot)
Return the list of outbound transmitter streams
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

listTransmitMessages

public com.ibm.websphere.sib.admin.SIBTransmitMessage[] listTransmitMessages(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots)
List the transmit messages that are on this remote queue point destined for the localising queue point
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
ots - The object returned from a call to the getStreams operation
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTransmitMessageDetail

public com.ibm.websphere.sib.admin.SIBTransmitMessageDetail getTransmitMessageDetail(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId)
Get detailed information on a specific transmit message on this remote queue point
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
ots - The object returned from a call to the getStreams operation
messageId - The ID of the Transmit Message as derived from the SIBTransmitMessage class
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTransmitMessageData

public byte[] getTransmitMessageData(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId, java.lang.Integer size)
Return data from a specific transmit message on a specific remote queue point
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
ots - The object returned from a call to the getStreams operation
messageId - The ID of the Transmit Message as derived from the SIBTransmitMessage class
size - The number of bytes to return
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

deleteAllTransmitMessages

public void deleteAllTransmitMessages()
Deletes all the transmit messages on this remote queue point
Security Roles:
administrator
operator

moveAllTransmitMessagesToExceptionDestination

public void moveAllTransmitMessagesToExceptionDestination()
Moves all the transmit messages on this remote queue point to the exception destination
Security Roles:
administrator
operator

reallocateAllTransmitMessages

public void reallocateAllTransmitMessages()
Reallocate all transmit messages
Security Roles:
administrator
operator

deleteTransmitMessage

public void deleteTransmitMessage(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId)
Deletes the specified transmit message from this remote queue point
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
ots - The object returned from a call to the getStreams operation
messageId - The ID of the Transmit Message as derived from the SIBTransmitMessage class
Security Roles:
administrator
operator

moveTransmitMessageToExceptionDestination

public void moveTransmitMessageToExceptionDestination(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBOutboundTransmitterStream ots, java.lang.String messageId)
Moves the specified transmit message from this remote queue point to the exception destination
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
ots - The object returned from a call to the getStreams operation
messageId - The ID of the Transmit Message as derived from the SIBTransmitMessage class
Security Roles:
administrator
operator

flush

public void flush(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot)
Deprecated.  This method is deprecated.

Flush
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
Security Roles:
administrator
operator

clearMessages

public void clearMessages(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, java.lang.Boolean discard)
Deprecated.  This method is deprecated.

Clear messages at source
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
discard - If true, specifies that any indoubt messages should be discarded
Security Roles:
administrator
operator

listTransmitMessages

public com.ibm.websphere.sib.admin.SIBTransmitMessage[] listTransmitMessages(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot)
Lists current transmit messages
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

remove

public void remove(com.ibm.websphere.sib.admin.SIBOutboundTransmitter ot, com.ibm.websphere.sib.admin.SIBTransmitMessage tm, java.lang.Boolean discard)
Deprecated.  This method is deprecated.

Remove a specified transmit message request.
Parameters:
ot - The object returned from a call to the getOutboundTransmitter operation
tm - An object returned from a call to the listTransmitMessages operation
discard - If true, specifies that any pending messages should be discarded, Otherwise, they will be sent to the Exception Destination.
Security Roles:
administrator
operator

Notification Detail

SIB.remote.messagepoint.depth.threshold.reached

The number of messages stored at a remote queue point 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## destination.name, destination.UUID, localizing.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 Corp. 1996-2005