15 Upgrading and Patching Service Broker

This chapter describes how you upgrade your installation and how to apply patches. It also describes the DeploymentServiceMBean.

About Patches and Patch Sets

A patch is always associated with a specific OSGi bundle, whereas a patch set is not associated with one specific bundle and might contain a collection of unrelated patches. A patch or patch set can be targeted to a specific bundle or to a server. The delivery format is ZIP files.

The patches and patch sets are either delivered with a bundled copy of Oracle Universal Installer or as a input file to be used with a standard installation of Oracle Universal Installer.

Overview of Performing an In-Production Upgrade

An in-production upgrade means that Oracle Communications Service Broker is upgraded while continuing to process requests. Servers are upgraded one at a time, in sequential order, until all servers have been upgraded. Service Broker continues to process requests during the upgrade.

During the upgrade procedure, all servers except the server currently being upgraded continue to process traffic. During the upgrade procedure, one set of servers is still on pre-upgrade level, while another set is on post-upgrade level.

To perform an in-production upgrade:

1. Back up your Processing Servers, Signaling Servers, and domain configurations prior to performing an upgrade. See "Maintaining Oracle Communications Service Broker" for details.

2. Do one of the following according to whether the patch is for a bundle or for a server:

   • Patch is for a bundle: Apply the patch to the domain configuration. See "Applying Patches for Bundles" for details.

   • Patch is for a server: Apply the patch to each server. See "Applying Patches for Servers" for details.

3. On each server:

   Perform a controlled shutdown of the server and start it again. See "Starting and Stopping Processing Servers and Signaling Servers".

Applying Patches for Bundles

To install a patch or a patch set for a bundle:

1. Log in to the computer where the Administration Console is installed.

2. Unzip the ZIP file to the directory patch_directory.

   patch_directory can be any directory.

3. Do one of the following according to whether the patch or patch set is bundled with Oracle Universal Installer:

   Bundled with Oracle Universal Installer:

   1. In a command shell, navigate to the installer directory:

      patch_directory/Disk1/install

   2. Enter the following command to launch the installer:

      ./runInstaller.sh

      The Oracle Universal Installer is launched in graphical mode.

   Not bundled with Oracle Universal Installer:

   1. Start a local copy of Oracle Universal Installer.

   2. In Oracle Universal Installer, open the file

      patch_directory/Disk1/install/product.xml

4. Follow the instructions in the installer. Use the same Oracle_home you used when you installed Oracle Communications Service Broker.

   When the installer is finished, the patch bundle(s) are installed in the directory:

   Oracle_home/patch

5. Set the domain configuration to offline by setting the attribute OffLine on the DomainServiceMBean to true. See the discussion on creating the domain in Service Broker Installation Guide for details.

6. Uninstall the bundle(s) you want to update using the operation uninstallBundle in DeploymentServiceMBean method. See "DeploymentServiceMBean".

7. Install the updated bundle(s) using the operation installBundle in DeploymentServiceMBean. See "DeploymentServiceMBean".

Now the domain configuration is updated and the next step is to apply the updated configuration to the servers in the domain by restarting them one by one.

Applying Patches for Servers

To install a patch or a patch set for a server:

1. Log in to the computer where the server to be patched is installed.

2. Unzip the ZIP file to the directory patch_directory.

   patch_directory can be any directory.

3. If the patch or patch set is bundled with Oracle Universal Installer:

   1. In a command shell, navigate to the installer directory:

      patch_directory/Disk1/install

   2. Enter the following command to launch the installer:

      ./runInstaller.sh

      The Oracle Universal Installer is launched in graphical mode.

4. If the patch or patch set is not bundled with Oracle Universal Installer:

   1. Start a local copy of Oracle Universal Installer.

   2. In Oracle Universal Installer, open the file

      patch_directory/Disk1/install/product.xml

5. Follow the instructions in the installer. Use the same Oracle_home you used when you installed Oracle Communications Service Broker.

When the installer is finished, the server is updated with the patch or patch set. The server needs to be restarted.

Managing Domain Bundles

The settings of each OSGi Bundle identify the bundle in the domain.

Table 15-1 describes OSGi Bundle properties.

Table 15-1 OSGi Bundle Properties

