9 Configuring SIP Signaling Server Units

The following sections describe how to configure Service Broker SIP SSUs using the Service Broker Administration Console and Java MBeans:

Configuring SIP SSU with the Administration Console
Configuring SIP SSU with Java MBeans

Configuring SIP SSU with the Administration Console

This section describes how to configure the SIP SSU using the Service Broker Administration Console.

The configuration process includes setting up parameters on the subtabs described in Table 9-1.

Table 9-1 SIP SSUs Subtabs

Subtab	Description
SIP Server	Enables you to set up a Globally-Routable User Agent URI (GRUU). For more information, see "SIP Server".
Incoming Routing Rules	Enables you to define how the SIP SSU routes incoming SIP messages to internal Service Broker IMs. For more information, see "Incoming Routing Rules".
SIP Network Entities	Enables you to define a list of SIP network entities with which the SIP SSU communicate. For more information, see "SIP Network Entities".
Network Access	Enables you to define SIP network channels that the SIP SSU uses to listen to incoming connections. For more information, see "Network Access".

To access the SIP SSU configuration screen:

In the Domain Navigation pane, select OCSB > Signaling Tier > SSU SIP. The SSU SIP Configuration screen is displayed in the Configuration pane.

SIP Server

The SIP Server subtab enables you to set up a Globally-Routable User Agent URI (GRUU).

Table 9-2 describes configuration parameters on the SIP Server subtab.

Table 9-2 SIP Server Parameter

Name	Type	Description
Globally Routable User Agent URI	STRING	Specifies a SIP URI that the SIP SSU automatically inserts into Contact and Route-Set headers when communicating with network elements. For example: sip:sb@209.95.109.191:5060

Name

Type

Description

Globally Routable User Agent URI

STRING

Specifies a SIP URI that the SIP SSU automatically inserts into Contact and Route-Set headers when communicating with network elements.

For example: sip:sb@209.95.109.191:5060

Incoming Routing Rules

The Incoming Routing Rules subtab enables you to define how the SIP SSU routes incoming SIP messages to internal Service Broker IMs.

The Incoming Routing Rules subtab contains a table in which each row represents one routing rule. When configuring a routing rule, you need to specify the fields described in Table 9-3.

Table 9-3 Incoming Routing Rule Fields

Name	Type	Description
Name	STRING	Specifies a unique rule name
IP Address	STRING	Specifies an IP address by which a Service Broker IM is known to external entities. The SIP SSU routes incoming messages destined for this IP address to an IM, based on what you specify in the Alias parameter. Example: 192.168.0.101 You can set this field to Any. In this case, a routing rule applies to any SIP incoming message, regardless of its destination IP address. This value is generally used to define a default routing rule that ensures that the incoming SIP message is routed to a default IM, so long as no other routing rule has been applied.
Alias	STRING	Specifies a SIP URI of an IM to which the SIP SSU routes an incoming session. The alias has the following format: sip:<IM-instance-name>.<IM-type>@<domain-id> <IM-instance-name>: The IM instance name that you specified when you added this IM in the IM Management Configuration screen. <IM-type>: The type of the IM instance <domain-id>: The name of a Processing Domain or a Processing Domain Group where the relevant IM is deployed. To set a Processing Domain, you must specify the name you configured for the domain during its creation. For more information, see "Setting a Service Broker Domain Name". To set a Processing Domain Group, you must specify the group name. For more information about Processing Domain Groups, see "Managing Processing Domain Groups". Example: sip:r-imasf_instance.RIMASF@processing-domain-1

Name

Type

Description

Name

STRING

Specifies a unique rule name

IP Address

STRING

Specifies an IP address by which a Service Broker IM is known to external entities. The SIP SSU routes incoming messages destined for this IP address to an IM, based on what you specify in the Alias parameter.

Example: 192.168.0.101

You can set this field to Any. In this case, a routing rule applies to any SIP incoming message, regardless of its destination IP address. This value is generally used to define a default routing rule that ensures that the incoming SIP message is routed to a default IM, so long as no other routing rule has been applied.

Alias

STRING

Specifies a SIP URI of an IM to which the SIP SSU routes an incoming session.

The alias has the following format:

