JMS query scripts

The scripting library provides many script procedures to manage your Java™ Messaging Service (JMS) configurations. See the usage information for scripts that retrieve configuration IDs from your JMS configuration. You can run each script individually or combine many procedures to create custom automation scripts for your environment.

Each JMS management script procedure is located in the app_server_root/scriptLibraries/resources/JMS/V70 directory.

Beginning with Version 7, the Jython script library provides script functions for JDBC providers, JMS resources, and resource providers at the server scope. You can write your own custom scripts to configure resources at the cell, node, or cluster level.
Avoid trouble: Do not edit the script procedures in the script library. To write custom script library procedures, use the scripts in the app_server_root/scriptLibraries directory as Jython syntax samples. Save the custom scripts to a new subdirectory to avoid overwriting the library.
Fast path: Beginning with Fix Pack 5, the Jython script library provides script functions for JDBC providers, JMS resources, and resource providers at the cell, node, server, or cluster scope. Resource providers include mail providers, URL providers, and resource environment providers. You do not have to write custom scripts to configure resources at a particular scope.
Use the following script procedures to query your JMS configurations:

listGenericJMSConnectionFactories

This script displays a list of configuration IDs for the generic JMS connection factories configured in your environment.

The script does not require any input parameters.
Table 1. Argument for the listGenericJMSConnectionFactories script . Run the script to list generic JMS connection factories.
Argument Description
connFactoryName Optionally specifies the name of the generic JMS connection factory of interest.

Syntax

AdminJMS.listGenericJMSConnectionFactories(connFactoryName)

Example usage

AdminJMS.listGenericJMSConnectionFactories()
AdminJMS.listGenericJMSConnectionFactories("JMSCFTest")

listGenericJMSConnectionFactoryTemplates

This script displays a list of generic JMS connection factory template configuration ids.

The script does not require any input parameters. However, to return a specific generic JMS connection factory template, specify the template ID argument, as defined in the following table:
Table 2. Argument for the listGenericJMSConnectionFactoryTemplates script . Run the script to list generic JMS connection factory templates.
Argument Description
templateName Optionally specifies the name of the template of interest.

Syntax

AdminJMS.listGenericJMSConnectionFactoryTemplates(templateName)

Example usage

AdminJMS.listGenericJMSConnectionFactoryTemplates()
AdminJMS.listGenericJMSConnectionFactoryTemplates("Generic QueueConnectionFactory for Windows")

listGenericJMSDestinations

This script displays a list of configuration IDs for the generic JMS destinations configured in your environment. The script does not require any input parameters. However, to return a specific generic JMS destination, specify the generic JMS destination name.

The script does not require any input parameters. However, to return a specific generic JMS destination, specify the generic JMS destination name, as defined in the following table:
Table 3. Argument for the listGenericJMSDestinations script . Run the script to list generic JMS destinations.
Argument Description
destinationName Optionally specifies the name of the generic JMS destination of interest.

Syntax

AdminJMS.listGenericJMSDestinations(destinationName)

Example usage

AdminJMS.listGenericJMSDestinations()
AdminJMS.listGenericJMSDestinations("JMSDestination")

listGenericJMSDestinationTemplates

This script displays a list of generic JMS destination template configuration ids.

The script does not require any input parameters. However, to return a specific template, specify the template name, as defined in the following table:
Table 4. Argument for the listGenericJMSDestinationTemplates script . Run the script to list generic JMS destination templates.
Argument Description
templateName Optionally specifies the name of the template of interest.

Syntax

AdminJMS.listGenericJMSDestinationTemplates(templateName)

Example usage

AdminJMS.listGenericJMSDestinationTemplates()
AdminJMS.listGenericJMSDestinationTemplates("Example.JMS.Generic.Win.Topic")

listJMSProviders

This script displays a list of configuration IDs for the JMS providers that are configured in your environment.

The script does not require any input parameters. However, to return a specific JMS provider, specify the JMS provider name, as defined in the following table:
Table 5. Argument for the listJMSProviders script . Run the script to list JMS providers.
Argument Description
jmsProviderName Optionally specifies the name of the generic JMS connection factory of interest.

Syntax

AdminJMS.listJMSProviders(jmsProviderName)

Example usage

AdminJMS.listJMSProviders()
AdminJMS.listJMSProviders("JMSTest")

listJMSProviderTemplates

This script displays a list of JMS provider template configuration ids.

The script does not require any input parameters. However, to return a specific template, specify the template name, as defined in the following table:
Table 6. Argument for the listJMSProviderTemplates script . Run the script to list JMS provider templates.
Argument Description
templateName Optionally specifies the name of the template of interest.

Syntax

AdminJMS.listJMSProviderTemplates(templateName)

Example usage

