SIBQueuePoint MBean

All Parent MBeans:

SIBMessagePoint

Partial ObjectName:
WebSphere:*,type=SIBQueuePoint


MBean SIBQueuePoint

Management interface for a SIBQueuePoint


Attribute Summary

java.lang.Longdepth
           Get the number of messages currently on the QueuePoint
java.lang.Stringstate
           Get the state of the Queue Point

Attributes inherited from MBean SIBMessagePoint
id, identifier, highMessageThreshold, sendAllowed

Operation Summary

SIBQueuedMessage[]getQueuedMessages()
           List information on all messages localized to this QueuePoint
SIBQueuedMessage[]getQueuedMessages(java.lang.Integer toIndex, java.lang.Integer fromIndex, java.lang.Integer totalMessagesPerPage)
           List information on all messages localized to this QueuePoint within a range
SIBQueuedMessagegetQueuedMessage(java.lang.String messageId)
           Get information on a specific message on this QueuePoint
SIBQueuedMessageDetailgetQueuedMessageDetail(java.lang.String messageId)
           Get detailed information on a specific message on this QueuePoint
SIBQueuedMessageDetailgetQueuedMessageDetail(java.lang.String messageId, java.util.Locale locale)
           Get detailed information on a specific message on this QueuePoint
byte[]getMessageData(java.lang.String id, java.lang.Integer size)
           Return data from a specific message on a specific QueuePoint
voiddeleteQueuedMessage(java.lang.String messageId, java.lang.Boolean move)
           Delete a specific message on this QueuePoint
voiddeleteAllQueuedMessages(java.lang.Boolean move)
           Delete all messages on this QueuePoint
SIBRemoteConsumerTransmitter[]listRemoteConsumerTransmitters()
           List transmitters to all non-gathering consumers hosted on remote messaging engines.
SIBRemoteConsumerTransmitter[]listAllRemoteConsumerTransmitters()
           List transmitters to all consumers hosted on remote messaging engines.
voidflush(SIBRemoteConsumerTransmitter rct)
          

Deprecated.

  This method is deprecated.
voidclearMessages(SIBRemoteConsumerTransmitter ot, java.lang.Boolean discard)
          

Deprecated.

  This method is deprecated.
SIBQueuedMessage[]listQueuedMessages(SIBRemoteConsumerTransmitter rct)
           List messages queued
SIBQueuedMessagegetQueuedMessage(SIBRemoteConsumerTransmitter rct, java.lang.String messageId)
           Get a queued message
SIBTransmitMessageRequest[]listTransmitMessageRequests(SIBRemoteConsumerTransmitter rct)
          

Deprecated.

  This method is deprecated.
SIBMessageRequest[]listMessageRequests(SIBRemoteConsumerTransmitter rct)
           Lists current message requests for a specific remote consumer
voidremove(SIBRemoteConsumerTransmitter rct, SIBTransmitMessageRequest tmr)
          

Deprecated.

  This method is deprecated.
SIBRequestMessageDetailgetRequestMessageDetail(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)
           Get detailed information on a specific request message on this QueuePoint
byte[]getRequestMessageData(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr, java.lang.Integer size)
           Return data from a specific request message on a specific QueuePoint
voidclearAndUnlockRequest(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)
           Clear the given message request and unlock any message that was retrieved.
voidclearAndDeleteRequest(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)
           Clear the given message request and delete any message that was retrieved.
SIBInboundReceiver[]listInboundReceivers()
           List the Inbound Receiver which receives messages from a remote queue point destined for this queue point
SIBInboundReceiverStream[]getStreams(SIBInboundReceiver ir)
           Return the list of inbound receiver streams
SIBReceivedMessage[]listReceivedMessages(SIBInboundReceiver ir, SIBInboundReceiverStream irs)
           List information on all received messages on this QueuePoint
SIBReceivedMessageDetailgetReceivedMessageDetail(SIBInboundReceiver ir, SIBInboundReceiverStream irs, java.lang.String messageId)
           Get detailed information on a specific received message on this QueuePoint
byte[]getReceivedMessageData(SIBInboundReceiver ir, SIBInboundReceiverStream irs, java.lang.String messageId, java.lang.Integer size)
           Return data from a specific received message on a specific QueuePoint
voidflush(SIBInboundReceiver ir)
          

Deprecated.

  This method is deprecated.
voidrequestFlush(SIBInboundReceiver ir, java.lang.Boolean discard)
          

Deprecated.

  This method is deprecated.

Notification Summary

SIB.messagepoint.send.allowed.state
           The send allowed state has changed
SIB.messagepoint.receive.allowed.state
           The receive allowed state has changed