sip:<IM-instance-name>.<IM-type>@<domain-id>

<IM-instance-name>: The IM instance name that you specified when you added this IM in the IM Management Configuration screen.
<IM-type>: The type of the IM instance
<domain-id>: The name of a Processing Domain or a Processing Domain Group where the relevant IM is deployed.

To set a Processing Domain, you must specify the name you configured for the domain during its creation. For more information, see "Setting a Service Broker Domain Name".

To set a Processing Domain Group, you must specify the group name. For more information about Processing Domain Groups, see "Managing Processing Domain Groups".

Example:

sip:r-imasf_instance.RIMASF@processing-domain-1

SIP Network Entities

The SIP Network Entities subtab enables you to define a list of SIP network entities with which the SIP SSU communicate.

The SIP Network Entities subtab contains a table in which each row represents one SIP network entity. When configuring a SIP network entity, you need to specify the fields described in Table 9-4.

To provide a stable connection with a SIP network entity, the SIP SSU perform regular checks of the connection with the entity by using a heartbeat mechanism. The heartbeat mechanism enables the SIP SSU to check whether a SIP network entity is active or inactive, by periodically sending requests to the SIP network entity and checking the returned response.

After the SIP SSU triggers the heartbeat method, one of the following outcomes can happen:

The SIP network entity responds within the time defined in Response Timeout. This means that the SIP network entity is active. The SIP SSU continues periodically triggering the heartbeat method as specified by Active Interval.
The SIP network entity does not respond within the time defined in Response Timeout. This means the SIP network entity is inactive. The SIP SSU continues periodically triggering the heartbeat method as specified by Inactive Interval.

Table 9-4 SIP Network Entity Fields

Name	Type	Description
Name	STRING	Specifies a unique network entity name.
Alias	STRING	Specifies a name that Service Broker uses to refer the SIP network entity. The alias has a format of a SIP URI, including a loose routing indicator (;lr suffix). For example: sip:simple_b2b@example.com;lr
Heartbeat	STRING	Specifies whether or not to use a heartbeat mechanism over the connection with the SIP network entity. Possible values: ON OFF Default value: ON
URI	STRING	Specifies a SIP URI of the SIP network entity. For example: sip:simple_b2b@192.168.0.219:6060.
Heartbeat Method	STRING	Specifies the SIP method that the SIP SSU use to test the connection with the SIP network entity. Possible values: OPTIONS Default value: OPTIONS
Response Timeout	INT	Specifies the time interval, in seconds, during which the SIP SSU waits for response from the SIP network entity. This field is used by the heartbeat mechanism.
Active Interval	INT	Specifies the periodicity in seconds for sending heartbeat requests from the SIP SSU to the SIP network entity. This field is used if the previous heartbeat test showed that the SIP network entity is active.
Inactive Interval	INT	Specifies the periodicity in seconds for sending heartbeat requests from the SIP SSU to the SIP network entity. This field is used if the previous heartbeat test showed that the SIP network entity is inactive.

Network Access

The Network Access subtab enables you to define SIP network channels that the SIP SSU uses to listen to incoming connections.

The Network Access subtab contains a table in which each row represents one SIP network channel. When configuring a SIP network channel, you need to specify the fields described in Table 9-5.

Table 9-5 SIP Network Channel Fields

Name	Type	Description
Name	STRING	Specifies a name of a SIP network channel
Protocol	STRING	Specifies a protocol used for connections through the network channel Set this field to SIP.
Target	STRING	Specifies the name of the Signaling Server (JVM) that provides the SIP network channel
External Listen Address - Address Type	STRING	Specifies the Address Type of the SIP network external identity. Set this field to 'IP4'
External Listen Address - Host	STRING	Specifies the IP address or DNS name of the SIP network channel external identity
External Listen Address - Network Type	STRING	Specifies the network type of the SIP network channel external identity. Set this field to 'internet'.
External Listen Address - Port	STRING	Specifies the port of the SIP network channel external identity
Listen Address - Address Type	STRING	Specifies the Address Type of the SIP network channel internal identity. Set this field to 'IP4'.
Listen Address - Host	STRING	Specifies the IP address or DNS name of the SIP network channel internal identity
Listen Address - Network Type	STRING	Specifies the network type of the SIP network channel internal identity. Set this field to 'internet'.
Listen Address - Port	STRING	Specifies the port of the SIP network channel internal identity

