EmbeddedJMSAdministration MBean

JMS Provider Administration. Provides function for the embedded and integral JMS provider.


Operation Summary
java.lang.IntegerdepthBoQ()
           The current depth of messages which exist in the system defined Back Out Queue.
java.lang.Integerdepth(java.lang.String jmsResourceQueueName)
           The current depth of messages which exist in the specified queue.
java.lang.IntegerclearBoQ()
           Clears all the messages from the system defined Back Out Queue.
java.lang.IntegerclearBoQ(java.lang.String selector)
           Clears the messages which match the specified selector from the system defined Back Out Queue.
java.lang.StringbrowseBoQ()
           Browse the messages on the system defined Back Out Queue.
java.lang.String[]browseBoQ(java.lang.String selector)
           Browse the messages on the system defined Back Out Queue.
java.lang.String[]browseBoQ(java.lang.Integer numberOfMessages)
           Browse the messages on the system defined Back Out Queue.
java.lang.String[]browseBoQ(java.lang.Integer numberOfMessages, java.lang.String selector)
           Browse the messages on the system defined Back Out Queue.
java.lang.StringbrowseBoQHeader()
           Browse the header of the top message on the system defined Back Out Queue.
java.lang.String[]browseBoQHeader(java.lang.String selector)
           Browse the header of the messages on the system defined Back Out Queue.
java.lang.String[]browseBoQHeader(java.lang.Integer numberOfMessages)
           Browse the header of the messages on the system defined Back Out Queue.
java.lang.String[]browseBoQHeader(java.lang.Integer numberOfMessages, java.lang.String selector)
           Browse the header of the messages on the system defined Back Out Queue.
java.lang.String[]listDurableSubscriptions()
           List all of the durable subscriptions.
voidremoveDurableSubscription(java.lang.String topic, java.lang.String userId, java.lang.String clientId)
           Remove the durable subscriptions, information can be obtained from the listDurableSubscribers.

Operation Detail

depthBoQ

public java.lang.Integer depthBoQ()
The current depth of messages which exist in the system defined Back Out Queue.

depth

public java.lang.Integer depth(java.lang.String jmsResourceQueueName)
The current depth of messages which exist in the specified queue. The queue name is the display name for the resource, not the JNDI name as the other APIs.
Parameters:
jmsResourceQueueName - The name of the queue as specified in the JMS resource.

clearBoQ

public java.lang.Integer clearBoQ()
Clears all the messages from the system defined Back Out Queue. The return value indicates the number of messages removed from the queue.

clearBoQ

public java.lang.Integer clearBoQ(java.lang.String selector)
Clears the messages which match the specified selector from the system defined Back Out Queue. The return value indicates the number of message removed from the queue.
Parameters:
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.

browseBoQ

public java.lang.String browseBoQ()
Browse the messages on the system defined Back Out Queue. The messages will remain on the queue.

browseBoQ

public java.lang.String[] browseBoQ(java.lang.String selector)
Browse the messages on the system defined Back Out Queue. The messages will remain on the queue.
Parameters:
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.

browseBoQ

public java.lang.String[] browseBoQ(java.lang.Integer numberOfMessages)
Browse the messages on the system defined Back Out Queue. The messages will remain on the queue.
Parameters:
numberOfMessages - The number of messages to return to the caller.

browseBoQ

public java.lang.String[] browseBoQ(java.lang.Integer numberOfMessages, java.lang.String selector)
Browse the messages on the system defined Back Out Queue. The messages will remain on the queue.
Parameters:
numberOfMessages - The number of messages to return to the caller.
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.

browseBoQHeader

public java.lang.String browseBoQHeader()
Browse the header of the top message on the system defined Back Out Queue. The messages will remain on the queue.

browseBoQHeader

public java.lang.String[] browseBoQHeader(java.lang.String selector)
Browse the header of the messages on the system defined Back Out Queue. The selector will be used to determine which messages to return to the caller. The messages will remain on the queue.
Parameters:
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.

browseBoQHeader

public java.lang.String[] browseBoQHeader(java.lang.Integer numberOfMessages)
Browse the header of the messages on the system defined Back Out Queue. The specified number of messages will be returned. The messages will remain on the queue.
Parameters:
numberOfMessages - The number of messages to return to the caller.

browseBoQHeader

public java.lang.String[] browseBoQHeader(java.lang.Integer numberOfMessages, java.lang.String selector)
Browse the header of the messages on the system defined Back Out Queue. The selector will be used to select the messages to return to the caller. The messages returned to the caller will be limited to the number specified in the number of messages parameter. The messages will remain on the queue.
Parameters:
numberOfMessages - The number of messages to return to the caller.
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.

listDurableSubscriptions

public java.lang.String[] listDurableSubscriptions()
List all of the durable subscriptions. The return value is a java.lang.String which consist of the topic, the user and the client id. This information can be used to remove the durable subscription.

removeDurableSubscription

public void removeDurableSubscription(java.lang.String topic, java.lang.String userId, java.lang.String clientId)
Remove the durable subscriptions, information can be obtained from the listDurableSubscribers. There is not return value from the method, the listDurableSubscribers method should be used to verify the success of the command.
Parameters:
topic - Name of the topic.
userId - Name of the user Id
clientId - Name of the client Id.

Copyright IBM Corp. 1996-2003