Notifications inherited from MBean SIBMessagePoint
SIB.messagepoint.send.allowed.state, SIB.messagepoint.receive.allowed.state, SIB.messagepoint.depth.threshold.reached

Attribute Detail

depth

public java.lang.Long depth

     Get the number of messages currently on the QueuePoint

     

Since:

6.0

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


state

public java.lang.String state

     Get the state of the Queue Point

     

Since:

6.0

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


Operation Detail

getQueuedMessages

public SIBQueuedMessage[] getQueuedMessages()

     List information on all messages localized to this QueuePoint

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getQueuedMessages

public SIBQueuedMessage[] getQueuedMessages(java.lang.Integer toIndex, java.lang.Integer fromIndex, java.lang.Integer totalMessagesPerPage)

     List information on all messages localized to this QueuePoint within a range

Parameters:

     toIndex - fromIndex
     fromIndex - toIndex
     totalMessagesPerPage - totalMessagesPerPage

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getQueuedMessage

public SIBQueuedMessage getQueuedMessage(java.lang.String messageId)

     Get information on a specific message on this QueuePoint

Parameters:

     messageId - The ID of the Message as derived from the SIBQueuedMessage class

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getQueuedMessageDetail

public SIBQueuedMessageDetail getQueuedMessageDetail(java.lang.String messageId)

     Get detailed information on a specific message on this QueuePoint

Parameters:

     messageId - The ID of the Message as derived from the SIBQueuedMessage class

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getQueuedMessageDetail

public SIBQueuedMessageDetail getQueuedMessageDetail(java.lang.String messageId, java.util.Locale locale)

     Get detailed information on a specific message on this QueuePoint

Parameters:

     messageId - The ID of the Message as derived from the SIBQueuedMessage class
     locale - The Locale for which to return any exception messages

Since:

6.1

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getMessageData

public byte[] getMessageData(java.lang.String id, java.lang.Integer size)

     Return data from a specific message on a specific QueuePoint

Parameters:

     id - The ID of the Message as derived from the SIBQueuedMessage class
     size - The number of bytes to return

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


deleteQueuedMessage

public void deleteQueuedMessage(java.lang.String messageId, java.lang.Boolean move)

     Delete a specific message on this QueuePoint

Parameters:

     messageId - The ID of the Message as derived from the SIBQueuedMessage class
     move - Whether the message should be moved to the Exception Destination rather than discarded

Security Roles:

     administrator
     operator


deleteAllQueuedMessages

public void deleteAllQueuedMessages(java.lang.Boolean move)

     Delete all messages on this QueuePoint

Parameters:

     move - Whether the messages should be moved to the Exception Destination rather than discarded

Since:

6.1

Security Roles:

     administrator
     operator


listRemoteConsumerTransmitters

public SIBRemoteConsumerTransmitter[] listRemoteConsumerTransmitters()

     List transmitters to all non-gathering consumers hosted on remote messaging engines. This method has been superceeded by listAllRemoteConsumerTransmitters() which will return all transmitters for both gathering and non-gathering consumers. That method should be used in preference to this method.

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listAllRemoteConsumerTransmitters

public SIBRemoteConsumerTransmitter[] listAllRemoteConsumerTransmitters()

     List transmitters to all consumers hosted on remote messaging engines. This method superceeds listRemoteConsumerTransmitters() which will only return transmitters for non-gathering consumers.

Since:

7.0

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


flush

public void flush(SIBRemoteConsumerTransmitter rct)

     

Deprecated.

  This method is deprecated.

     Flush

Parameters:

     rct - The object returned from a call to the listRemoteConsumerTransmitters operation

Security Roles:

     administrator
     operator


clearMessages

public void clearMessages(SIBRemoteConsumerTransmitter ot, java.lang.Boolean discard)

     

Deprecated.

  This method is deprecated.

     Clear messages at source

Parameters:

     ot - The object returned from a call to the listRemoteConsumerTransmitters operation
     discard - If true, specifies that any indoubt messages should be discarded

Security Roles:

     administrator
     operator


listQueuedMessages

public SIBQueuedMessage[] listQueuedMessages(SIBRemoteConsumerTransmitter rct)

     List messages queued

Parameters:

     rct - The instance of a SIBRemoteConsumerTransmitter returned from the listRemoteConsumerTransmitters operation

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getQueuedMessage

public SIBQueuedMessage getQueuedMessage(SIBRemoteConsumerTransmitter rct, java.lang.String messageId)

     Get a queued message

Parameters:

     rct - An instance of the SIBRemoteConsumerTransmitter object returned from the listRemoteConsumerTransmitters operation
     messageId - The ID of the Message as derived from the SIBQueuedMessage class

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listTransmitMessageRequests

