4 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 SSUs involves performing the tasks described in Table 4-1.

Table 4-1 SIP Signaling Server Configuration Tasks

Task	Description
SIP Server	Specifies a Globally-Routable User Agent URI (GRUU). See "Configuring the SIP Server" for more information.
Incoming Routing Rules	Specifies how the SIP SSU routes incoming SIP messages to internal Service Broker IMs and to applications external to OCSB. See "Configuring Incoming Routing Rules" for more information.
SIP Network Entities	Specifies a list of SIP network entities with which the SIP SSU communicate. See "Configuring SIP Network Entities" for more information.
Connection Pool	Specifies the connection that can be used to minimize communication overhead with SIP entities, such as Serving Call Session Control Function (S-CSCF). See "Configuring the SIP Connection Pool" for more information.
Network Access Points	Specifies the SIP network channels that the SIP SSU uses to listen to incoming connections. See "Configuring SIP Network Channels" for more information.
Header Insertion	Specifies how the SIP SSU inserts headers into SIP messages. See "Configuring Header Insertion Fields" for more information.

Configuring the SIP Server

You use the SIP Server tab to set up a Globally-Routable User Agent URI (GRUU).

To set up a GRUU:

In the navigation tree in the domain navigation pane, expand the Signaling Tier node.
Select SSU SIP.
In the SSU SIP configuration pane, click the SSU SIP tab and then the SIP Server subtab.
In the Globally Routable User Agent URI field, specify a SIP URI that the SIP SSU automatically inserts into Contact and Routeset headers when communicating with network elements.

For example: sip:sb@209.95.109.191:5060.
Click Apply.

Configuring Incoming Routing Rules

You use the Incoming Routing Rules tab to define how the SIP SSU routes incoming SIP messages to internal Service Broker IMs. The SIP SSU can also be used to route incoming SIP messages to applications that are external to OCSB, according to an application ID specified by the application developer.

To configure incoming routing rules for SIP messages:

In the navigation tree in the domain navigation pane, expand the Signaling Tier node.
Select SSU SIP.
In the SSU SIP configuration pane, click the SSU SIP tab and then the Incoming Routing Rules subtab.

The Incoming Routing Rules pane contains a table in which each row represents one routing rule.
Click the New button, located at the bottom of the Incoming Routing Rules pane.

The New dialog box appears.

Fill in the fields in the dialog box described in Table 4-2.

Table 4-2 SIP Incoming Routing Rules Parameters

Field Description

Field	Description
Name	Specifies a unique routing rule name
IP Address	Specifies an IP address by which the Service Broker IM is known to external entities. The SIP SSU routes incoming messages destined for this IP address to the IM, based on the name you specify in the Alias field. Setting this field to any applies the routing rule to any incoming SIP message, regardless of its destination IP address. This value is generally used for a default routing rule that routes the incoming SIP message to the default IM, in the absence of any other routing rule. Important: When typing any into the IP Address field, you must use only lower case, as follows: any. Do not type Any or ANY.
Alias	Specifies the SIP URI of the IM to which the SIP SSU routes an incoming session. The alias has the following format: `SSU:`IM-instance-name.IM-type@domain-id IM-instance-name: IM instance name you specified when you added this IM in the IM configuration pane. IM-type: Type of IM instance. domain-id: Name of the Processing Domain or Processing Domain Group where the relevant IM is deployed. This parameter is required only when your Service Broker deployment includes two or more Processing Domains. Use the name given to the domain when it was created. This name is specified by the axia.domain.id property. To set a Processing Domain Group, you must specify the group name. See "Managing Processing Domain Groups" in the Oracle Communications Service Broker Processing Domain Configuration Guide for more information. Example: `ssu`:`r-imocf_instance.RIMOCF@processing-domain.1` You can also specify the SIP URI of an application external to OCSB to which the SIP SSU routes an incoming message. The alias has the following format: `SSU`:parameter@`processing-domain.1`/application parameter: Developer-specfied parameters that are configured to forward the incoming message to the specified application application: The destination application registered to the specified ID to which the incoming event is dispatched.

