Skip Headers

Oracle® Communication and Mobility Server Administrator's Guide Release 10.1.3 Part Number E10292-02 |
Home | Contents | Index | Contact Us

Previous | Next
| View PDF

# 4 Configuring the SIP Servlet Container

This chapter discusses configuring the SIP servlet container in the following sections:

- "Overview"

- "Starting the SIP Servlet Container"

- "Accessing the System MBeans in the MBean Browser"

- "Configuring the SIP Servlet Container"

- "Configuring the Application Router"

## Overview

Oracle Application Sever Control enables you to manage the SIP Servlet Container as an MBean (a Managed Bean).

OC4J provides the Oracle Enterprise Manager 10g Application Server Control Console, a JMX-compliant, Web-based user interface for deploying, configuring and monitoring applications within OC4J, as well as managing the OC4J server instance and the Web services used by your applications. You can also use the MBean Browser to manage other OCMS components (such as logging, and so on). See Chapter 9, "Managing the SIP Server" for more information.

The SIP servlet container system MBean may be accessed from the Administration tab of the Application Server Control Console. This MBean exposes attributes and operations that enable configuration of the SIP servlet container.

The main steps to configuring the SIP servlet container are as follows:

- Starting the SIP Servlet Container

- Accessing the System MBeans in the MBean Browser

- Configuring the SIP Servlet Container

- Configuring the Application Router

## Starting the SIP Servlet Container

The SIP Servlet container runs on:

- UNIX/Linux—Starting the SIP Servlet Container on Linux or UNIX

- Windows—Starting the SIP Servlet Container on Windows

### Starting the SIP Servlet Container on Linux or UNIX

To start or stop the SIP servlet container on Linux or UNIX:

- Navigate to the following directory:

      $ORACLE_HOME/sdp/bin

- At the command line, execute the following command:

      startocms

  Or

      stopocms

### Starting the SIP Servlet Container on Windows

To start or stop the SIP servlet container on Windows:

- Select Start > Programs > Oracle Communication and Mobility Server > Start OCMS or Stop OCMS.

## Accessing the System MBeans in the MBean Browser

To manipulate the system MBeans in the Application Server Control Console MBean Browser:

1. Type the following URL in a Web browser:

       http://<hostname>:<port>/em

   where `hostname` is the address of the application server running the SIP servlet container and `port` is the port number.

   To check the port number of the application server instance, execute the following command:

       ORACLE_HOME/opmn/bin/opmnctl status -l

   By default, the port number for a single node deployment of OCMS is 8888.

2. In the Application Server Control home, click Administration and scroll to the bottom of the page.

3. Under JMX, click the icon for System MBean Browser.

4. Expand the SipContainer folder and select the SipServletContainer attribute.

5. In the right pane, click Attributes to view current configurations or Operations to set parameters.

See the online Help provided with Application Server Control Console for detailed instructions on using this interface.

Note:

Certain changes made through the MBean browser are lost after the system is restarted. Configuration changes to the SIP container made through the MBean browser are persisted to the file system and will survive a server restart.

## Configuring the SIP Servlet Container

The SIP servlet container includes a number of configurable parameters, some of which should be configured prior to deploying SIP applications. You can configure the SIP servlet container parameters by accessing the System MBeans in the AS Control Console.

The following parameters should be configured prior to deploying applications:

- Supported SIP Traffic Transport Protocols—Configure the communication protocols that the SIP servlet container supports, such as TCP, UDP, and so on.

- Domains and Realms—Configure the domains you want to allow to connect to the SIP servlet container.

- Contact—Configure the public listen address to embed in the headers of outgoing SIP messages.

- DefaultApplications—Configure the SIP applications to which SIP messages are routed by default.

Note:

By default, the SIP servlet container IP address and SIP port, as well as the DNS caching server are configured during OCMS installation. Refer to the OCMS Installation Guide for more information.

### Supported SIP Traffic Transport Protocols

The SIP servlet supports the following transport protocols for sending SIP messages:

- TCP (recommended)

- UDP

To enable transport protocols:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Attributes tab, select true or false from the drop-down list to enable or disable any of the following:

   - UseTCP

   - UseUDP

3. Click Apply.

To view enabled transport protocols:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Attributes tab, scroll down to the bottom of the page to view the enabled protocols (UseTCP, UseUDP).

### Domains and Realms

The DomainsAndRealms attribute maps SIP domains to Java authentication realms. This mapping is used to dynamically challenge incoming SIP requests with the relevant authentication realm during SIP authentication. For example, when responding to a challenge issued by the SIP container, a domain or realm mapping for company.com requires the SIP URI user@company.com in order to successfully authenticate.

To configure a domain:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Operations tab, click addDomain and fill in the following parameters:

   - domain—The domain for which you want to allow access to the SIP servlet, such as `voip.com`.

   - realm—The name of the authentication realm with which the domain is associated. For example, `voip`.

3. Click Invoke Operation.

To remove a domain from the list of permitted domains:

- To remove a domain, click removeDomain, enter the domain name in the space provided and click Invoke Operation.

