3 Managing Service Broker Domains

This chapter describes how to manage domains using the Administration Console and Java MBeans:

• Introduction to Service Broker Domain Management

• Mapping Custom Server Names to Service Broker Server Names

• Setting a Service Broker Domain Name

• Managing Domain Bundles

• Managing Domain Servers

• Managing Processing Domain Groups

Introduction to Service Broker Domain Management

A set of Processing Servers are grouped into a Processing Domain and a set of Signaling Servers are grouped into a Signaling Domain.

Servers within a domain are symmetrical, which means that they all have the same software bundles deployed and started.

Domain management includes the following tasks:

• Mapping custom server names to server names required by Service Broker

  To operate properly, Service Broker imposes certain requirements on naming servers in the Signaling Domain and Processing Domain. If you want to specify your own custom server names that do not follow these patterns, you need to map custom server names to names that follow the pattern required by Service Broker.

  For more information, see "Mapping Custom Server Names to Service Broker Server Names".

• Setting the Service Broker domain name

  When you create a domain, you must assign a unique name to the domain, in addition to the domain name that you already defined when you created the domain.

  For more information, see "Setting a Service Broker Domain Name".

• Managing domain bundles

  When you create a domain, the domain's bundles are copied to a domain directory. You can define which of the bundles in the domain directory are relevant to your specific deployment.

  For more information, see "Managing Domain Bundles".

• Managing domain servers

  Servers within a domain execute the software bundles that you install in your domain. Each Signaling Server and Processing Server has a set of server-unique settings that identifies the server in the domain.

  For more information, see "Managing Domain Servers".

• Managing Processing Domain Groups (PDGs)

  In a Multi-Processing Domain deployment, Processing Domains can be grouped into a Processing Domain Group (PDG), based on a shared functionality among different Processing Domains. This task can be performed only in the Signaling Domain.

  For more information, see "Managing Processing Domain Groups".

Mapping Custom Server Names to Service Broker Server Names

To operate properly, Service Broker imposes the following requirements on naming servers in the Signaling Domain and Processing Domain:

• Names of Signaling Servers must follow the pattern "ssu_<server-number>". For example, the following names are valid: ssu_1, ssu_2, ssu_3.

• Names of Processing Servers must follow the pattern "pn_<server-number>". For example, the following names are valid: pn_1, pn_2, pn_3.

During the installation, if you specified custom server names that do not follow these patterns, you need to map custom server names to names that follow the pattern required by Service Broker. You can perform this mapping using ServersMBean and ServerMBean.

The hierarchy of the MBeans is shown on Figure 3-1.

Figure 3-1 ServersMBean Hierarchy

For more information, see ServersMBean and ServerMBean.

Setting a Service Broker Domain Name

After you created a domain, in addition to the name that you assigned to a domain during its creation, you must assign a Service Broker domain name to it.

A Service Broker domain name is a unique string name.

You can set the Service Broker domain name using MBeans only. To set it, set the SbDomainName attribute in the SystemMBean MBean.

Managing Domain Bundles

The settings of each OSGi Bundle identify the bundle in the domain. Table 3-1 describes OSGi Bundle properties.

Table 3-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 Java MBeans

Managing Bundles with the Administration Console

To access the Bundles Configuration screen:

• In the Domain Navigation pane, expand OCSB and do one of the following:

  • Expand Signaling Tier > Domain Management and select Packages

  • Expand Processing Tier > Domain Management and select Packages

The Packages Configuration pane displays the properties described in Table 3-1.

Typing a Package name into the Filter text 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 field, type the location from where you extracted the bundle.

3. In the Start Level, 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 checkbox 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 checkbox 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 checkbox corresponding to the bundle you want to stop.

2. Click Stop.

Managing Bundles with Java MBeans

You can manage OSGi Bundles through JMX, using the DeploymentServiceMBean. For more information, see the MBean DeploymentServiceMBean in the chapter "Upgrading and Patching" in Oracle Communications Server Broker System Administrator's Guide.

Managing Domain Servers

Each Signaling Server and Processing Server has a set of server-unique settings that identifies the server in the domain. Table 3-2 describes server properties.

Table 3-2 Server Properties

