19 Managing Supplementary Modules

This chapter describes how you can deploy, activate, and deactivate Oracle Communications Service Broker's supplementary modules in your deployment:

• Managing Supplementary Modules with the Administration Console

• Managing Supplementary Modules with JavaMBeans

Managing Supplementary Modules with the Administration Console

You can manage supplementary modules, including adding, activating, deactivating, and removing supplementary module instances, using the SM Configuration screen.

Accessing the SM Configuration Screen

To access the SM Configuration page:

• On the Domain Navigation pane, select OCSB > Processing Tier > Supplementary Modules > SM Management. The SM Configuration screen is displayed in the Configuration pane.

The SM Configuration screen displays a list of supplementary module instances deployed in the system. Information about each module instance is presented in the fields described in Table 19-1:

Table 19-1 Configuration Page Fields

Field	Description
Instance Name	Displays a name of the module instance
Module Type	Displays a type of the module instance. Possible values: SMLSS SMPME
Version	Displays a version of the module instance
State	Displays a state of the module instance. Possible values: Active Inactive

The SM Configuration screen enables you to perform the following actions:

• Add a new supplementary module instance.

• Activate a supplementary module instance.

• Deactivate a supplementary module instance.

• Remove a supplementary module instance.

  Note:

  After adding a new supplementary module, you must click the Commit button. You will be able to configure the module only after clicking Commit.

Managing Supplementary Modules with JavaMBeans

Service Broker provides a set of MBeans that expose attributes and operations for configuring supplementary modules through JMX shown on Figure 19-1.

Figure 19-1 Supplementary Modules Management MBean Hierarchy

The following sections provide reference information for the supplementary modules management configuration MBeans.

---

DeploymentsMBean

DeploymentsMBean is a container for instances of DeploymentMBean. Each instance of DeploymentMBean represents an individual supplementary module.

Factory Method

Created automatically

Attributes

None

Operations

void addDeployment(string ModuleName, string Version, string Name)

Adds a new instance of a supplementary module. Table 19-2 explains the parameters with which you need to invoke the operation.

Table 19-2 Parameters Required to Create a Deployment

Parameter	Description
ModuleName	Specifies a type of the module instance and a protocol that the module instance uses. Possible values: SMLSS SMPME
Version	Specifies a version of the module instance
InstanceName	Specifies a unique name for the new supplementary module instance.

void removeDeployment(string ModuleName, string Version, string ModuleInstanceName)

Removes an instance of a supplementary module. For more information on the parameters required for this operation, see Table 19-2.

void activateDeployment(string ModuleName, string Version, string ModuleInstanceName)

Activate an instance of a supplementary module. For more information on the parameters required for this operation, see Table 19-2.

void deactivateDeployment(string ModuleName, string Version, string ModuleInstanceName)

Deactivates an instance of a supplementary module. For more information on the parameters required for this operation, see Table 19-2.

---

DeploymentMBean

Each instance of DeploymentMBean represents an individual supplementary module and defines configuration parameters for this module.

Factory Method

Deployments.addDeployment()

Attributes

• DeploymentStatus

• Family

• Name

• Version

For more information on these attributes, see Table 19-1.

Operations

void activate()

Activates the instance of a supplementary module

void deactivate()

Deactivates the instance of a supplementary module