Name

Specifies a unique routing rule name

IP Address

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

Setting this field to any applies the routing rule to any incoming SIP message, regardless of its destination IP address. This value is generally used for a default routing rule that routes the incoming SIP message to the default IM, in the absence of any other routing rule.

Important: When typing any into the IP Address field, you must use only lower case, as follows: any. Do not type Any or ANY.

Alias

Specifies the SIP URI of the IM to which the SIP SSU routes an incoming session. The alias has the following format: SSU:IM-instance-name.IM-type@domain-id

IM-instance-name: IM instance name you specified when you added this IM in the IM configuration pane.
IM-type: Type of IM instance.
domain-id: Name of the Processing Domain or Processing Domain Group where the relevant IM is deployed. This parameter is required only when your Service Broker deployment includes two or more Processing Domains.

Use the name given to the domain when it was created. This name is specified by the axia.domain.id property.

To set a Processing Domain Group, you must specify the group name. See "Managing Processing Domain Groups" in the Oracle Communications Service Broker Processing Domain Configuration Guide for more information.

Example:

ssu:r-imocf_instance.RIMOCF@processing-domain.1

You can also specify the SIP URI of an application external to OCSB to which the SIP SSU routes an incoming message. The alias has the following format:

SSU:parameter@processing-domain.1/application

parameter: Developer-specfied parameters that are configured to forward the incoming message to the specified application
application: The destination application registered to the specified ID to which the incoming event is dispatched.

Click OK.

The values you enter are displayed in the table.

Configuring SIP Network Entities

You use the SIP Network Entities tab to define a list of SIP network entities with which the SIP SSU communicates.

The SIP Network Entities tab contains a table in which each row represents one SIP network entity.

To provide a stable connection with a SIP network entity, the SIP SSU regularly checks the connection with the entity 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 occurs:

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 triggering the heartbeat method periodically, 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 triggering the heartbeat method as specified by Inactive Interval.

To configure SIP Network Entities:

In the navigation tree in the domain navigation pane, expand the Signaling Tier node.
Select SSU SIP.
In the SSU SIP configuration pane, click the SSU SIP tab and then the SIP Network Entities subtab.
Click the New button at the bottom of the SIP Network Entities pane.

The New dialog box appears.

Fill in the fields described in Table 4-3.

Table 4-3 SIP Network Entities Parameters

Field	Description
Name	Specifies a unique network entity name.
Alias	Specifies a name that Service Broker uses to refer to the SIP network entity. The alias has a format of a SIP URI. For example: `sip:simple_b2b@example.com`
Heartbeat	Specifies whether or not to use a heartbeat mechanism over the connection with the SIP network entity. Possible values: ON OFF Default value: ON
SipUri	Specifies the SIP URI of the SIP network entity. For example: `sip:simple_b2b@192.168.0.219:6060`
Heartbeat Method	Specifies the SIP method that the SIP SSU uses to test the connection with the SIP network entity. Default value: OPTIONS
Response Timeout	Specifies the time interval in seconds during which the SIP SSU waits for a response from the SIP network entity. This field is used by the heartbeat mechanism.
Active Interval	Specifies the time interval 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	Specifies the time interval 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.

Click OK.

The values you enter are displayed in the table.

Configuring the SIP Connection Pool

Service Broker includes a connection pooling mechanism that can be used to minimize communication overhead with SIP entities, such as Serving Call Session Control Function (S-CSCF). You can configure multiple, fixed pools of connections to different addresses.

Service Broker opens new connections from the connection pool on demand as the server makes requests to a configured address. The server then multiplexes new SIP requests to the address using the already-opened connections, rather than repeatedly terminating and recreating new connections. Opened connections are re-used in a round-robin fashion. Opened connections remain open until they are explicitly closed by the remote address.