Property	Description
Name	The name of the server. The name must be unique across all domains. Format: alpha-numeric characters. Case-sensitive. No white spaces. Do not use white space in the name.
Host	The host name or IP-address of the machine where the server runs. Format: alpha-numeric. IP-address format or DNS name format.
Port	The IP port to use for the server when it is at RUNNING level. Format: numeric.
Jmx Jrmp Port	The port to use for Java Remote Method Protocol (JRMP) invocations to the server. Format: numeric.
Jmx Registry	The port to use for the MBean Server on the server. Format: numeric.
Admin Port	The IP port to use for the server when it is at SAFE level. This is the port used for configuration when the server is starting up. Format: numeric

The following sections describe how you can manage domain servers using the Administration Console and the Java MBeans.

• Managing Servers with the Administration Console

• Managing Servers with Java MBeans

Managing Servers with the Administration Console

To access the Server Configuration screen:

• In the Domain Navigation pane, expand OCSB and do one of the following:

  • Expand Signaling Tier > Domain Management and select Servers

  • Expand Processing Tier > Domain Management and select Servers

The Servers Configuration pane displays the properties described in Table 3-2.

Typing a server name into the Filter text field displays a filtered list of servers.

Adding a Server to a Domain Configuration

Before you add a server to the Domain Configuration, you have to install the Service Broker software on that server. See Oracle Communications Service Broker Installation Guide for instructions.

To add a server to a domain:

1. In the Servers List screen, click the New button.

   The Add Server dialog box is displayed.

2. Type the relevant information into the respective fields. (For details, see Table 3-2.)

3. Click Apply.

Removing a Server from a Domain Configuration

Before you remove a server from the Domain Configuration you have to stop the server. For more information about stopping servers, see "Stopping a Server".

To remove a server from the domain:

1. In the Servers screen, in the list of servers, select the checkbox corresponding to the server you want to remove.

2. Click Delete.

Stopping a Server

To stop a server in a domain:

1. In the Servers screen, in the list of servers, select the checkbox corresponding to the server that you want to stop.

2. Click the Stop button.

Managing Servers with Java MBeans

You can manage domain servers through JMX, using the DomainServiceMBean. For more information, see the MBean DomainServiceMBean in the chapter "Managing Domains" in Oracle Communications Server Broker System Administrator's Guide.

Managing Processing Domain Groups

Note:

You can define Processing Domain Groups only in Signaling Domains.

In a Multi-processing Domain deployment, domains can be grouped into a Processing Domain Group (PDG), based on a shared functionality among different Processing Domains.

You can configure SSUs to route sessions to PDGs. For more information, see "Configuring Incoming Routing Rules Parameters" in:

• Configuring SS7 Signaling Server Units for SIGTRAN

• Configuring SS7 Signaling Server Units for TDM

• Configuring SIP Signaling Server Units

• Configuring Diameter Signaling Server Units

Domains in a PDG share traffic load, so that traffic, routed by an SSU to a PDG, is distributed among the domains in the PDG. When you add a domain to a PDG, you assign a weight to it to indicate the relative load of traffic that it takes.

Table 3-3 describes the subtabs in the PDGs Configuration screen.

Table 3-3 Processing Domain Groups Subtabs

Tab	Description
Domain Groups	Enables you to create and remove PDGs.
Domains	Enables you to specify Processing Domains that belong to a PDG that you previously created in the Domain Groups tab. It also enables you define a weight to each Processing Domain, indicating the traffic load that it takes relatively to the total traffic load handled by the PDG.

The following sections describe how you can configure Processing Domain Groups (PDGs) using the Administration Console and the Java MBeans.

• Managing Processing Domain Groups with the Administration Console

• Configuring Processing Domain Groups with Java MBeans

Managing Processing Domain Groups with the Administration Console

To access the Processing Domain Groups Configuration screen:

• In the Domain Navigation pane, expand OCSB > Signaling Tier > Domain Management and select Processing Domain Groups.

  The Processing Domain Configuration pane displays the two subtabs described in Table 3-3.

You use the Domain Groups subtab to create or remove PDGs.

Table 3-4 describes the fields you define to create a PDG.

Table 3-4 Domain Groups Parameters

Name	Type	Description
Name	STRING	A unique system-internal PDG identifier.
Group Name	STRING	Specifies the name of the PDG you want to create. It is recommended that you use the same name you specified in the Name field. Note: when you configure SSUs to route incoming messages to PDGs, this is the PDG name that you use.

After you create PDGs, you use the Domains subtab to define the Processing Domains that belong to each PDG.

