JMS query scripts
The scripting library provides many script procedures to manage your Java™ Messaging Service (JMS) configurations. This page provides usage information for scripts that retrieve configuration IDs from the JMS configuration. We can run each script individually or combine many procedures to create custom automation scripts for the environment.
Each JMS management script procedure is located in...
WAS_HOME/scriptLibraries/resources/JMS/V70
The Jython script library provides script functions for J2C resources, JDBC providers, and JMS resources at the server scope. You can write the own custom scripts to configure resources at the cell, node, or cluster level.
Do not edit the script procedures in the script library. To write custom script library procedures, use the scripts in the WAS_HOME/scriptLibraries directory as Jython syntax samples. Save the custom scripts to a new subdirectory to avoid overwriting the library.
Use the following script procedures to query the JMS configurations:
- listGenericJMSConnectionFactories
- listGenericJMSConnectionFactoryTemplates
- listGenericJMSDestinations
- listGenericJMSDestinationTemplates
- listJMSProviders
- listJMSProviderTemplates
- listWASQueueConnectionFactoryTemplates
- listWASQueueTemplates
- listWASTopicConnectionFactoryTemplates
- listWASQueueConnectionFactories
- listWASQueues
- listWASTopicConnectionFactories
- listWASTopics
- listWASTopicTemplates
listGenericJMSConnectionFactories
This script displays a list of configuration IDs for the generic JMS connection factories configured in the environment. The script does not require any input parameters.
Table 1. Argument for the listGenericJMSConnectionFactories script
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
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 the 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
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
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 the 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
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
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
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
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
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 the 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
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
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 the 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
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 the 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
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
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")
Related tasks
Use the script library to automate the application serving environment
Related
JMS configuration scripts
JDBC configuration scripts
JDBC query scripts