Note that connection pools are not used for incoming requests from a configured address.

To configure a connection re-use pool for the network access point:

In the navigation tree in the domain navigation pane, expand the Signaling Tier node.
Select SSU SIP.
In the SSU SIP configuration pane, click the SIP tab and then the Connection Pool subtab.

The Connection Pool pane contains a table in which each row represents a pool of connections to one destination host.
Click the New button (+) at the bottom of the Connection Pool configuration pane.

The New Data dialog box appears.

Fill in the fields described in Table 4-4.

Table 4-4 Connection Pool Parameters

Field	Description
Name	Specifies a string value that identifies the name of this pool. All configured names must be unique to the domain.
Destination Host	Specifies the IP address or host name of the destination. Service Broker opens or re-uses connections in this pool only when making requests to the configured address.
Destination Port	Specifies the destination port number.
Maximum Connections	Specifies the maximum number of opened connections to maintain in the pool.

Click OK.

The values you enter are displayed in the table.

Configuring SIP Network Channels

You use the Network Access Points tab to define SIP network channels that the SIP SSU uses to listen to incoming connections. Network Access Points contains the following subtabs that allow you to specify parameters representing a single SIP network channel:

General
Listen address
External listen address

To configure a SIP Network Channel:

In the navigation tree in the domain navigation pane, expand the Signaling Tier node.
Select SSU SIP.
In the SSU SIP configuration pane, click the SIP tab and then click the Network Access Point subtab.
Do one of the following:
- In the Network Access point pane, select the SSU instance whose network channel you want to configure in the Network Access Point tree
- Click Create a new node (+) at the bottom of the pane to add a new SSU instance
The listening address for each instance must be set to the corresponding blade's SIP IP address, as specified in the Network configuration pane. For more information, see "Connecting to the Network" in Oracle Communications Service Broker Netra 6000 High Availability Manager Administrator's Guide.

Click the General tab and enter values for the parameters described in Table 4-5.

Table 4-5 SIP Network Access Point General Parameters

Field	Description
Name	A unique SIP network channel name.
Protocol	The protocol used for connections through the network channel. Set this field to SIP.
Target	The name of the Signaling Server (JVM) providing the SIP network channel. Leaving this field blank indicates that the configuration applies to all Signaling Servers.
Maximum Connected Clients	Specifies the maximum number of SIP clients that can connect.
Complete Message Timeout	Specifies the amount of time in seconds the network access point waits for a complete message to be received. A value of 0 disables the network access point complete message timeout. Valid values range from 0 to 480 seconds.
Idle Connection Timeout	Specifies the amount of time in seconds that a connection is allowed to be idle before it is closed by the network access point. The minimum value is 0 seconds.

Click the Listen Address subtab, and enter values for the parameters described in Table 4-6.

Table 4-6 SIP Network Access Point Listen Parameters

Field	Description
Address Type	Specifies the address type of the SIP network channel internal identity. Set this field to: IP4
Host	Specifies the IP address or DNS name of the SIP network channel internal identity. Setting the value to 0.0.0.0 resolves to the IP of the local machine.
Network Type	Specifies the network type of the SIP network channel internal identity. Set this field to: internet
Port	Specifies the port of the SIP network channel internal identity.

Click the External Listen Address subtab and enter values for the parameters described in Table 4-7.

Table 4-7 SIP Network Access Point External Listen Address Parameters

Field	Description
Address Type	Specifies the address type of the SIP network external identity. Set this field to IP4
Host	Specifies the IP address or DNS name of the SIP network channel external identity. To set the host to the one specified in Table 4-6, set this parameter to 0.0.0.0
Network Type	Specifies the network type of the SIP network channel external identity. Set this field to internet
Port	Specifies the port of the SIP network channel internal identity

Configuring Header Insertion Fields