To view configured domains:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Attributes tab, click DomainsAndRealms to display a comma-separated list of configured hosted domains.

### Contact

The Contact attribute includes contact information that a User Agent Client embeds in outgoing SIP requests, such as the host, port, and transport protocol to be used. This gives the SIP Server an "address" to which it can respond. Using the Contact attribute requires running a SIP Servlet that acts as a User Agent Client.

To configure the contact attribute:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Operations tab, click setContactAsString.

   Alternatively, click setDistributableContactAsString to set the Contact attribute for distributable applications used in a high availability environment.

3. Enter the domain name, port number, and transport protocol separated by commas, for example, `my.host.com,5060,tcp`.

4. Click Invoke Operation.

To view the configured Contact attribute:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Attributes tab, click Contact.

### DefaultApplications

The DefaultApplications attribute represents a comma-separated list of applications that are invoked if no application matches a request. By default, the Application Router is configured as the default application.

To configure the default applications:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Operations tab, click setDefaultApplicationsAsString and enter a comma separated list of default applications in the space provided.

3. Click Invoke Operation.

To view the default applications:

1. Access the SipServletContainer MBean (see "Accessing the System MBeans in the MBean Browser").

2. In the Attributes tab, scroll down to the DefaultApplications attribute.

## Configuring the Application Router

It is possible to configure the Application Router in standard or incremental modes. For more information on the Application Router and its modes, see "Application Router".

Note:

Before configuring the Application Router, make sure the `DefaultApplications` attribute is set to the Application Router.

To configure the Application Router:

1. Access the Oracle Enterprise Manager 10g Application Server Control.

2. Click the Applications tab.

3. Under subscriberdataservices, click ocmsrouteloaderear.

4. Click the Administration tab.

5. Under JMX, click Application Defined MBeans.

6. Click Administration > System MBean Browser.

   An MBean displays for each category of SIP traffic as follows:

   - `RouteLoader_Invite`

   - `RouteLoader_Message`

   - `RouteLoader_Publish`

   - `RouteLoader_Register`

   - `RouteLoader_Subscribe`

   You must configure the Application Router behavior for each category of SIP message.

   To configure the Application Router to run in standard mode, see Configuring the Application Router in Standard Mode.

   To configure the Application Router to run in incremental mode, see Configuring the Application Router in Incremental Mode.

### Configuring the Application Router in Standard Mode

To set the Application Router to operate in standard mode, you must configure the following parameters:

- IncrementalMode—Set to false in order to run the Application Router in standard mode.

- RecordRoute—Set the RecordRoute parameter to true so that the SIP Servlet container records the route of the SIP messages.

- SipUriList—Configure the URI, port number, transport method (TCP or UDP), and application ID of each application to which you want to route SIP messages.

To configure the Application Router in standard mode:

1. Access the Application Router Mbeans, as described in Configuring the Application Router.

2. Configure the following for each Application Router Mbean:

   1. In the Operations tab, click setRecordRoute and select true. Click Invoke Operation.

   2. In the Operations tab, click setSipUriList. In the space provided, enter the URI of each application you want to include in the route header. By default, the Proxy Registrar is listed.

      For each application, enter the URI and port number, the transport method (TCP or UDP), and the name of the application. Enter the information in the following format:

          sip:111.11.111.1:5060;transport=TCP;lr;appId=proxyregistrar

      The order of comma separated applications determines the order in which SIP messages are routed to these applications.

   3. In the Operations tab, click setIncrementalMode. Set its value to false and click Invoke Operation.

### Configuring the Application Router in Incremental Mode

To set the Application Router to operate in incremental mode, you must configure the following parameters:

- IncrementalMode—Set to true in order to run the Application Router in incremental mode.

- SipUriList—Configure the URI, port number, transport method (TCP or UDP), and application ID of each application to which you want to route SIP messages.

- RecordRoute—Set the RecordRoute parameter to true so that the SIP Servlet container records the route of the SIP messages.

- RouteLoaderUri—Configure the URI of the return route to the Application Router. This URI must be the same as that of the SIP Servlet container. In general, this URI should be set to the URI of the Proxy/Registrar, as the SIP Servlet container recognizes the URI of the Proxy/Registrar as its own

To configure the Application Router in incremental mode:

1. Access the Application Router Mbeans, as described in Configuring the Application Router.

2. Configure the following for each Application Router Mbean:

   1. In the Operations tab, click setRecordRoute and select true. Click Invoke Operation.

   2. In the Operations tab, click setSipUriList. In the space provided, enter the URI of each application you want to include in the route header. By default, the Proxy Registrar is listed.

      For each application, enter the URI and port number, the transport method (TCP or UDP), and the name of the application. Enter the information in the following format:

          sip:111.11.111.1:5060;transport=TCP;lr;appId=proxyregistrar

      The order of comma separated applications determines the order in which SIP messages are routed to these applications.

   3. In the Operations tab, click setIncrementalMode. Set its value to true and click Invoke Operation.

   4. In the Operations tab, click setRouteLoaderURI. In the space provided, enter the URI of the Proxy/Registrar in the following format:

          sip:152.68.199.9;lr;