JAIN-SIP 1.1 Reference Implementation
--------------------------------------
CONTENTS
-------
See docs/index.html

BUILD Notes
-----------
Platforms:
---------
You need to install J2SDK 1.3 or above. 1.41 is highly recommended. You can
get J2SDK from http://www.javasoft.com

Nist-sip1.2 compiles and runs on Ipaq using the Blackdown jvm (1.3
compatible) running on top of Familiar (Linux embedded operating
system). To add Swing support,  you just need to install an optional
library. 


Building It from Scratch
-------------------------
The distribution is pre-built but should you feel inclined to make changes,
or run the examples, you may wish to rebuild everything.

Using the makefile: 

1. edit build-config
2. make all

Building the TCK
----------------
The tck needs junit.jar
1. Build the RI as above.
2. make tck (builds a jar file containing the TCK).
3. to run the TCK 

java -jar jain-sip-1.1.tck.jar -mode gui

Brings up a GUI and allows you to enter the path to your implementation.

Using Jakarta ant (get it from the apache web site).

You can the provided build.xml file.
We use make as the build tool of choice. 
build.xml is not always up to date.

----------------------------------------------------------------------------
Running the examples

Please ensure that the directory  classes  (relative to where you have
built the distribution) is included in the  classpath.  Makefile targets
and shell scripts  are provided in each example directory to run the
examples.

How to get Source Code Refreshes
--------------------------------

CVS Snapshot
------------

For those who cannot access CVS thanks to draconian or paranoid 
administrative policies, here is a HTTP url where a nightly source 
only snapshot is grabbed from the stable CVS repository and dumped:

http://is2.antd.nist.gov/pub/nist-sip/nist-sip-1.2.src.tar.gz 

http://is2.antd.nist.gov/pub/nist-sip/nist-sip-1.2.src.zip 


----------------------------------------------------------------------------
CVS Access
----------

The "stable" cvs reposiotory is located on java.net. To download from CVS
(higly recommended), visit 

http://jain-sip.dev.java.net/source/browse/jain-sip/

And follow the instructions there. 
Note that you need to be logged in to java.net in order to acces the source 
from cvs.


----------------------------------------------------------------------------

Architecture / API design:
-------------------------

JAIN-SIP:  Phelim O'Doherty (Sun Microsystems) and M. Ranganathan (NIST) 
JAIN-SDP: The SDP API spec lead is Kelvin Porter from DynamicSoft.

Implementation Lead:
---------------------
"M. Ranganathan" <mranga@nist.gov>

Implementation Team
-------------------
"M. Ranganathan" <mranga@nist.gov>
"Oliver Deruelle" <deruelle@antd.nist.gov>

TCK
---
Emil Ivov <emil_ivov@yahoo.com>
M. Ranganathan  <mranga@nist.gov>



----------------------------------------------------------------------------

Substantial input by early adopters and fearless users.

See List of Contributions at:

file:./www/README.html

----------------------------------------------------------------------------

COPYRIGHT
---------
The software was developed by employees of the National Institute of
Standards and Technology (NIST), an agency of the Federal Government.
Pursuant to title 15 Untied States Code Section 105, works of NIST
employees are not subject to copyright protection in the United States
and are considered to be in the public domain.  As a result, a formal
license is not needed to use the software.

The NIST-SIP software is provided by NIST as a service and is expressly
provided "AS IS."  NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
AND DATA ACCURACY.  NIST does not warrant or make any representations
regarding the use of the software or the results thereof, including but
not limited to the correctness, accuracy, reliability or usefulness of
the software.

Permission to use this software is contingent upon your acceptance
of the terms of this agreement and upon your providing appropriate
acknowledgments of NIST's ownership of the software. 

----------------------------------------------------------------------------
M. Ranganathan's layman interpretation of the preceeding blather
----------------------------------------------------------------

This is public domain code. Do whatever you want with this software.
That means you can incorporate it into any product you wish or use it
as-is free of any royalty payments or license agreements.  You may even
drop it on your foot. However, you may not sue us (that includes me)
even if it has bugs and does not work as advertised.  You may not sue us (
that includes me) even if you drop it on your foot and it hurts your toe.
So be afraid. Be very afraid, because I am afraid.

NIST (ie. the public - including you and I but neither you nor I) owns
this software.  You may not grab ownership and get in the way of its
free distribution even if you invest a lot of effort into fixing it.
This is despite the fact that as it is in the public domain, you already
own it. Note that this follows from a simple application of reason -
once you own something, you own something and you may not own it again.
The software will remain in the public domain for now and ever more
(ie. until the sun shall shine and stars shall twinkle in the sky)
regardless of your use of it. Please be nice and acknowledge our efforts
if you find this code to be of use.

