22 Configuring IM-ASF SIP

The following sections describe how to configure IM-ASF using the Service Broker Administration Console and Java MBeans.

Configuring IM-ASF SIP with the Administration Console

This section describes how to configure IM-ASF SIP module instances using the Service Broker Administration Console.

To access the IM-ASF SIP configuration screen:

In the domain navigation pane, expand OCSB.
Expand Processing Tier.
Select Interworking Modules.

A list of currently deployed Interworking Modules is displayed.
From the module list, select the module instance that you want to configure.

The IM-ASF SIP configuration pane contains the subtabs described in Table 22-1.

Table 22-1 IM-ASF Configuration Subtabs

Subtab	Description
Application Server	Enables you to define the SIP Application Server that IM-ASF SIP interact with. See "Configuring Application Server Parameters" for more information.
Session Keep Alive	Enables you to define the keep-alive mechanism that is used to test session existence with SIP Application Servers. See "Configuring Session Keep Alive Parameters" for more information.
SIP	Enables you to configure standard SIP protocol parameters. See "Configuring SIP Parameters" for more information.
Monitoring	Enables you to define how Runtime MBeans and notifications operate. See "Configuring Monitoring Parameters" for more information.

Configuring Application Server Parameters

An IM-ASF SIP module instance interacts with one SIP Application Server. The Application Server subtab enables you to define an alias for this Application Server.

Table 22-2 describes configuration parameters on the Application Server subtab.

Table 22-2 Application Server Parameters

Name	Type	Description
AS Address Alias	STRING	Specifies the address of the SIP AS to which IM-ASF SIP module instance is connected. You must select the alias of an address that is already defined in the SIP Network Entities tab.

Name

Type

Description

AS Address Alias

STRING

Specifies the address of the SIP AS to which IM-ASF SIP module instance is connected.

You must select the alias of an address that is already defined in the SIP Network Entities tab.

Configuring Session Keep Alive Parameters

IM-ASF SIP performs regular checks of SIP sessions using a mechanism known as keep-alive mechanism. This mechanism enables the IM-ASF SIP to check whether or not a session is still in progress by periodically sending INFO requests to the SIP AS and checking the response. 200 OK response indicates that the session is still in progress. Any other response, or no response at all, indicates that the session was dropped.

Table 22-3 describes configuration parameters on the Session Keep Alive subtab.

Table 22-3 Session Keep Alive Parameters

Name	Type	Description
INFO Keep Alive Interval in Seconds	INT	Specifies the interval, in seconds, between consecutive invocations of INFO requests. To disable the keep-alive mechanism, set this parameter to -1. When this parameter is not defined, then the keep-alive mechanism is disabled.
INFO Keep Alive Time to Die	INT	Specifies the interval, in seconds, that the IM-ASF SIP waits for a response to keep-alive messages. If there is no response within the time specified in this parameter, the session is ended.

Name

Type

Description

INFO Keep Alive Interval in Seconds

INT

Specifies the interval, in seconds, between consecutive invocations of INFO requests.

To disable the keep-alive mechanism, set this parameter to -1.

When this parameter is not defined, then the keep-alive mechanism is disabled.

INFO Keep Alive Time to Die

INT

Specifies the interval, in seconds, that the IM-ASF SIP waits for a response to keep-alive messages.

If there is no response within the time specified in this parameter, the session is ended.

Configuring SIP Parameters

Enables you to configure standard SIP protocol parameters.

Table 22-4 describes configuration parameters on the SIP subtab.

Table 22-4 SIP Parameters

Name	Type	Description
Max Call Duration Timeout Interval in Minutes	INT	Specifies the maximum duration of established calls which are measured from OK to BYE. When this timer expires, IM-ASF SIP releases the session. Default value: 60 minutes
Retransmission Interval Limit	INT	Specifies a maximum retransmission interval for non-INVITE requests and INVITE responses. Default value: 20 seconds
T7 Timeout Interval in Seconds	INT	Specifies the time period in seconds during which the IM-ASF SIP waits for the first SIP provisional response (except for 100) after sending an INVITE request. Default value: 40 seconds.
T9 Timeout Interval in Seconds	INT	Specifies the time period in seconds during which the IM-ASF SIP waits for an OK response or any call release response (for example, ERROR) after sending an INVITE request. Default value: 90 seconds

Configuring Monitoring Parameters

The Monitoring tab enables you to define how Runtime MBeans and notifications operate for an IM-ASF. For more information about configuring monitoring, see "Configuring Monitoring with the Administration Console".

Configuring IM-ASF SIP with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-ASF SIP through JMX. Figure 22-1 shows the hierarchy of the IM-ASF SIP MBeans.

Figure 22-1 IM-ASF SIP MBeans Hierarchy

The following sections provide reference information for the IM-ASF SIP 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.

The following MBeans are common for all components of Service Broker and described in "Configuring Monitoring with Java MBeans":

MonitoringGeneralMBean
ThresholdCrossedNotificationRulesMBean
ThresholdCrossedNotificationRuleMBean
StateChangedNotificationRulesMBean
StateChangedNotificationRuleMBean

ImasfSipMBean

ImasfMBean is a root MBean for the IM-ASF SIP configuration.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getApplicationServer()

Gets a reference to the instance of ApplicationServerMBean

ObjectName getSip()

Gets a reference to the instance of SipMBean

ObjectName getSessionKeepAlive()

Gets a reference to the instance of SessionKeepAliveMBean

ObjectName getMonitoringGeneral()

Gets a reference to the instance of MonitoringGeneralMBean

ObjectName getThresholdCrossedNotificationRules()

Gets a reference to the instance of ThresholdCrossedNotificationRulesMBean

ObjectName getStateChangedNotificationRules()

Gets a reference to the instance of StateChangedNotificationRulesMBean

ObjectName getAdvanced()

Gets a reference to the instance of AdvancedMBean

ApplicationServerMBean

ApplicationServerMBean enables you to define the SIP Application Server that IM-ASF SIP interact with.

Factory Method

Created automatically

Attributes

AsAddressAlias

For more information on these attributes, see Table 22-2.

Operations

None

SipMBean

SipMBean enables you to configure standard SIP protocol parameters.

Factory Method

Created automatically

Attributes

MaxCallDurationTimeoutIntervalInMinutes
RetransmissionIntervalLimit
t7TimeoutIntervalInSeconds
t9TimeoutIntervalInSeconds

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

Operations

None

SessionKeepAliveMBean

SessionKeepAliveMBean enables you to define the keep-alive mechanism that IM-ASF SIP use to test session existence with SIP Application Servers.

Factory Method

Created automatically

Attributes

InfoKeepAliveInterval
InfoKeepAliveTimeToDie

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

Operations

None

Default IM-ASF Module Instance

It is recommended to have a special instance of IM-ASF, a default IM-ASF instance named "IMASF_default", in every system.

To understand why you should create a default IM-ASF module instance, see "Supporting Orchestration with Non-Configured Application".

For information on defining a default IM-ASF module, see "Defining a Default IM-ASF Module".