Copyrights

This product and related documentation are protected by copyright and distributed under licenses restricting its use, copying, distribution, and decompilation. No part of this product or related documentation may be reproduced in any form by any means without prior written authorization of Sun and its licensors, if any.

RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the United States Government is subject to the restrictions set forth in DFARS 252.227-7013 (c)(1)(ii) and FAR 52.227-19.

The product described in this manual may be protected by one or more U.S. patents, foreign patents, or pending applications.

TRADEMARKS

Sun, the Sun logo, Sun Microsystems, Java, Java Compatible, JavaBeans, Solaris,Write Once, Run Anywhere, JDK, Java Development Kit, and JavaStation are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and certain other countries. UNIX is a registered trademark in the United States and other countries, exclusively licensed through X/Open Company, Ltd. All other product names mentioned herein are the trademarks of their respective owners.

THIS PUBLICATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS PUBLICATION COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THE PUBLICATION. SUN MICROSYSTEMS, INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS PUBLICATION AT ANY TIME.

• 1.0 Introduction
• 2.0 Objectives and scope
• 3.0 Initial set up for RI
• 4.0 Sending Events from Application through RI.
• 5.0 Limitations
• 6.0 Abbreviations

 

1.0 Introduction

Java APIs for the Integrated Network (JAIN) Framework brings Service Portability and Network Convergence into the Telephony Network. JAIN encompasses a standard set of interfaces for service creation and a number of standard interfaces for service execution. This document, which is is part of the JAIN SIP 0.6 Specification, outlines the requirements of the JAIN SIP Reference Implementation.

2.0 Objectives and scope

The purpose of this document is to

• Outline the requirements for setting up the Reference Implementation (RI) which JAIN SIP applications can run against.
• List the scope, limitations and restrictions of the JAIN SIP RI.

The JAIN SIP RI will emulate the functions of a SIP stack (but will not be a SIP stack) in order to verify the requirements within this specification. The intention of the JAIN SIP RI is not to implement a SIP stack or to replace vendor SIP stacks. The purpose of the JAIN SIP RI is to provide a means to verify that JAIN SIP applications are compatible with the JAIN SIP specification. The RI can be used in order to help develop a JAIN SIP application. The JAIN SIP RI (here after referred to as RI) handles 'normal' SIP message sequencing, however, it performs some limited checking.

Several classes developed with JDK1.2 and the JAIN SIP API specification will be used while running the RI. This implementation will satisfy the following requirement as listed in the JAIN SIP Requirement Specification.

1. The Reference Implementation is utilised by implementing a JAIN SIP API specification.
2. Java Virtual Machine

3.0 Initial set up for RI

The setup for the RI is initialised by a JAIN SIP Application. A diagram to illustrate the procedures involved on setting up the RI is shown in Figure 3.1.
 
• When an application is present, it should invoke the getInstance method of the JAIN IP Factory.
• The pathname of the JAIN IP Factory is set to "com.dynamicsoft.ri" using the setPathname method.
• The createIPObject method of the JAIN IP Factory is invoked with "jain.ip.sip.JainSipStackImpl" as the argument. This returns a JainSipStack, i.e. an RI JAIN SIP Stack Implementation.
• The getListeningPoints method of the JainSipStack is called to get the ListeningPoints available (The RI will only return one ListeningPoint).
• The createProvider method of JainSipStack is then invoked. It returns the RI JAIN SIP Provider implementation which is attached to the Stack.
• The JAIN SIP application registers itself as an event listener of the RI's JAIN SIP Provider by invoking the addJainSipListener method of the provider. [see Figure 3.1].

After the initial setup, the JAIN SIP Application should be capable of sending and receiving Message Events to and from the RI, see Section 4.0.

Messages are sent from the Application to the Provider using the appropriate sendXXX method. The RI simply converts all Messages received (so the event source is correct) and passes them back to the registered Listener using the appropriate processXXX method. [See Figure 4.1]
 
 

Figure 4.1 JAIN SIP RI Message routing.

• Cannot handle multiple Providers

• Cannot handle multiple Listeners

• Cannot handle encryption or decryption

Abbreviations