JMSAdministration MBean

Partial ObjectName:
WebSphere:*,type=JMSAdministration


MBean JMSAdministration

JMS Provider Administration. Provides basic administration function for JMS providers.


Operation Summary
java.lang.BooleanisEmpty(java.lang.String jndiQueueName, java.lang.String jndiQCF)
           Boolean function indicates if there are any messages in the specified queue.
java.lang.BooleanisEmpty(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password)
           Boolean function indicates if there are any messages in the specified queue.
java.lang.Integerclear(java.lang.String jndiQueueName, java.lang.String jndiQCF)
           Clears all the messages from the specified queue.
java.lang.Integerclear(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password)
           Clears all the messages from the specified queue.
java.lang.Integerclear(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String selector)
           Clears messages which match the specified selector from the specified queue.
java.lang.Integerclear(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.String selector)
           Clears messages which match the specified selector from the specified queue.
java.lang.Stringbrowse(java.lang.String jndiQueueName, java.lang.String jndiQCF)
           Browse a message on the specified queue.
java.lang.Stringbrowse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password)
           Browse a message on the specified queue.
java.lang.String[]browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.Integer numberOfMessages)
           Browse messages on the specified queue.
java.lang.String[]browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.Integer numberOfMessages)
           Browse messages on the specified queue.
java.lang.String[]browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String selector)
           Browse messages on the specified queue.
java.lang.String[]browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.String selector)
           Browse messages on the specified queue.
java.lang.String[]browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.Integer numberOfMessages, java.lang.String selector)
           Browse messages on the specified queue.
java.lang.String[]browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.Integer numberOfMessages, java.lang.String selector)
           Browse messages on the specified queue.

Operation Detail

isEmpty

public java.lang.Boolean isEmpty(java.lang.String jndiQueueName, java.lang.String jndiQCF)
Boolean function indicates if there are any messages in the specified queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
Security Roles:
administrator
operator

isEmpty

public java.lang.Boolean isEmpty(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password)
Boolean function indicates if there are any messages in the specified queue. The caller supplies the user Id and password for the Topic Connection Factory.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
user - user name for the queue connection factory.
password - password for the queue connection factory.
Security Roles:
administrator
operator

clear

public java.lang.Integer clear(java.lang.String jndiQueueName, java.lang.String jndiQCF)
Clears all the messages from the specified queue. The return value from the method is actually the number of messages which were cleared from the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
Security Roles:
administrator
operator

clear

public java.lang.Integer clear(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password)
Clears all the messages from the specified queue. The caller supplies the user id and password for the Queue Connection Factory. The return value from the method is actually the number of messages which were cleared from the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
user - user name for the queue connection factory.
password - password for the queue connection factory.
Security Roles:
administrator
operator

clear

public java.lang.Integer clear(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String selector)
Clears messages which match the specified selector from the specified queue. The return value from the method is actually the number of messages which were cleared from the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.
Security Roles:
administrator
operator

clear

public java.lang.Integer clear(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.String selector)
Clears messages which match the specified selector from the specified queue. The caller supplies the user Id and password for the Queue Connection Factory. The return value from the method is actually the number of messages which were cleared from the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
user - user name for the queue connection factory.
password - password for the queue connection factory.
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.
Security Roles:
administrator
operator

browse

public java.lang.String browse(java.lang.String jndiQueueName, java.lang.String jndiQCF)
Browse a message on the specified queue. The message remains on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
Security Roles:
administrator
operator

browse

public java.lang.String browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password)
Browse a message on the specified queue. The caller supplies the user Id and password for the Queue Connection Factory. The messages remain on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
user - user name for the queue connection factory.
password - password for the queue connection factory.
Security Roles:
administrator
operator

browse

public java.lang.String[] browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.Integer numberOfMessages)
Browse messages on the specified queue. The number of messages will be used to determine the maximum number of messages to return to the caller. The messages remain on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
numberOfMessages - The number of messages to return to the caller.
Security Roles:
administrator
operator

browse

public java.lang.String[] browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.Integer numberOfMessages)
Browse messages on the specified queue. The number of messages will be used to determine the maximum number of messages to return to the caller. The caller supplies the user Id and password for the Queue Connection Factory. The messages remain on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
user - user name for the queue connection factory.
password - password for the queue connection factory.
numberOfMessages - The number of messages to return to the caller.
Security Roles:
administrator
operator

browse

public java.lang.String[] browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String selector)
Browse messages on the specified queue. The selector will be used to match messages which selection criteria. All of the messages which match the selector on the queue will be returned to the caller. The messages remain on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.
Security Roles:
administrator
operator

browse

public java.lang.String[] browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.String selector)
Browse messages on the specified queue. The selector will be used to match messages which selection criteria. All of the messages which match the selector on the queue will be returned to the caller. The caller supplies the user Id and password for the Queue Connection Factory. The messages remain on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
user - user name for the queue connection factory.
password - password for the queue connection factory.
selector - The selection criteria for the message, for more information on the format see javax.jms.Message.
Security Roles:
administrator
operator

browse

public java.lang.String[] browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.Integer numberOfMessages, java.lang.String selector)
Browse messages on the specified queue. The selector will be used to match messages which selection criteria. The number of messages will be used to determine the maximum number of messages to return to the caller. The messages remain on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
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.
Security Roles:
administrator
operator

browse

public java.lang.String[] browse(java.lang.String jndiQueueName, java.lang.String jndiQCF, java.lang.String user, java.lang.String password, java.lang.Integer numberOfMessages, java.lang.String selector)
Browse messages on the specified queue. The selector will be used to match messages which selection criteria. The number of messages will be used to determine the maximum number of messages to return to the caller. The caller supplies the user Id and password for the Queue Connection Factory. The messages remain on the queue.
Parameters:
jndiQueueName - The name of the queue as specified in the JNDI namespace.
jndiQCF - The name of the queue connection factory as specified in the JNDI namespace.
user - user name for the queue connection factory.
password - password for the queue connection factory.
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.
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005