Configuring SIP SSU with Java MBeans

Service Broker provides a set of MBeans that expose attributes and operations for configuring SIP SSU through JMX shown in Figure 9-1.

Figure 9-1 SIP SSU Configuration MBean Hierarchy

The following sections provide reference information for the SIP SSU configuration MBeans.

Note:

MBeans described in this guide may include additional advanced attributes, which are not described in the guide. Advanced attributes are reserved for internal use. Do not change these attributes.

SipSsuMBean

SsuSipBean is a root MBean for the SIP connectivity configuration

Factory Method

Created automatically

Attributes

GloballyRoutableUri

For more information on this attribute, see Table 9-2.

Operations

None

SipIncomingRoutingRulesMBean

SipIncomingRoutingRulesMBean is a container for instances of SipIncomingRoutingRuleMBean. Each instance of SipIncomingRoutingRuleMBean represents an individual incoming routing rule.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getSipIncomingRoutingRules()

Gets an array of references to instances of SipIncomingRoutingRuleMBean

ObjectName createSipIncomingRoutingRule()

Creates an instance of SipIncomingRoutingRuleMBean that enables you to configure an individual incoming rule

ObjectName lookupSipIncomingRoutingRule()

Returns the specified SipIncomingRoutingRuleMBean

void destroySipIncomingRoutingRule()

Destroys a SipIncomingRoutingRuleMBean

SipIncomingRoutingRuleMBean

Each instance of SipIncomingRoutingRuleMBean represents an individual incoming routing rule that defines how the SIP SSU routes incoming SIP messages to internal Service Broker IMs.

Factory Method

SipIncomingRoutingRules.createSipIncomingRoutingRule()

Attributes

Name
IpAddress
Alias

For more information on each of these parameters, see Table 9-3.

Operations

None

SipNetworkEntitiesMBean

SipNetworkEntitiesMBean is a container for instances of SipNetworkEntityMBean that represent individual network entities.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getSipNetworkEntity()

Gets an array of references to instances of SipNetworkEntityMBean

ObjectName createSipNetworkEntity()

Creates an instance of SipNetworkEntityMBean that enables you to configure an individual SIP network entity

ObjectName lookupSipNetworkEntity()

Returns a specified SipNetworkEntityMBean

void destroySipNetworkEntity()

Destroys an instance of SipNetworkEntityMBean

SipNetworkEntityMBean

Each instance of SipNetworkEntityMBean enables you to define a SIP network entity with which the SIP SSU communicate.

Factory Method

SipNetworkEntities.createSipNetworkEntity()

Attributes

Name
Alias
Heartbeat
Uri
HeartbeatMethod
ResponseTimeout
ActiveInterval
InactiveInterval

For more information on these attributes, see Table 9-4.

Operations

None

SipNetworkAccessPointsMBean

SipNetworkAccessPointsMBean enables you to define a set of SIP network channels, including addresses and ports, on which the SIP SSU listens.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getSipNetworkAccessPoints()

Gets an array of references to instances of SipNetworkPointMBean

ObjectName createSipNetworkAccessPoint()

Creates an instance of SipNetworkAccessPointMBean that enables you to configure an individual SIP network access point

ObjectName lookupSipNetworkAccessPoint()

Returns a specified SipNetworkAccessPointMBean

void destroySipNetworkAccessPoint()

Destroys an instance of SipNetworkAccessPointMBean

SipNetworkAccessPointMBean

SipNetworkAccessPointMBean enables you to configure a SIP network channel provided by the SIP SSU. You can create multiple instances of NetworkAccessPointMBean, one instance for each network channel.

Factory Method

SipNetworkAccessPoints.createSipNetworkAccessPoint()

Attributes

Name
Protocol
Target
ExternalListenAddressAddressType
ExternalListenAddressHost
ExternalListenAddressNetworkType
ExternalListenAddressPort
ListenAddressAddressType
ListenAddressHost
ListenAddressNetworkType
ListenAddressPort

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

Operations

None