RegistrarServlet

Overview

The SIP servlet that handles a REGISTER message from a user agent (UA).

RegistrarServlet is an SIP servlet that implements the registration server (registrar) function defined in RFC3261. Note that the current version of this SIP proxy servlet does not fully conform to RFC3261.

RegistrarServlet provides the following as the main function.

The function that receives a REGISTER method to update location information

RegistrarServlet uses the authentication function provided by SIP Servlet Engine when authenticating. See the example shown below.

Initialization Parameters

The following table lists the initialization parameters you can set in RegistrarServlet.

Parameter name	Default value	Description
exclusive	false	Specify true when the REGISTERed registration information of the user should be used exclusively. If set to true, only the last REGISTERed registration information is used for the user.

External Interfaces

RegistrarServlet uses the following SPI:

User Management Interface
Location Management Interface

Related File

The RegistrarServlet setting should be defined in the sip.xml.

Example

Here is an example of the sip.xml.

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE sip-app
   PUBLIC "-//Java Community Process//DTD SIP Application 1.0//EN"
   "http://www.jcp.org/dtd/sip-app_1_0.dtd">

<sip-app>
  <display-name>SIP Servlet based Registrar</display-name>

  <servlet>
    <servlet-name>registrar</servlet-name>
    <servlet-class>com.oki.sip.apps.registrar.RegistrarServlet</servlet-class>
    <init-param>
      <param-name>exclusive</param-name>
      <param-value>true</param-value>
    </init-param>
    <load-on-startup/>
  </servlet>

  <servlet-mapping>
    <servlet-name>registrar</servlet-name>
    <pattern>
        <equal>
          <var>request.method</var>
          <value>REGISTER</value>
        </equal>
    </pattern>
  </servlet-mapping>

  <session-config>
    <session-timeout>1</session-timeout>
  </session-config>

  <security-constraint>
    <display-name>DEMO Constraint</display-name>
    <resource-collection>
      <resource-name>Demo constraint</resource-name>
      <description>This constraint is for Demo-application</description>
      <servlet-name>registrar</servlet-name>
    </resource-collection>
    <auth-constraint>
      <role-name>sipuser</role-name>
    </auth-constraint>
  </security-constraint>

  <login-config>
    <auth-method>DIGEST</auth-method>
    <realm-name>oki.com</realm-name>
  </login-config>

  <security-role>
    <description>Default SIP User</description>
    <role-name>sipuser</role-name>
  </security-role>
</sip-app>

Reference

RFC 3261

Last Modified:Tue Dec 28 14:11:54 JST 2004