You use the Network Access pane to set the SIP header insertion fields.

To configure the SIP header insertion fields:

In the navigation tree in the domain navigation pane, expand the Signaling Tier node.
Select SSU SIP.
In the SSU SIP configuration pane, click the SIP tab.

Fill in the fields described in Table 4-8.

Table 4-8 SIP Header Insertion Parameters

Field	Description
Default Form For Header Insertion field	Specifies how the SIP SSU applies rules for compacting SIP message headers. Possible values are: Compact Force compact Long Force long
Server Header Insertion	Specifies the conditions for inserting a server header in SIP messages. Possible values are: None (default) Request Response All
Server Header Value	Specifies the value of the server header inserted into SIP messages.

Field

Description

Default Form For Header Insertion field

Specifies how the SIP SSU applies rules for compacting SIP message headers.

Possible values are:

Compact
Force compact
Long
Force long

Server Header Insertion

Specifies the conditions for inserting a server header in SIP messages.

Possible values are:

None (default)
Request
Response
All

Server Header Value

Specifies the value of the server header inserted into SIP messages.

Configuring SIP SSU with Java MBeans

Figure 4-1 and Figure 4-2 show a set of MBeans that expose attributes and operations for configuring SIP SSU through JMX.

Figure 4-1 SIP SSU Configuration MBean Hierarchy

Figure 4-2 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.

sipPAconfigMBean

sipPAconfigMBean is the root MBean for SIP SSU configuration settings.

Factory Method

Created automatically

Attributes

connectionPoolSet
networkAccessPointSet
paMessageDebug
sipPA

Operations

None

connectionPoolSetMBean

Each instance of ConnectionPoolSetMBean minimizes communication overhead with SIP entities.

Factory Method

Created automatically

Attributes

None

Operations

addConnectionPool()

Adds a connection pool

removeConnectionPool()

Removes a connection pool

ConnectionPoolMBean

ConnectionPoolMBean allows you to configure multiple, fixed pools of connections to different addresses.

Factory Method

connectionPoolSet.addConnectionPool[0..n]

Attributes

None

Operations

cloneIt

Creates a copy of this MBean

destinationHostMBean

destinationHostMBean specifies the IP address or host name of the destination. Service Broker opens or re-uses connections in this pool only when making requests to the configured address.

Factory Method

Created automatically

Attributes

destinationHost

Operations

None

destinationPortMBean

destinationPortMBean specifies the port number of the destination S-CSCF for this pool.

Factory Method

Created automatically

Attributes

destinationPort

Operations

None

maximumConnectionsMBean

maximumConnectionsMBean specifies the maximum number of opened connections to maintain in this pool.

Factory Method

Created automatically

Attributes

maximumConnections

Operations

None

poolNameMBean

poolNameMBean specifies a string value that identifies the name of this pool. All configured names must be unique to the domain.

Factory Method

Created automatically

Attributes

poolName

Operations

None

networkAccessPointSetMBean

networkAccessPointSetMBean is the root MBean that defines SIP network channels that the SIP SSU uses to listen to incoming connections.

Factory Method

Created automatically

Attributes

None

Operations

addNetworkAccessPoint()

Adds an instance of NetworkAccessPointSetMBean that enables you to configure an individual SIP network access point

removeNetworkAccessPoint()

Removes an instance of NetworkAccessPointSetMBean that enables you to configure an individual SIP network access point

networkAccessPointMBean

networkAccessPointMBean defines SIP network channels that the SIP SSU uses to listen to incoming connections.

Factory Method

networkAccessPointSet.addnetworkAccessPoint[0..n]

Attributes

None

Operations

cloneIt

Creates a copy of this MBean

completeMessageTimeoutMBean

completeMessageTimeoutMBean specifies the maximum amount of time (in seconds) a network access point waits for a complete message to be received. A value of 0 disables network access point complete message timeout. Minimum value: 0, Maximum value: 480.