Corollary 1:
------------

Do not ask me for permission to use this code. I cannot permit you to use
that which I do not own.


Corollary 2:
-----------

Do not offer to pay me for the use of this code. I have absolutely no
interest in making money by selling something I do not own, not withstanding
my recent sale of the Brooklyn Bridge.

Corollary 3:
------------
Do not ask me for permission to own this code. I cannot grant you ownership
for something you, I and everybody else already owns.

i.e. Once you had it you had it. You cannot have it again. Owning is believing.


-------------------------------------------------------------------------
Here are the licensing terms for JAIN-SIP ( the package javax.sip.* ):
------------------------------------------------------------------------

   SUN MICROSYSTEMS, INC. IS WILLING TO LICENSE THIS
   SPECIFICATION TO YOU ONLY UPON THE CONDITION THAT
   YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS
   LICENSE AGREEMENT ("AGREEMENT").  PLEASE READ THE
   TERMS AND CONDITIONS OF THIS LICENSE CAREFULLY. BY
   DOWNLOADING THIS SPECIFICATION, YOU ACCEPT THE
   TERMS AND CONDITIONS OF THIS LICENSE AGREEMENT. IF
   YOU ARE NOT WILLING TO BE BOUND BY ITS TERMS,
   SELECT THE "DECLINE" BUTTON AT THE BOTTOM OF THIS
   PAGE AND THE DOWNLOADING PROCESS WILL NOT
   CONTINUE.

   JAIN Session Initiation Protocol (SIP)
   Specification ("Specification")
   Version: 1.1
   Status: FCS, Maintenance Release 
   Release: July 25, 2003

   Copyright 2003 Sun Microsystems, Inc.

   4150 Network Circle, Santa Clara, California
   95054, U.S.A
   All rights reserved.

   NOTICE; LIMITED LICENSE GRANTS

   Sun Microsystems, Inc. ("Sun") hereby grants you a
   fully-paid, non-exclusive, non-transferable,
   worldwide, limited license (without the right to
   sublicense), under the Sun's applicable
   intellectual property rights to view, download,
   use and reproduce the Specification only for the
   purpose of internal evaluation, which shall be
   understood to include developing applications
   intended to run on an implementation of the
   Specification provided that such applications do
   not themselves implement any portion(s) of the
   Specification.

   Sun also grants you a perpetual, non-exclusive,
   worldwide, fully paid-up, royalty free, limited
   license (without the right to sublicense) under
   any applicable copyrights or patent rights it may
   have in the Specification to create and/or
   distribute an Independent Implementation of the
   Specification that: (i) fully implements the
   Spec(s) including all its required interfaces and
   functionality; (ii) does not modify, subset,
   superset or otherwise extend the Licensor Name
   Space, or include any public or protected
   packages, classes, Java interfaces, fields or
   methods within the Licensor Name Space other than
   those required/authorized by the Specification or
   Specifications being implemented; and (iii) passes
   the TCK (including satisfying the requirements of
   the applicable TCK Users Guide) for such
   Specification. The foregoing license is expressly
   conditioned on your not acting outside its scope.
   No license is granted hereunder for any other
   purpose.

   You need not include limitations (i)-(iii) from
   the previous paragraph or any other particular
   "pass through" requirements in any license You
   grant concerning the use of your Independent
   Implementation or products derived from it.
   However, except with respect to implementations of
   the Specification (and products derived from them)
   that satisfy limitations (i)-(iii) from the
   previous paragraph, You may neither: (a) grant or
   otherwise pass through to your licensees any
   licenses under Sun's applicable intellectual
   property rights; nor (b) authorize your licensees
   to make any claims concerning their
   implementation's compliance with the Spec in
   question.

   For the purposes of this Agreement: "Independent
   Implementation" shall mean an implementation of
   the Specification that neither derives from any of
   Sun's source code or binary code materials nor,
   except with an appropriate and separate license
   from Sun, includes any of Sun's source code or
   binary code materials; and "Licensor Name Space"
   shall mean the public class or interface
   declarations whose names begin with "java",
   "javax", "com.sun" or their equivalents in any
   subsequent naming convention adopted by Sun
   through the Java Community Process, or any
   recognized successors or replacements thereof.

   This Agreement will terminate immediately without
   notice from Sun if you fail to comply with any
   material provision of or act outside the scope of
   the licenses granted above.

   TRADEMARKS

   No right, title, or interest in or to any
   trademarks, service marks, or trade names of Sun
   or Sun's licensors is granted hereunder. Sun, Sun
   Microsystems, the Sun logo, Java, JAIN, and the
   Java Coffee Cup logo are trademarks or registered
   trademarks of Sun Microsystems, Inc. in the U.S.
   and other countries.

   DISCLAIMER OF WARRANTIES

   THE SPECIFICATION IS PROVIDED "AS IS".  SUN MAKES
   NO REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO,
   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE, OR NON-INFRINGEMENT, THAT THE
   CONTENTS OF THE SPECIFICATION ARE SUITABLE FOR ANY
   PURPOSE OR THAT ANY PRACTICE OR IMPLEMENTATION OF
   SUCH CONTENTS WILL NOT INFRINGE ANY THIRD PARTY
   PATENTS, COPYRIGHTS, TRADE SECRETS OR OTHER
   RIGHTS.  This document does not represent any
   commitment to release or implement any portion of
   the Specification in any product.

   THE SPECIFICATION COULD INCLUDE TECHNICAL
   INACCURACIES OR TYPOGRAPHICAL ERRORS.  CHANGES ARE
   PERIODICALLY ADDED TO THE INFORMATION THEREIN;
   THESE CHANGES WILL BE INCORPORATED INTO NEW
   VERSIONS OF THE SPECIFICATION, IF ANY.  SUN MAY
   MAKE IMPROVEMENTS AND/OR CHANGES TO THE PRODUCT(S)
   AND/OR THE PROGRAM(S) DESCRIBED IN THE
   SPECIFICATION AT ANY TIME.  Any use of such
   changes in the Specification will be governed by
   the then-current license for the applicable
   version of the Specification.

   LIMITATION OF LIABILITY

   TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT
   WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY
   DAMAGES, INCLUDING WITHOUT LIMITATION, LOST
   REVENUE, PROFITS OR DATA, OR FOR SPECIAL,
   INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
   DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE
   THEORY OF LIABILITY, ARISING OUT OF OR RELATED TO
   ANY FURNISHING, PRACTICING, MODIFYING OR ANY USE
   OF THE SPECIFICATION, EVEN IF SUN AND/OR ITS
   LICENSORS HAVE BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGES.

   You will indemnify, hold harmless, and defend Sun
   and its licensors from any claims arising or
   resulting from: (i) your use of the Specification;
   (ii) the use or distribution of your Java
   application, applet and/or clean room
   implementation; and/or (iii) any claims that later
   versions or releases of any Specification
   furnished to you are incompatible with the
   Specification provided to you under this license.

   RESTRICTED RIGHTS LEGEND

   U.S. Government: If this Specification is being
   acquired by or on behalf of the U.S. Government or
   by a U.S. Government prime contractor or
   subcontractor (at any tier), then the Government's
   rights in the Software and accompanying
   documentation shall be only as set forth in this
   license; this is in accordance with 48 C.F.R.
   227.7201 through 227.7202-4 (for Department of
   Defense (DoD) acquisitions) and with 48 C.F.R.
   2.101 and 12.212 (for non-DoD acquisitions).

   REPORT

   You may wish to report any ambiguities,
   inconsistencies or inaccuracies you may find in
   connection with your use of the Specification
   ("Feedback"). To the extent that you provide Sun
   with any Feedback, you hereby: (i) agree that such
   Feedback is provided on a non-proprietary and
   non-confidential basis, and (ii) grant Sun a
   perpetual, non-exclusive, worldwide, fully
   paid-up, irrevocable license, with the right to
   sublicense through multiple levels of
   sublicensees, to incorporate, disclose, and use
   without limitation the Feedback for any purpose
   related to the Specification and future versions,
   implementations, and test suites thereof.

   (LFI#134430/Form ID#011801)


--------------------------------------------------------------------
M. Ranganathan's totally paranoid interpretation of the above:

visit 

http://jcp.org/aboutJava/communityprocess/final/jsr032/index2.html

and agree to the licensing terms above before using the javax.sip API
or you will be hounded by lawyers.

--------------------------------------------------------------

The javax.sdp code is included here for evaluation purposes only.
You may examine it but you may not touch it because it does not like to
be handled.

Visit the jsr 141 page and read the licensing terms for yourself.

http://www.jcp.org/en/jsr/detail?id=141

The implementation of the 

javax.sdp code gov.nist.javax.sdp.* is in

the public domain.

The licensing terms for the API are mysteriously in an "expired" state
and the JSR 141 expert group mailing list is a favorite target for
spamming attacks.


------------------------------------------------------------------

If you have read every word of this so  far you deserve a medal.
Such is the logic of the non-legal mind. Note that non-legal minds
are not necessarily illegal minds and legal minds are also frequently
illegal minds.  Also note that a mind is a terrible thing to lose ... or
not to have.

Nuff said! have fun with it. 

Ranga.