public SIBTransmitMessageRequest[] listTransmitMessageRequests(SIBRemoteConsumerTransmitter rct)

     

Deprecated.

  This method is deprecated.

     Lists current message requests for a specific remote consumer

Parameters:

     rct - An instance of the SIBRemoteConsumerTransmitter object returned from the listRemoteConsumerTransmitters operation

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listMessageRequests

public SIBMessageRequest[] listMessageRequests(SIBRemoteConsumerTransmitter rct)

     Lists current message requests for a specific remote consumer

Parameters:

     rct - An instance of the SIBRemoteConsumerTransmitter object returned from the listRemoteConsumerTransmitters operation

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


remove

public void remove(SIBRemoteConsumerTransmitter rct, SIBTransmitMessageRequest tmr)

     

Deprecated.

  This method is deprecated.

     Remove a specified transmit message request.

Parameters:

     rct - An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation
     tmr - An object returned from a call to the listTransmitMessageRequests operation

Security Roles:

     administrator
     operator


getRequestMessageDetail

public SIBRequestMessageDetail getRequestMessageDetail(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)

     Get detailed information on a specific request message on this QueuePoint

Parameters:

     rct - An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation
     mr - An object returned from a call to the listMessageRequests operation

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRequestMessageData

public byte[] getRequestMessageData(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr, java.lang.Integer size)

     Return data from a specific request message on a specific QueuePoint

Parameters:

     rct - An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation
     mr - An object returned from a call to the listMessageRequests operation
     size - The number of bytes to return

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


clearAndUnlockRequest

public void clearAndUnlockRequest(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)

     Clear the given message request and unlock any message that was retrieved.

Parameters:

     rct - An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation
     mr - An object returned from a call to the listMessageRequests operation

Security Roles:

     administrator
     operator


clearAndDeleteRequest

public void clearAndDeleteRequest(SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)

     Clear the given message request and delete any message that was retrieved.

Parameters:

     rct - An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation
     mr - An object returned from a call to the listMessageRequests operation

Security Roles:

     administrator
     operator


listInboundReceivers

public SIBInboundReceiver[] listInboundReceivers()

     List the Inbound Receiver which receives messages from a remote queue point destined for this queue point

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getStreams

public SIBInboundReceiverStream[] getStreams(SIBInboundReceiver ir)

     Return the list of inbound receiver streams

Parameters:

     ir - The object returned from a call to the listInboundReceivers operation

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listReceivedMessages

public SIBReceivedMessage[] listReceivedMessages(SIBInboundReceiver ir, SIBInboundReceiverStream irs)

     List information on all received messages on this QueuePoint

Parameters:

     ir - The object returned from a call to the listInboundReceivers operation
     irs - The object returned from a call to the getStreams operation

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getReceivedMessageDetail

public SIBReceivedMessageDetail getReceivedMessageDetail(SIBInboundReceiver ir, SIBInboundReceiverStream irs, java.lang.String messageId)

     Get detailed information on a specific received message on this QueuePoint

Parameters:

     ir - The object returned from a call to the listInboundReceivers operation
     irs - The object returned from a call to the getStreams operation
     messageId - The ID of the Received Message as derived from the SIBReceivedMessage class

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getReceivedMessageData

public byte[] getReceivedMessageData(SIBInboundReceiver ir, SIBInboundReceiverStream irs, java.lang.String messageId, java.lang.Integer size)

     Return data from a specific received message on a specific QueuePoint

Parameters:

     ir - The object returned from a call to the listInboundReceivers operation
     irs - The object returned from a call to the getStreams operation
     messageId - The ID of the Received Message as derived from the SIBReceivedMessage class
     size - The number of bytes to return

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


flush

public void flush(SIBInboundReceiver ir)

     

Deprecated.

  This method is deprecated.

     Flush

Parameters:

     ir - The object returned from a call to the listInboundReceivers operation

Security Roles:

     administrator
     operator


requestFlush

public void requestFlush(SIBInboundReceiver ir, java.lang.Boolean discard)

     

Deprecated.

  This method is deprecated.

     Request a flush

Parameters:

     ir - The object returned from a call to the listInboundReceivers operation
     discard - If true, specifies that any indoubt messages should be discarded

Security Roles:

     administrator
     operator


Notification Detail

SIB.messagepoint.send.allowed.state

     The send allowed state has changed

Severity:

6  (Normal, Cleared, or Informative)


SIB.messagepoint.receive.allowed.state

     The receive allowed state has changed

Severity:

6  (Normal, Cleared, or Informative)


Copyright IBM Corporation 2002, 2012