Skip Headers
Oracle® Fusion Middleware Configuring and Managing JMS for Oracle WebLogic Server
12c Release 1 (12.1.1)

Part Number E24385-04
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

6 Using WLST to Manage JMS Servers and JMS System Module Resources

This chapter describes how to use the WebLogic Scripting Tool (WLST), a command-line scripting interface, to create and manage JMS servers and JMS system module resources. See "Using the WebLogic Scripting Tool" and "WLST Sample Scripts" in Oracle WebLogic Scripting Tool.

Understanding JMS System Modules and Subdeployments

A JMS system module is described by the jms-system-resource MBean in the config.xml file. Basic components of a jms-system-resource MBean are:

The JMS resources of a system module are located in a module descriptor file that conforms to the weblogic-jmsmd.xml schema. In Figure 6-1, the module is named myModule-jms.xml and it contains JMS system resource definitions for a connection factory and a queue. The sub-deployment-name element is used to group and target JMS resources in the myModule-jms.xml file to targets in the config.xml. You have to provide a value for the sub-deployment-name element when using WLST. For more information on subdeployments, see Chapter 3, "JMS System Module and Resource Subdeployment Targeting." In Figure 6-1, the sub-deployment-name DeployToJMSServer1 is used to group and target the connection factory CConfac and the queue CQueue in the myModule-jms module.

For more information on how to use JMS resources, see Chapter 2, "What Are JMS Configuration Resources?."

Figure 6-1 Subdeployment Architecture

Description of Figure 6-1 follows
Description of "Figure 6-1 Subdeployment Architecture"

How to Create JMS Servers and JMS System Module Resources

Basic tasks you need to perform when creating JMS system resources with WLST are:

After you have established an edit session, use the following steps configure JMS servers and system module resources:

  1. Get the WebLogic Server MBean object for the server you want to configure resources. For example:

    servermb=getMBean("Servers/examplesServer")
        if servermb is None:
            print '@@@ No server MBean found'
    
  2. Create your system resource. For example:

    jmsMySystemResource = create(myJmsSystemResource,"JMSSystemResource")
    
  3. Target your system resource to a WebLogic Server instance. For example:

    jmsMySystemResource.addTarget(servermb)
    
  4. Get your system resource object. For example:

    theJMSResource = jmsMySystemResource.getJMSResource()
    
  5. Create resources for the module, such as queues, topics, and connection factories. For example:

    connfact1 = theJMSResource.createConnectionFactory(factoryName)
    jmsqueue1 = theJMSResource.createQueue(queueName)
    
  6. Configure resource attributes. For example:

    connfact1.setJNDIName(factoryName)
    jmsqueue1.setJNDIName(queueName)
    
  7. Create a subdeployment name for system resources. See Understanding JMS System Modules and Subdeployments. For example:

    connfact1.setSubDeploymentName('DeployToJMSServer1')
    jmsqueue1.setSubDeploymentName('DeployToJMSServer1')
    
  8. Create a JMS server. For example:

    jmsserver1mb = create(jmsServerName,'JMSServer')
    
  9. Target your JMS server to a WebLogic Server instance. For example:

    jmsserver1mb.addTarget(servermb)
    
  10. Create a subdeployment object using the value you provided for the sub-deployment-name element. This step groups the system resources in module to a sub-deployment element in the config.xml. For example:

    subDep1mb = jmsMySystemResource.createSubDeployment('DeployToJMSServer1')
    
  11. Target the subdeployment to a server resource such as a JMS server instance, WebLogic Server instance, or cluster. For example:

    subDep1mb.addTarget(jmsserver1mb)
    

Example 6-1 WLST Script to Create JMS System Resources

"""
This script starts an edit session, creates a JMS Server, 
targets the jms server to the server WLST is connected to and creates
a JMS System module with a jms queue and connection factory. The 
jms queues and topics are targeted using sub-deployments. 
"""

import sys
from java.lang import System

print "@@@ Starting the script ..."

myJmsSystemResource = "CapiQueue-jms"
factoryName = "CConFac"
jmsServerName = "myJMSServer"
queueName = "CQueue"

url = sys.argv[1]
usr = sys.argv[2]
password = sys.argv[3]

connect(usr,password, url)
edit()
startEdit()

//Step 1
servermb=getMBean("Servers/examplesServer")
    if servermb is None:
        print '@@@ No server MBean found'

else:
    //Step 2
    jmsMySystemResource = create(myJmsSystemResource,"JMSSystemResource")

    //Step 3
    jmsMySystemResource.addTarget(servermb)

    //Step 4
    theJMSResource = jmsMySystemResource.getJMSResource()

    //Step 5
    connfact1 = theJMSResource.createConnectionFactory(factoryName)
    jmsqueue1 = theJMSResource.createQueue(queueName)

    //Step 6
    connfact1.setJNDIName(factoryName)
    jmsqueue1.setJNDIName(queueName)

    //Step 7
    jmsqueue1.setSubDeploymentName('DeployToJMSServer1')  
    connfact1.setSubDeploymentName('DeployToJMSServer1')

    //Step 8
    jmsserver1mb = create(jmsServerName,'JMSServer')

    //Step 9
    jmsserver1mb.addTarget(servermb)

    //Step 10
    subDep1mb = jmsMySystemResource.createSubDeployment('DeployToJMSServer1')

    //Step 11
    subDep1mb.addTarget(jmsserver1mb)
.
.
.

How to Modify and Monitor JMS Servers and JMS System Module Resources

You can modify or monitor JMS objects and attributes by using the appropriate method available from the MBean.

For more information, see "Navigating MBeans (WLST Online)" in Oracle WebLogic Scripting Tool.

Example 6-2 WLST Script to Modify JMS Objects

.
.
print '@@@ delete system resource'
jmsMySystemResource = delete("CapiQueue-jms","JMSSystemResource")
print '@@@ delete server'
jmsserver1mb = delete(jmsServerName,'JMSServer')
.
.
.

Best Practices when Using WLST to Configure JMS Resources

This section provides best practices information when using WLST to configure JMS servers and JMS system module resources: