SIBMessagePoint
WebSphere:*,type=SIBQueuePoint
MBean SIBQueuePoint
Management interface for a SIBQueuePoint
Attribute Summary | |
---|---|
java.lang.Long | depth Get the number of messages currently on the QueuePoint |
java.lang.String | state 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( List information on all messages localized to this QueuePoint within a range |
SIBQueuedMessage | getQueuedMessage( Get information on a specific message on this QueuePoint |
SIBQueuedMessageDetail | getQueuedMessageDetail( Get detailed information on a specific message on this QueuePoint |
SIBQueuedMessageDetail | getQueuedMessageDetail( Get detailed information on a specific message on this QueuePoint |
byte[] | getMessageData( Return data from a specific message on a specific QueuePoint |
void | deleteQueuedMessage( Delete a specific message on this QueuePoint |
void | deleteAllQueuedMessages( 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. |
void | flush( Deprecated.This method is deprecated. |
void | clearMessages( Deprecated.This method is deprecated. |
SIBQueuedMessage[] | listQueuedMessages( List messages queued |
SIBQueuedMessage | getQueuedMessage( Get a queued message |
SIBTransmitMessageRequest[] | listTransmitMessageRequests( Deprecated.This method is deprecated. |
SIBMessageRequest[] | listMessageRequests( Lists current message requests for a specific remote consumer |
void | remove( Deprecated.This method is deprecated. |
SIBRequestMessageDetail | getRequestMessageDetail( Get detailed information on a specific request message on this QueuePoint |
byte[] | getRequestMessageData( Return data from a specific request message on a specific QueuePoint |
void | clearAndUnlockRequest( Clear the given message request and unlock any message that was retrieved. |
void | clearAndDeleteRequest( 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( Return the list of inbound receiver streams |
SIBReceivedMessage[] | listReceivedMessages( List information on all received messages on this QueuePoint |
SIBReceivedMessageDetail | getReceivedMessageDetail( Get detailed information on a specific received message on this QueuePoint |
byte[] | getReceivedMessageData( Return data from a specific received message on a specific QueuePoint |
void | flush( Deprecated.This method is deprecated. |
void | requestFlush( 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 |
---|
public java.lang.Long depth
Get the number of messages currently on the QueuePoint
Since:
6.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String state
Get the state of the Queue Point
Since:
6.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Operation Detail |
---|
public SIBQueuedMessage[] getQueuedMessages()
List information on all messages localized to this QueuePoint
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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
toIndex
-
fromIndex fromIndex
-
toIndex totalMessagesPerPage
-
totalMessagesPerPage
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessage getQueuedMessage(
java.lang.String messageId
)
Get information on a specific message on this QueuePoint
messageId
-
The ID of the Message as derived from the SIBQueuedMessage class
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessageDetail getQueuedMessageDetail(
java.lang.String messageId
)
Get detailed information on a specific message on this QueuePoint
messageId
-
The ID of the Message as derived from the SIBQueuedMessage class
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessageDetail getQueuedMessageDetail(
java.lang.String messageId,
java.util.Locale locale
)
Get detailed information on a specific message on this QueuePoint
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
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public byte[] getMessageData(
java.lang.String id,
java.lang.Integer size
)
Return data from a specific message on a specific QueuePoint
id
-
The ID of the Message as derived from the SIBQueuedMessage class size
-
The number of bytes to return
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void deleteQueuedMessage(
java.lang.String messageId,
java.lang.Boolean move
)
Delete a specific message on this QueuePoint
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
administrator
operator
public void deleteAllQueuedMessages(
java.lang.Boolean move
)
Delete all messages on this QueuePoint
move
-
Whether the messages should be moved to the Exception Destination rather than discarded
Since:
6.1
administrator
operator
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void flush(
SIBRemoteConsumerTransmitter rct
)
Deprecated.
This method is deprecated.
Flush
rct
-
The object returned from a call to the listRemoteConsumerTransmitters operation
administrator
operator
public void clearMessages(
SIBRemoteConsumerTransmitter ot,
java.lang.Boolean discard
)
Deprecated.
This method is deprecated.
Clear messages at source
ot
-
The object returned from a call to the listRemoteConsumerTransmitters operation discard
-
If true, specifies that any indoubt messages should be discarded
administrator
operator
public SIBQueuedMessage[] listQueuedMessages(
SIBRemoteConsumerTransmitter rct
)
List messages queued
rct
-
The instance of a SIBRemoteConsumerTransmitter returned from the listRemoteConsumerTransmitters operation
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessage getQueuedMessage(
SIBRemoteConsumerTransmitter rct,
java.lang.String messageId
)
Get a queued message
rct
-
An instance of the SIBRemoteConsumerTransmitter object returned from the listRemoteConsumerTransmitters operation messageId
-
The ID of the Message as derived from the SIBQueuedMessage class
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBTransmitMessageRequest[] listTransmitMessageRequests(
SIBRemoteConsumerTransmitter rct
)
Deprecated.
This method is deprecated.
Lists current message requests for a specific remote consumer
rct
-
An instance of the SIBRemoteConsumerTransmitter object returned from the listRemoteConsumerTransmitters operation
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBMessageRequest[] listMessageRequests(
SIBRemoteConsumerTransmitter rct
)
Lists current message requests for a specific remote consumer
rct
-
An instance of the SIBRemoteConsumerTransmitter object returned from the listRemoteConsumerTransmitters operation
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void remove(
SIBRemoteConsumerTransmitter rct,
SIBTransmitMessageRequest tmr
)
Deprecated.
This method is deprecated.
Remove a specified transmit message request.
rct
-
An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation tmr
-
An object returned from a call to the listTransmitMessageRequests operation
administrator
operator
public SIBRequestMessageDetail getRequestMessageDetail(
SIBRemoteConsumerTransmitter rct,
SIBMessageRequest mr
)
Get detailed information on a specific request message on this QueuePoint
rct
-
An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation mr
-
An object returned from a call to the listMessageRequests operation
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public byte[] getRequestMessageData(
SIBRemoteConsumerTransmitter rct,
SIBMessageRequest mr,
java.lang.Integer size
)
Return data from a specific request message on a specific QueuePoint
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
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void clearAndUnlockRequest(
SIBRemoteConsumerTransmitter rct,
SIBMessageRequest mr
)
Clear the given message request and unlock any message that was retrieved.
rct
-
An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation mr
-
An object returned from a call to the listMessageRequests operation
administrator
operator
public void clearAndDeleteRequest(
SIBRemoteConsumerTransmitter rct,
SIBMessageRequest mr
)
Clear the given message request and delete any message that was retrieved.
rct
-
An instance of a SIBRemoteConsumerTransmitter returned from a call to listRemoteConsumerTransmitters operation mr
-
An object returned from a call to the listMessageRequests operation
administrator
operator
public SIBInboundReceiver[] listInboundReceivers()
List the Inbound Receiver which receives messages from a remote queue point destined for this queue point
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBInboundReceiverStream[] getStreams(
SIBInboundReceiver ir
)
Return the list of inbound receiver streams
ir
-
The object returned from a call to the listInboundReceivers operation
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBReceivedMessage[] listReceivedMessages(
SIBInboundReceiver ir,
SIBInboundReceiverStream irs
)
List information on all received messages on this QueuePoint
ir
-
The object returned from a call to the listInboundReceivers operation irs
-
The object returned from a call to the getStreams operation
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBReceivedMessageDetail getReceivedMessageDetail(
SIBInboundReceiver ir,
SIBInboundReceiverStream irs,
java.lang.String messageId
)
Get detailed information on a specific received message on this QueuePoint
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
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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
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
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void flush(
SIBInboundReceiver ir
)
Deprecated.
This method is deprecated.
Flush
ir
-
The object returned from a call to the listInboundReceivers operation
administrator
operator
public void requestFlush(
SIBInboundReceiver ir,
java.lang.Boolean discard
)
Deprecated.
This method is deprecated.
Request a flush
ir
-
The object returned from a call to the listInboundReceivers operation discard
-
If true, specifies that any indoubt messages should be discarded
administrator
operator
Notification Detail |
---|
The send allowed state has changed
6
(Normal, Cleared, or Informative)
The receive allowed state has changed
6
(Normal, Cleared, or Informative)