The PDGs you created are displayed in the Parent drop-down list. You now need to select a PDG and then specify the Processing Domains you want to include in the PDG. For each Processing Domain that you add, you also set the weight for traffic load.

Table 3-5 describes the fields in which you define Processing Domains and their properties.

Table 3-5 Domains Properties

Name	Type	Description
Name	STRING	A unique system-internal Processing Domain identifier.
Domain Name	STRING	Enables you to specify the name of the domain that you add to a PDG. This must be the domain name as was specified in the SbDomainName attribute of the SystemMBean MBean.
Weight	INTEGER	Enables you to specify the proportion of traffic routed to each Processing Domain within a group.

Adding Processing Domain Groups

To add a Processing Domain to a Processing Domain Group:

1. In the Domain Groups subtab, click New.

2. In the New Domain Groups dialog box, define the fields described in Table 3-4.

3. Click Apply.

   Each Processing Domain Group you create appears in a list under the Domain Groups subtab.

Removing Processing Domain Groups

To remove a Processing Domain Group:

1. In the Domain Groups subtab, select the checkbox corresponding to the Processing Domain Group you want to remove.

2. Click Delete.

   The Processing Domain Group is deleted. The Processing Domains this group supported are no longer grouped.

Adding Domains to a Processing Domains Group

1. In the Domains subtab, click the Parent drop-down list and select the Processing Domain Group to which you want to add a Processing Domain.

2. Click New.

   In the Domain dialog box, define the fields described in Table 3-5.

3. Click Apply.

Removing Domains from a Processing Domains Group

1. In the Domains subtab, select the checkbox corresponding to the Processing Domain you want to remove.

2. Click Delete.

   The Processing Domain is removed from the group.

Configuring Processing Domain Groups with Java MBeans

You can configure Processing Domain Groups through JMX, using the MBeans shown on Figure 3-2.

Figure 3-2 DomainGroupsMBean Hierarchy

For more information, see DomainGroupsMBean, DomainGroupMBean, and DomainMBean.

---

DomainGroupsMBean

DomainGroupsMBean is a root MBean for managing domain groups.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getDomainGroups()

Returns a list of DomainGroupMBean instances

ObjectName createDomainGroup()

Creates a new instance of DomainGroupMBean

void destroyDomainGroup()

Destroys an existing instance of DomainGroupMBean

ObjectName lookupDomainGroup()

Returns a specified instance of DomainGroupMBean

---

DomainGroupMBean

DomainGroupMBean enables you to define a domain group name and manage domains within this domain group. Each DomainGroupMBean represents one domain group.

Factory Method

DomainGroupsMBean.createDomainGroup()

Attributes

GroupName

For more information about this attribute, see Table 3-4.

Operations

ObjectName[] getDomains()

Returns a list of DomainMBean instances

ObjectName createDomain()

Creates a new instance of DomainMBean

void destroyDomain()

Destroys an existing instance of DomainMBean

ObjectName lookupDomain()

Returns a specified instance of DomainMBean

---

DomainMBean

DomainMBean enables you to configure domains.

Factory Method

DomainGroupMBean.createDomain()

Attributes

• DomainName

• Weight

For more information on these attributes, see Table 3-5.

Operations

None

---

ServersMBean

ServersMBean is a root MBean for configuration of mapping between custom names that you specify for Signaling and Processing Servers and server names that follow the patterns required by Service Broker.

Factory Method

Created automatically.

Attributes

Table 3-6 ServersMBean Attributes

Name	Type	Description
Name	STRING	Specifies a name of the mapping configuration
MaxServerNumber	INT	Specifies a maximum number of servers whose names are to be mapped

Operations

ObjectName createServer()

Creates an instance of ServerMBean

void destroyServer()

Destroys an instance of ServerMBean

ObjectName[] getServer()

Gets an array of references to instances of ServerMBean

ObjectName lookupServer()

Returns a specified instance of ServerMBean

---

ServerMBean

ServerMBean enables you to map a custom name of one server to a server name which follows the pattern required by Service Broker.

Factory Method

Servers.createServer()

Attributes

Table 3-7 ServerMBean

Name	Type	Description
ManagedServerName	STRING	Specifies the custom server name that you specified during server installation.
SbServerName	STRING	Specifies a name that follows the pattern required by Service Broker.
SbServerId	STRING	Specifies a unique ID that the server uses when generating TCAP messages. The ID must be unique across all domains.

Operations

None