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
com.ibm.websphere.sib.admin.SIBQueuedMessage[]getQueuedMessages()
           List information on all messages localized to this QueuePoint
com.ibm.websphere.sib.admin.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
com.ibm.websphere.sib.admin.SIBQueuedMessagegetQueuedMessage(java.lang.String messageId)
           Get information on a specific message on this QueuePoint
com.ibm.websphere.sib.admin.SIBQueuedMessageDetailgetQueuedMessageDetail(java.lang.String messageId)
           Get detailed information on a specific message on this QueuePoint
com.ibm.websphere.sib.admin.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
com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter[]listRemoteConsumerTransmitters()
           List transmitters to all non-gathering consumers hosted on remote messaging engines.
com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter[]listAllRemoteConsumerTransmitters()
           List transmitters to all consumers hosted on remote messaging engines.
voidflush(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct)
           Deprecated.  This method is deprecated.
voidclearMessages(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter ot, java.lang.Boolean discard)
           Deprecated.  This method is deprecated.
com.ibm.websphere.sib.admin.SIBQueuedMessage[]listQueuedMessages(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct)
           List messages queued
com.ibm.websphere.sib.admin.SIBQueuedMessagegetQueuedMessage(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, java.lang.String messageId)
           Get a queued message
com.ibm.websphere.sib.admin.SIBTransmitMessageRequest[]listTransmitMessageRequests(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct)
           Deprecated.  This method is deprecated.
com.ibm.websphere.sib.admin.SIBMessageRequest[]listMessageRequests(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct)
           Lists current message requests for a specific remote consumer
voidremove(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.SIBTransmitMessageRequest tmr)
           Deprecated.  This method is deprecated.
com.ibm.websphere.sib.admin.SIBRequestMessageDetailgetRequestMessageDetail(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.SIBMessageRequest mr)
           Get detailed information on a specific request message on this QueuePoint
byte[]getRequestMessageData(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.SIBMessageRequest mr, java.lang.Integer size)
           Return data from a specific request message on a specific QueuePoint
voidclearAndUnlockRequest(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.SIBMessageRequest mr)
           Clear the given message request and unlock any message that was retrieved.
voidclearAndDeleteRequest(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.SIBMessageRequest mr)
           Clear the given message request and delete any message that was retrieved.
com.ibm.websphere.sib.admin.SIBInboundReceiver[]listInboundReceivers()
           List the Inbound Receiver which receives messages from a remote queue point destined for this queue point
com.ibm.websphere.sib.admin.SIBInboundReceiverStream[]getStreams(com.ibm.websphere.sib.admin.SIBInboundReceiver ir)
           Return the list of inbound receiver streams
com.ibm.websphere.sib.admin.SIBReceivedMessage[]listReceivedMessages(com.ibm.websphere.sib.admin.SIBInboundReceiver ir, com.ibm.websphere.sib.admin.SIBInboundReceiverStream irs)
           List information on all received messages on this QueuePoint
com.ibm.websphere.sib.admin.SIBReceivedMessageDetailgetReceivedMessageDetail(com.ibm.websphere.sib.admin.SIBInboundReceiver ir, com.ibm.websphere.sib.admin.SIBInboundReceiverStream irs, java.lang.String messageId)
           Get detailed information on a specific received message on this QueuePoint
byte[]getReceivedMessageData(com.ibm.websphere.sib.admin.SIBInboundReceiver ir, com.ibm.websphere.sib.admin.SIBInboundReceiverStream irs, java.lang.String messageId, java.lang.Integer size)
           Return data from a specific received message on a specific QueuePoint
voidflush(com.ibm.websphere.sib.admin.SIBInboundReceiver ir)
           Deprecated.  This method is deprecated.
voidrequestFlush(com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBQueuedMessage[] getQueuedMessages()
List information on all messages localized to this QueuePoint
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuedMessages

public com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBQueuedMessage[] listQueuedMessages(com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBQueuedMessage getQueuedMessage(com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBTransmitMessageRequest[] listTransmitMessageRequests(com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBMessageRequest[] listMessageRequests(com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBRequestMessageDetail getRequestMessageDetail(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.SIBRemoteConsumerTransmitter rct, com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBInboundReceiverStream[] getStreams(com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBReceivedMessage[] listReceivedMessages(com.ibm.websphere.sib.admin.SIBInboundReceiver ir, com.ibm.websphere.sib.admin.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 com.ibm.websphere.sib.admin.SIBReceivedMessageDetail getReceivedMessageDetail(com.ibm.websphere.sib.admin.SIBInboundReceiver ir, com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.SIBInboundReceiver ir, com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.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(com.ibm.websphere.sib.admin.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 Corp. 1996-2005