@MXBean
public interface TopicMBean
The TopicMBean is enabled by the wasJmsServer feature.
A TopicMBean is initialized for each Topic existing on the messaging engine.
Use the MBean programming interface to query runtime information about a Topic.
JMX clients should use the ObjectName of this MBean to query it
Partial Object Name: WebSphere:feature=wasJmsServer, type=Topic,name=*
where name is unique for each Topic and is equal to the name of the Topic.
Modifier and Type | Method and Description |
---|---|
void |
deleteSubscription(java.lang.String subId)
Delete a subscription
|
void |
deleteSubscriptionMessage(java.lang.String subId,
java.lang.String messageId,
java.lang.Boolean move)
Delete a specific message on the Subscription.
|
long |
getDepth()
Total number of unique messages on this Topic which are not yet passed to all subscribers
|
java.lang.String |
getId()
The UUID of the Topic represented by this instance.
|
java.lang.String |
getIdentifier()
The identifier (name) attribute of the Topic represented
by this instance.
|
long |
getMaxQueueSize()
The maximum number of messages permitted at the Topic
|
com.ibm.ws.sib.admin.mxbean.MessagingSubscription |
getSubscription(java.lang.String subId)
Get an object representing a specified Subscription
|
com.ibm.ws.sib.admin.mxbean.MessagingSubscription |
getSubscriptionByName(java.lang.String subName)
Get an object representing a specified Subscription
|
com.ibm.ws.sib.admin.mxbean.QueuedMessage |
getSubscriptionMessage(java.lang.String subId,
java.lang.String messageId)
Get a message object representing one specific message on a specified Subscription.
|
byte[] |
getSubscriptionMessageData(java.lang.String subId,
java.lang.String messageId,
java.lang.Integer size)
Get the data content, or payload, of one specific message on the Subscription.
|
com.ibm.ws.sib.admin.mxbean.QueuedMessageDetail |
getSubscriptionMessageDetail(java.lang.String subId,
java.lang.String messageId)
Get a message object containing detailed information on one specific message on a specified Subscription.
|
com.ibm.ws.sib.admin.mxbean.QueuedMessage[] |
getSubscriptionMessages(java.lang.String subId)
Get an array of message objects representing the messages on a specified Subscription.
|
boolean |
isSendAllowed()
Can producers send to this Topic?
|
com.ibm.ws.sib.admin.mxbean.MessagingSubscription[] |
listSubscriptions()
List an array of objects representing all Subscriptions at this Topic
|
java.lang.String getId()
java.lang.String getIdentifier()
long getMaxQueueSize()
boolean isSendAllowed()
long getDepth()
com.ibm.ws.sib.admin.mxbean.MessagingSubscription[] listSubscriptions() throws java.lang.Exception
java.lang.Exception
com.ibm.ws.sib.admin.mxbean.MessagingSubscription getSubscription(java.lang.String subId) throws java.lang.Exception
subId
- the ID of the subscriptionjava.lang.Exception
com.ibm.ws.sib.admin.mxbean.MessagingSubscription getSubscriptionByName(java.lang.String subName) throws java.lang.Exception
subName
- the name of the subscription( name is represented as clientId##subscription name)java.lang.Exception
void deleteSubscription(java.lang.String subId) throws java.lang.Exception
subId
- com.ibm.ws.sib.admin.exception.InvalidArgumentException
com.ibm.ws.sib.admin.exception.ControllableNotFoundException
com.ibm.ws.sib.admin.exception.RuntimeOperationFailedException
java.lang.Exception
com.ibm.ws.sib.admin.mxbean.QueuedMessage[] getSubscriptionMessages(java.lang.String subId) throws java.lang.Exception
java.lang.Exception
com.ibm.ws.sib.admin.mxbean.QueuedMessage getSubscriptionMessage(java.lang.String subId, java.lang.String messageId) throws java.lang.Exception
subId
- the ID of the subscriptionmessageId
- the ID of the messagejava.lang.Exception
com.ibm.ws.sib.admin.mxbean.QueuedMessageDetail getSubscriptionMessageDetail(java.lang.String subId, java.lang.String messageId) throws java.lang.Exception
subId
- the ID of the subscriptionmessageId
- the ID of the messagejava.lang.Exception
byte[] getSubscriptionMessageData(java.lang.String subId, java.lang.String messageId, java.lang.Integer size) throws java.lang.Exception
subId
- the ID of the subscriptionmessageId
- the ID of the messagesize
- the number of bytes to return. If the size is specified as zero, or
the size exceeds the length of the data content, then the entire message content
is returned.java.lang.Exception
void deleteSubscriptionMessage(java.lang.String subId, java.lang.String messageId, java.lang.Boolean move) throws java.lang.Exception
subId
- the ID of the subscriptionmessageId
- the ID of the messagemove
- flag indicating whether the message should be discarded. If false, then the message
is physically deleted. If true, the message is moved to the exception destination for this queue,
if one exists.java.lang.Exception