Property	Description
Name	Symbolic name of the OSGi bundle. Format: Alpha-numeric characters. Case sensitive. No spaces in the name.
Version	Version number of the bundle. Format: Alpha-numeric. IP-address form or DNS name format.
State	The state of the bundle: Installed Prepare Start Start
Start Level	OSGi start level of the bundle Format: Numeric

The following sections describe how you can manage OSGi bundles with the Administration Console and Java MBeans.

• Managing Bundles with the Administration Console

• Managing Bundles with the DeploymentServiceMBean

Managing Bundles with the Administration Console

To access the Bundles Configuration screen:

1. In the domain navigation pane, expand OCSB and do one of the following:

   • Expand Signaling Tier and then expand Domain Management

   • Expand Processing Tier and then expand Domain Management

2. Select Packages.

The Packages configuration pane displays the properties described in Table 15-1.

Typing a package name into the Filter field displays a filtered list of packages.

Installing a Bundle

Before you install a bundle in the domain, you must extract a copy of the bundle in the Domain Configuration Directory.

To install a bundle:

1. In the Bundles screen, click Install.

   The Install dialog box is displayed.

2. In the Location column, type the location from where you extracted the bundle.

3. In the Start Level column, type a digit to indicate the level, then click Apply.

   The new OSGi Bundle now appears in the Bundle list.

Uninstalling a Bundle

Before you uninstall a bundle, you have to stop the bundle. See "Stopping a Bundle" for instructions.

To uninstall a bundle:

1. From the Bundle list, select the check box corresponding to the bundle you want to uninstall.

2. Click Uninstall.

   The selected OSGi Bundle is removed from the list. The bundle is not deleted from the Configuration Directory.

Starting a Bundle

To start a bundle:

1. In the Bundle list, select the check box corresponding to the bundle you want to start.

2. Click Start.

Stopping a Bundle

To stop a bundle:

1. In the Bundle list, select the check box corresponding to the bundle you want to stop.

2. Click Stop.

Managing Bundles with the DeploymentServiceMBean

You can manage OSGi Bundles through JMX using the DeploymentServiceMBean, which exposes operations for installing and deploying these bundles. See "DeploymentServiceMBean" for details on using this MBean.

---

DeploymentServiceMBean

The DeploymentServiceMBean provides operations for OSGi bundle management.

JAR File

oracle.axia.deployment.adminservice.api-version.jar

version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.api.management.deployment

Object Name

oracle:type=oracle.axia.api.management.deployment.DeploymentServiceMBean

Factory Method

Created automatically.

Attributes

None

Operations

String[] deployBundle(String bundleLocation, int startLevel)

Installs and starts an OSGi bundle.

Parameters:

• bundleLocation Path to the bundle to deploy.

• startLevel OSGi start level of the bundle.

String[] installBundle(String bundleLocation, int startLevel)

Installs an OSGi bundle.

Parameters:

• bundleLocation Path to the bundle to deploy.

• startLevel OSGi start level of the bundle.

List<Map<String,Serializable>>listDeployedBundles()

List a all deployed OSGi bundles.

void startBundle(String bundleName, String bundleVersion)

Starts an OSGi bundle.

Parameters:

• bundleName Symbolic name of the OSGi bundle.

• bundleVersion Version of the bundle.

void stopBundle(String bundleName, String bundleVersion)

Stops an OSGi bundle.

Parameters:

• bundleName Symbolic name of the OSGi bundle.

• bundleVersion Version of the bundle.

void undeployBundle(String bundleName, String bundleVersion)

Undeploys an OSGi bundle.

Parameters:

• bundleName Symbolic name of the OSGi bundle.

• bundleVersion Version of the bundle.

void uninstallBundle(String bundleName, String bundleVersion)

Uninstalls an OSGi bundle.

Parameters:

• bundleName Symbolic name of the OSGi bundle.

• bundleVersion Version of the bundle.

void updateBundle(String bundleName, String bundleVersion, String bundleLocation)

Updates an installed OSGi bundle with a bundle stored on the file system.

Parameters:

• bundleName Symbolic name of the OSGi bundle.

• bundleVersion Version of the bundle.

• bundleLocation Path to the update OSGi bundle.