SIBPublicationPoint MBean

All Parent MBeans:

SIBMessagePoint

Partial ObjectName:
WebSphere:*,type=SIBPublicationPoint


MBean SIBPublicationPoint

Management interface for a SIBPublicationPoint


Attribute Summary

java.lang.Longdepth
           Get the number of messages not yet delivered to all subscribers on the PublicationPoint

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

Operation Summary

SIBSubscription[]getSubscriptions()
           Get the subscriptions on this Publication Point
SIBSubscriptiongetSubscription(java.lang.String id)
           Get a specific subscription on this Publication Point
SIBSubscriptiongetSubscriptionByName(java.lang.String id)
           Get a specific subscription on this Publication Point
voiddeleteSubscription(java.lang.String id)
           Delete a specific subscription on this Publication Point
SIBQueuedMessage[]getSubscriptionMessages(java.lang.String subId)
           Get the messages at a specific subscription on this Publication Point
SIBQueuedMessagegetSubscriptionMessage(java.lang.String subId, java.lang.String messageId)
           Get information on a specific message on this a specific subscription on this Publication Point
SIBQueuedMessageDetailgetSubscriptionMessageDetail(java.lang.String subId, java.lang.String messageId)
           Get detailed information on a specific message on this a specific subscription on this Publication Point
SIBQueuedMessageDetailgetSubscriptionMessageDetail(java.lang.String subId, java.lang.String messageId, java.util.Locale locale)
           Get detailed information on a specific message on this a specific subscription on this Publication Point
byte[]getSubscriptionMessageData(java.lang.String subId, java.lang.String messageId, java.lang.Integer size)
           Return data from a specific message on a specific subscription on this Publication Point
voiddeleteSubscriptionMessage(java.lang.String subId, java.lang.String messageId, java.lang.Boolean move)
           Delete a specific message on this SubscriptionPoint
SIBInboundReceiver[]listInboundReceivers()
           List the Inbound Receiver which receives messages from a remote publication point destined for this publication 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 PublicationPoint
SIBReceivedMessageDetailgetReceivedMessageDetail(SIBInboundReceiver ir, SIBInboundReceiverStream irs, java.lang.String messageId)
           Get detailed information on a specific received message on this PublicationPoint
byte[]getReceivedMessageData(SIBInboundReceiver ir, SIBInboundReceiverStream irs, java.lang.String messageId, java.lang.Integer size)
           Return data from a specific received message on a specific PublicationPoint
voidflush(SIBInboundReceiver ir)
          

Deprecated.

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

Deprecated.

  This method is deprecated.
SIBRemoteConsumerTransmitter[]listRemoteConsumerTransmitters(SIBSubscription s)
           List transmitters to consumers hosted on remote messaging engines.
SIBTransmitMessageRequest[]listTransmitMessageRequests(SIBSubscription s, SIBRemoteConsumerTransmitter rct)
          

Deprecated.

  This method is deprecated.
SIBMessageRequest[]listMessageRequests(SIBSubscription s, SIBRemoteConsumerTransmitter rct)
           Lists current message requests for a specific remote consumer
SIBRequestMessageDetailgetRequestMessageDetail(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)
           Get detailed information on a specific request message on this PublicationPoint
byte[]getRequestMessageData(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr, java.lang.Integer size)
           Return data from a specific request message on a specific PublicationPoint
voidclearAndUnlockRequest(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)
           Clear the given message request and unlock any message that was retrieved.
voidclearAndDeleteRequest(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)
           Clear the given message request and delete any message that was retrieved.

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 not yet delivered to all subscribers on the PublicationPoint

     

Since:

6.1

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


Operation Detail

getSubscriptions

public SIBSubscription[] getSubscriptions()

     Get the subscriptions on this Publication Point

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getSubscription

public SIBSubscription getSubscription(java.lang.String id)

     Get a specific subscription on this Publication Point

Parameters:

     id - The ID of the Subscription as derived from the SIBSubscription class

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getSubscriptionByName

public SIBSubscription getSubscriptionByName(java.lang.String id)

     Get a specific subscription on this Publication Point

Parameters:

     id - The name of the Subscription as derived from the SIBSubscription class

Since:

6.1

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


deleteSubscription

public void deleteSubscription(java.lang.String id)

     Delete a specific subscription on this Publication Point

Parameters:

     id - The ID of the Subscription as derived from the SIBSubscription class

Security Roles:

     administrator
     operator


getSubscriptionMessages

public SIBQueuedMessage[] getSubscriptionMessages(java.lang.String subId)

     Get the messages at a specific subscription on this Publication Point

Parameters:

     subId - The ID of the Subscription as derived from the SIBSubscription class

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getSubscriptionMessage

public SIBQueuedMessage getSubscriptionMessage(java.lang.String subId, java.lang.String messageId)

     Get information on a specific message on this a specific subscription on this Publication Point

Parameters:

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

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getSubscriptionMessageDetail

public SIBQueuedMessageDetail getSubscriptionMessageDetail(java.lang.String subId, java.lang.String messageId)

     Get detailed information on a specific message on this a specific subscription on this Publication Point

Parameters:

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

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getSubscriptionMessageDetail

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

     Get detailed information on a specific message on this a specific subscription on this Publication Point

Parameters:

     subId - The ID of the Subscription as derived from the SIBSubscription class
     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


getSubscriptionMessageData

public byte[] getSubscriptionMessageData(java.lang.String subId, java.lang.String messageId, java.lang.Integer size)

     Return data from a specific message on a specific subscription on this Publication Point

Parameters:

     subId - The ID of the Subscription as derived from the SIBSubscription class
     messageId - 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


deleteSubscriptionMessage

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

     Delete a specific message on this SubscriptionPoint

Parameters:

     subId - The ID of the Subscription as derived from the SIBSubscription class
     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


listInboundReceivers

public SIBInboundReceiver[] listInboundReceivers()

     List the Inbound Receiver which receives messages from a remote publication point destined for this publication 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 PublicationPoint

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 PublicationPoint

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 PublicationPoint

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


listRemoteConsumerTransmitters

public SIBRemoteConsumerTransmitter[] listRemoteConsumerTransmitters(SIBSubscription s)

     List transmitters to consumers hosted on remote messaging engines.

Parameters:

     s - An instance of the SIBSubscription object returned from the getSubscriptions operation

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listTransmitMessageRequests

public SIBTransmitMessageRequest[] listTransmitMessageRequests(SIBSubscription s, SIBRemoteConsumerTransmitter rct)

     

Deprecated.

  This method is deprecated.

     Lists current message requests for a specific remote consumer

Parameters:

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

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listMessageRequests

public SIBMessageRequest[] listMessageRequests(SIBSubscription s, SIBRemoteConsumerTransmitter rct)

     Lists current message requests for a specific remote consumer

Parameters:

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

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getRequestMessageDetail

public SIBRequestMessageDetail getRequestMessageDetail(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)

     Get detailed information on a specific request message on this PublicationPoint

Parameters:

     s - An instance of the SIBSubscription object returned from the getSubscriptions operation
     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(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr, java.lang.Integer size)

     Return data from a specific request message on a specific PublicationPoint

Parameters:

     s - An instance of the SIBSubscription object returned from the getSubscriptions operation
     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(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)

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

Parameters:

     s - An instance of the SIBSubscription object returned from the getSubscriptions operation
     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(SIBSubscription s, SIBRemoteConsumerTransmitter rct, SIBMessageRequest mr)

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

Parameters:

     s - An instance of the SIBSubscription object returned from the getSubscriptions operation
     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


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