This topic contains sections marked as revised for this release

WebSphere Message Brokers
File: af03890_
Writer: John Morris-Smith

Task topic

This build: July 31, 2007 21:29:18

Deploying a broker archive file

Before you start:

This task explains how to deploy your broker archive (bar). If you have not already created a bar file, create it now.

You can deploy a broker archive in three ways:

You can also redeploy a broker archive file using these three methods; for further information, see Redeploying a broker archive file.

If the execution group to which you want to deploy is restricted by an ACL, you must have appropriate access rights to complete this task.

Using the Message Broker Toolkit

Follow these steps to deploy a bar file using the workbench:

  1. Switch to the Broker Administration perspective.
  2. Optional. Typically, an incremental bar file deployment is performed. To perform a complete bar file deployment, right-click the target execution group in the Domains view and select Remove Deployed Children. Wait for the operation to complete before continuing.

    You do not have to remove deployed children if you only want to refresh one or more of them with the contents of the bar file. The Message flow application deployment topic explains the difference between a complete and an incremental bar file deployment.

  3. Click the bar file shown in the Navigator view to highlight it.
  4. Drag the file onto your target execution group shown in the Domains view.

    Alternatively, right-click the bar file and click Deploy file. A dialog box shows all the domains, as well as execution groups within those domains to which the workbench is connected. A dialog box shows the execution groups (within their domains) to which you can deploy the bar file. Select an execution group and click OK to deploy the bar file. (If you select a broker topology that is not connected to a domain, an attempt is made to connect it. If you click Cancel, the broker topology remains unconnected to a domain.)

    Whichever method you use, you can select (and deploy to) only one execution group at a time.

  5. If the bar file has not been saved since it was last edited, you are asked whether you want to save it before deploying. If you click Cancel, the bar file is not saved and deployment does not take place.
The bar file is transferred to the Configuration Manager, which deploys the file contents (message flows and message sets, for example) to the execution group. In the Domains view, the assigned message flows and message sets are added to the appropriate execution group.

Next:

Continue by checking the results of the deployment.

Using the mqsideploy command

Follow these steps to deploy a bar file using the mqsideploy command:

  1. Open a command window that is configured for your environment.
  2. Using the examples below, enter the appropriate command:
    On distributed platforms:
    mqsideploy -i ipAddress -p port -q qmgr -b broker -e exngp -a barfile

    This command performs an incremental deployment. Add the –m parameter to perform a complete bar file deployment.

    The -i (IP address), -p (port), and -q (queue manager) parameters represent the connection details of the queue manager computer.

    You must also specify the -b (broker name), -e (execution group name), and -a (bar file name) parameters.

    On z/OS
    /f MQ01CMGR,dp b=broker e=exngp a=barfile

    This command performs an incremental deployment. Add the m=yes parameter to perform a complete bar file deployment.

    In this example, MQ01CMGR is the name of the Configuration Manager component. You must also specify the names of the broker, execution group, and bar file (the b=, e=, and a= parameters).

Next:

Continue by checking the results of the deployment.

Using the Configuration Manager Proxy API

Use the deploy method of the ExecutionGroupProxy class. By default, the deploy method performs an incremental deployment. To perform a complete deployment, use a variant of the method that includes the Boolean isIncremental parameter. Setting this to false indicates a complete deployment. Setting it to true indicates an incremental deployment.

For example:
import com.ibm.broker.config.proxy.*;
import java.io.IOException;

public class DeployBar {
  public static void main(String[] args) {
    ConfigManagerConnectionParameters cmcp = new MQConfigManagerConnectionParameters
			("localhost", 1414, "QM1");
    try {
      ConfigManagerProxy cmp = ConfigManagerProxy.getInstance(cmcp);
      TopologyProxy t = cmp.getTopology();
      BrokerProxy b = t.getBrokerByName("BROKER1");
      ExecutionGroupProxy e = b.getExecutionGroupByName("default");
      e.deploy("deploy.bar");
    }
    catch (ConfigManagerProxyException cmpe) {
      cmpe.printStackTrace();
    }
    catch (IOException ioe) {
      ioe.printStackTrace();
    }
  }
} 

Next:

Continue by checking the results of the deployment.

Redeploying a broker archive file

If you make changes to a bar file, and want to propagate those changes to one or more brokers, you can redeploy the updated bar file to one or more execution groups, using any of the deploy methods described above. You do not have to stop the message flows that you deployed previously; all resources in the execution group or groups that are in the redeployed bar file are replaced and any new resources are applied.

If your updates to the bar file include the deletion of resources, a redeploy does not result in their deletion from the broker. For example, assume your bar file contains message flows F1, F2, and F3. You update the file by removing F2 and adding message flow F4. If you redeploy the bar file, when the redeployment has completed, all four flows are available in the execution group. F1 and F3 are replaced by the content of the redeployed bar file.

If you want to clear resources from the execution group that you previously deployed before you redeploy, perhaps because you are deleting resources, use either the mqsideploy command with the option -m -complete or the appropriate CMP deploy method for the execution group. If you prefer to use the Message Broker Toolkit, select the execution group or groups, click Remove deployed children, and then deploy.

If your message flows are not transactional, you might consider stopping those message flows before you redeploy. Stop the flows if you want to be sure that all the applications complete cleanly, and are in a known and consistent state. You can stop individual message flows, execution groups, or brokers.

If your message flows are transactional, the processing logic that handles commitment or rollback ensures that resource integrity and consistency are maintained.

Next:

Continue by checking the results of the redeployment.

Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:29:18

af03890_ This topic's URL is: