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

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:

• name—Name of the module.

• target—Server, cluster, or migratable target the module is targeted to.

• sub-deployment—A mechanism by which JMS system module resources (such as queues, topics, and connection factories) are grouped and targeted to a server resource (such as a JMS server instance, WebLogic server instance, or cluster).

• descriptor-file-name—Path and filename of the system module file.

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 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:

• Start an edit session.

• Create a JMS system module that includes JMS resources, such as queues, topics, and connection factories.

• Create JMS server resources.

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)
    

"""
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.

• You can modify JMS objects and attributes using the set, target, untarget, and delete methods.

• You can monitor JMS runtime objects using get methods.

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

.
.
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:

• Trap for Null MBean objects (such as servers, JMS servers, modules) before trying to manipulate the MBean object.

• Use a meaningful name when providing a subdeployment name. For example, the subdeployment name DeployToJMSServer1 tells you that all subdeployments with this name are deployed to JMSServer1.