AdminJMS.listJMSProviderTemplates()
AdminJMS.listJMSProviderTemplates("WebSphere JMS Provider")

listWASQueueConnectionFactoryTemplates

This script displays a list of JMS queue connection factory template configuration ids.

The script does not require any input parameters. However, to return a specific template, specify the template name, as defined in the following table:
Table 7. Argument for the listWASQueueConnectionFactoryTemplates script . Run the script to list JMS queue connection factory templates.
Argument Description
templateName Optionally specifies the name of the template of interest.

Syntax

AdminJMS.listWASQueueConnectionFactoryTemplates(templateName)

Example usage

AdminJMS.listWASQueueConnectionFactoryTemplates()
AdminJMS.listWASQueueConnectionFactoryTemplates("Example WAS QueueConnectionFactory")

listWASQueueTemplates

This script displays a list of JMS queue template configuration ids.

The script does not require any input parameters. However, to return a specific generic template, specify the template name, as defined in the following table:
Table 8. Argument for the listWASQueueTemplates script . Run the script with the template name argument.
Argument Description
templateName Optionally specifies the name of the template of interest.

Syntax

AdminJMS.listWASQueueTemplates(templateName)

Example usage

AdminJMS.listWASQueueTemplates()
AdminJMS.listWASQueueTemplates("Example.JMS.WAS.Q1")

listWASTopicConnectionFactoryTemplates

This script displays a list of JMS topic connection factory template configuration ids.

The script does not require any input parameters. However, to return a specific template, specify the template name, as defined in the following table:
Table 9. Argument for the listWASTopicConnectionFactoryTemplates script . Run the script to list JMS topic connection factory templates.
Argument Description
templateName Optionally specifies the name of the template of interest.

Syntax

AdminJMS.listWASTopicConnectionFactoryTemplates(templateName)

Example usage

AdminJMS.listWASTopicConnectionFactoryTemplates()
AdminJMS.listWASTopicConnectionFactoryTemplates("First Example WAS TopicConnectionFactory")

listWASQueueConnectionFactories

This script displays a list of configuration IDs for the JMS queue connection factories configured in your environment.

The script does not require any input parameters. However, to return a specific JMS queue connection factory, specify the connection factory name, as defined in the following table:
Table 10. Argument for the listWASQueueConnectionFactories script . Run the script to list JMS queue connection factories.
Argument Description
connFactoryName Optionally specifies the name of the JMS connection factory of interest.

Syntax

AdminJMS.listWASQueueConnectionFactories(connFactoryName)

Example usage

AdminJMS.listWASQueueConnectionFactories()
AdminJMS.listWASQueueConnectionFactories("queuecf")

listWASQueues

This script displays a list of JMS queues.

The script does not require any input parameters. However, to return a specific queue, specify the queue name, as defined in the following table:
Table 11. Argument for the listWASQueues script . Run the script to list JMS queues.
Argument Description
queueName Optionally specifies the name of the queue of interest.

Syntax

AdminJMS.listWASQueues(queueName)

Example usage

AdminJMS.listWASQueues()
AdminJMS.listWASQueues("WASQueueTest")

listWASTopicConnectionFactories

This script displays a list of configuration IDs for the JMS topic connection factories configured in your environment.

The script does not require any input parameters. However, to return a specific JMS topic connection factory, specify the connection factory name, as defined in the following table:
Table 12. Argument for the listWASTopicConnectionFactories script . Run the script to list JMS topic connection factories.
Argument Description
connFactoryName Optionally specifies the name of the JMS topic connection factory of interest.

Syntax

AdminJMS.listWASTopicConnectionFactories(connFactoryName)

Example usage

AdminJMS.listWASTopicConnectionFactories()
AdminJMS.listWASTopicConnectionFactories("TopicCFTest")

listWASTopics

This script displays a list of configuration IDs for the JMS topics configured in your environment.

The script does not require any input parameters. However, to return a specific topic, specify the topic name, as defined in the following table:
Table 13. Argument for the listWASTopics script . Run the script to list JMS topics.
Argument Description
topicName Optionally specifies the name of the topic of interest.

Syntax

AdminJMS.listWASTopics(topicName)

Example usage

AdminJMS.listWASTopics()
AdminJMS.listWASTopics("TopicTest")

listWASTopicTemplates

This script displays a list of JMS topic template configuration ids.

The script does not require any input parameters. However, to return a specific template, specify the template name, as defined in the following table:
Table 14. Argument for the listWASTopicTemplates script . Run the script to list JMS topic templates.
Argument Description
templateName Optionally specifies the name of the template of interest.

Syntax

AdminJMS.listWASTopicTemplates(templateName)

Example usage

AdminJMS.listWASTopicTemplates()
AdminJMS.listWASTopicTemplates("Example.JMS.WAS.T1")