Factory Method

Created automatically

Attributes

completeMessageTimeout

Operations

None

externalListenAddressMBean

externalListenAddressMBean listens for the IP address or DNS name representing the external identity of this network channel. External Listen Port is the externally published listen port for a specific network access point.

Factory Method

Created automatically

Attributes

None

Operations

None

addressTypeMBean

addressTypeMBean specifies the address type. Currently, only IP4 is supported.

Factory Method

Created automatically

Attributes

addressType

Operations

None

hostMBean

hostMBean specifies the IP address or DNS name.

Factory Method

Created automatically

Attributes

host

Operations

None

networkTypeMBean

networkTypeMBean specifies the network type of the SIP network channel external identity.

Factory Method

Created automatically

Attributes

networkType

Operations

None

portMBean

portMBean specifies the address type of the SIP network external identity.

Factory Method

Created automatically

Attributes

port

Operations

None

idleConnectionTimeoutMBean

idleConnectionTimeoutMBean specifies the maximum amount of time (in seconds) that a connection can be idle before it is closed by this network access point. Minimum value is 0.

Factory Method

Created automatically

Attributes

idleConnectionTimeout

Operations

None

listenAddressMBean

listenAddressMBean Address type. Currently, only IP4 is supported.

Factory Method

Created automatically

Attributes

None

Operations

None

addressTypeMBean

addressTypeMBean specifies the address type. Currently only IP4 is supported.

Factory Method

Created automatically

Attributes

addressType

Operations

None

networkTypeMBean

networkTypeMBean specifies the network type. Currently, only internet is supported.

Factory Method

Created automatically

Attributes

networkType

Operations

None

portMBean

portMBean specifies the listen port. Minimum value: 1, Maximum value: 65535.

Factory Method

Created automatically

Attributes

port

Operations

None

maximumConnectedClientsMBean

maximumConnectedClientsMBean specifies the maximum number of clients that can be connected on this network access point. Minimum value is 1.

Factory Method

Created automatically

Attributes

maximumConnectedClients

Operations

None

nameMBean

nameMBean specifies the name of the network access point.

Factory Method

Created automatically

Attributes

name

Operations

None

protocolMBean

protocolMBean specifies the protocol the network channel should use for connections. Currently, only SIP is supported.

Factory Method

Created automatically

Attributes

protocol

Operations

None

targetMBean

targetMBean indicates which SSU this network access point is applied to. A value of null indicates that it is applied to the whole domain.

Factory Method

Created automatically

Attributes

target

Operations

None

sipPAMBean

sipPAMBean specifies that when APP and PA bundles are deployed in a domain, PA bundles share the value of the APP bundle.

Factory Method

Created automatically

Attributes

None

Operations

None

defaultFormForHeaderInsertionMBean

defaultFormForHeaderInsertionMBean specifies how the server applies rules for compacting SIP message headers. The following values are supported:

Compact
Force compact
Long
Force long

When APP and PA bundles are deployed in one domain, PA bundles share the values of the APP bundle.

Factory Method

sipPA.createdefaultFormForHeadInsertion()

Attributes

defaultFormForHeaderInsertion

Operations

None

serverHeaderInsertionMBean

serverHeaderInsertionMBean specifies the conditions for inserting a Server header into SIP messages. The following string values are supported:

None (default)
Request
Response
All

When APP and PA bundles are deployed in one domain, PA bundles share the values of the APP bundle.

Factory Method

Created automatically

Attributes

serverHeaderInsertion

Operations

None

serverHeaderValueMBean

serverHeaderInsertionMBean specifies the value of the server header inserted into SIP messages. Updating the value needs to restart the server. When APP and PA bundles are deployed in one domain, PA bundles share the values of the APP bundle

Factory Method

Created automatically

Attributes

serverHeaderValue

Operations

None

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 4-3.

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 4-5.

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 4-1.

Operations

None