Network Working Group                                        I. Faynberg
Internet Draft                                       Lucent Technologies
<draft-ietf-spirits-sip-evt-package-02.txt>                      J. Gato
Expires September 2002                                         Vodaphone
                                                              V. Gurbani
                                                                   H. Lu
                                                     Lucent Technologies


Toward the Definition of the SIP Events Package for SPIRITS Protocol

Status of this Memo

   This document is an Internet-Draft and is in full conformance with all
   provisions of Section 10 of RFC2026.

   Internet-Drafts are working documents of the Internet Engineering Task
   Force (IETF), its areas, and its working groups. Note that other groups
   may also distribute working documents as Internet-Drafts.
   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time. It is inappropriate to use Internet-Drafts as reference material
   or to cite them other than as "work in progress."

   The list of current Internet-Drafts can be accessed at
   http://www.ietf.org/ietf/1id-abstracts.txt.

   The list of Internet-Draft Shadow Directories can be accessed at
   http://www.ietf.org/shadow.html.

1. Abstract

   This document describes the definition of the SIP Event
   Package for SPIRITS, based on on the structure defined in [1], the
   SPIRITS protocol requirements documented in [2], the overall SPIRITS
   Architecture presented in RFC 3136 [3], the discussion at the
   Salt Lake City meeting, and the subsequent decisions. To this end,
   the document defines the package and event names, and addresses
   the SUBSCRIBE paramaters.

   This document is not intended as a stand-alone one; instead, it is
   expected to be a module of the future SPIRITS protocol RFC when merged
   with the work developed in [4] and other protocol-specific contributions.
   For this reason, this document is not self-sufficient; the information in
   references [2] and [3] is essential in understanding this Internet-Draft.




Toward SPIRITS SIP Events Package-Faynberg-Gato-Gurbani-Lu February 2002





<draft-ietf-spirits-sip-evt-02.txt>                             [Page 2]


2. Conventions used in this document

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in RFC 2119.

3. Introduction

   The rest of this document is organized as follows: section 4 defines the
   package; section 5 provides a table for IANA registration; and sections
   6, 7, and 8 respectively contain, acknowledgements, references, and
   authors' addresses.

4. Definition of the Packages' and Subpackages' Names

   The SPIRITS events package, named "spirits," has two subpackages:
   "INDPs,"  for the events that correspond to IN Detection points;
   and "user-prof", for the events related to the user profile
   information.  The semantics of these packages is explained in
   the following subsections.

4.1 Sub-package "INDPs"

   INDPs is a terminal sub-package. The information specific to the IN
   Detection Points (DPs), including the names of the DPs is encoded..
   According to [2], the following DPs are handled in this way:

       "OAA" (origination_attempt_authorized)
       "AI"  (Analyzed Info)
       "CI"  (Collected_Info)
       "OA"  (O_Answer)
       "OTS" (O_Term_Seized)
       "TAns"(T_Answer)
       "ONA" (O_No_Answer)
       "RSF" (Route_Select_Failure)
       "TNA" (T_No_Answer)
       "OCB" (O_Called_Party_Busy)
       "OMC" (O_Mid_Call)
       "TMC" (T_Mid_Call)
       "OA"  (O_Abandon)
       "OD"  (O_Disconnect)
       "Tab" (T_Abandon)
       "TD"  (T_Disconnect)
       "TAA" (Termination_Attempt_Authorized)
       "FSA" (Facility_Selected_and_Available)
       "TB"  (T_Busy)



Toward SPIRITS SIP Events Package-Faynberg-Gato-Gurbani-Lu February 2002





<draft-ietf-spirits-sip-evt-02.txt>                             [Page 3]


   The DP information is XML-encoded and carried in
   the body of the SUBSCRIBE, as shown in the following
   example:

      SUBSCRIBE sip:gateway.provide.com SIP/2.0
      Events: spirits.INDPs
      Content-Type: application/spirits-events
      Content-Length: 27

      <spirit-event>
         <DP=CI/>
      </spirit-event>
      ...

   The XML schema and DTD for the bodies of both the SUBSCRIBE and
   NOTIFY messages  are described in the companion document.


   4.2 Sub-package "user-prof"

   Similarly, the "user-prof" sub-package is terminal.

   Its specific events are

      "LUS"   (Location Update in the same VLR service area)
      "LUA"   (Location Update in another VLR service area)
      "IA"    (IMSI Attach)
      "MSID"  (MS-initated IMSI Detach)
      "NID"   (Network-initiated IMSI Detach)

   An example of encoding this information
   in the body of the SUBSCRIBE is as follows:

      SUBSCRIBE sip:gateway.provide.com SIP/2.0
      Events: spirits.INDPs
      Content-Type: application/spirits-events
      Content-Length: 27

      <spirit-event>
         <event=LUS>
      </spirit-event>
      ...

   Figure 1 summarizes the package naming and the respective
   functions of both packages as a tree, whose leaves denote
   the XML-encoded information.



Toward SPIRITS SIP Events Package-Faynberg-Gato-Gurbani-Lu February 2002





<draft-ietf-spirits-sip-evt-02.txt>                             [Page 4]


                                          spirits
                                            /(
                                           /  (
                                          /    (
                                     INDPs   user-prof
                                       /          (
                                      /            (
                                     /              (
                        +-----------------+     +--------------+
                        | OAA, AI, CI, OA,|     | LUS, LUA, IA |
                        | TAns, ONA, RSF, |     | MSID, NID    |
                        | TNA, OCB, OMC,  |     +--------------+
                        | TMC, OA, OD,    |
                        | Tab, TD, TAA,   |
                        | FSA, TB, OTS    |
                        +-----------------+

                                   Figure 1: The Tree for SPIRITS Subpackages



5. IANA Registration Information

   The package names are further summarized in Table 1 for IANA
   registration, in the format suggested in [1].



           Package Name      Type         Contact      Reference
           ------------      ----         -------      ---------
           spirits           package      [Lu]         [SPIRITS Protocol]
           INDPs             sub-package  [Lu]         [SPIRITS Protocol]

           [Lu]   Hui-Lan Lu <hui-lan.lu@bell-labs.com>

           REFERENCES
           ----------

           [SPIRITS Protocol]  *TBD*


                             Table 1: Package Names for IANA Consideration


6. Acknowledgements



Toward SPIRITS SIP Events Package-Faynberg-Gato-Gurbani-Lu February 2002





<draft-ietf-spirits-sip-evt-02.txt>                             [Page 5]


   The authors are grateful to Wayne Zeuch for providing us with the
   break-out of DPs among the IN Capability sets and Lawrence Conroy for
   many an incisive comments and suggestions.

7. References

   [1] A. Roach, Event Notification in SIP, <draft-ietf-sip-events-
   00.txt>, Work in Progress. July 2001.

   [2] Faynberg, I. (Ed.), J. Gato, H. Lu, and L. Slutsman <draft-ietf-
   spirits-reqs-04.txt>, Work in Progress. February 2002.

   [3] Slutsman, L (Ed.) et al, The Spirits Architecture. RFC 3136
    Informational). June 2001.

   [4] Brusilovsky, A. et al., On selection of IN parameters to be
   carried by the SPIRITS Protocol. draft-ietf-spirits-in-01.txt. Work
   in Progress. September 2001.

8. Authors' Addresses

   Igor Faynberg
   Bell Labs/Lucent Technologies
   Room 4D-601A, 101 Crawfords Corner Road
   Holmdel, New Jersey, 07733
   Phone: (732) 949-0137
   Email: faynberg@lucent.com

   Jorge Gato Airtel
   Vodaphone
   Avda de Europa, 1.
   28108 Alcobendas (Madrid).
   Spain
   Tel: +34 607 13 31 10 Fax. +34 607 13 30 57
   Email: jgato@vodaphone.es

   Vijay Gurbani
   2000 Naperville Rd., Room 6G-440
   Naperville, IL  60566-7033  USA
   Phone: +1 630 224 0216
   Email: vkg@lucent.com

   Hui-Lan Lu
   Bell Labs/Lucent Technologies
   Room 4C-607A, 101 Crawfords Corner Road
   Holmdel, New Jersey, 07733



Toward SPIRITS SIP Events Package-Faynberg-Gato-Gurbani-Lu February 2002





<draft-ietf-spirits-sip-evt-02.txt>                             [Page 6]

   Phone: (732) 949-0321
   Email: huilanlu@lucent.com

   Full Copyright Statement

   "Copyright (C) The Internet Society (date). All Rights Reserved. This
   document and translations of it may be copied and furnished to others,
   and derivative works that comment on or otherwise explain it or assist
   in its implementation may be prepared, copied, published and
   distributed, in whole or in part, without restriction of any kind,
   provided that the above copyright notice and this paragraph are
   included on all such copies and derivative works. However, this
   document itself may not be modified in any way, such as by removing the
   copyright notice or references to the Internet Society or other
   Internet organizations, except as needed for the purpose of developing
   Internet standards in which case the procedures for copyrights defined
   in the Internet Standards process must be followed, or as required to
   translate it into followed, or as required to translate it into
   languages other than English.

   The limited permissions granted above are perpetual and will not be
   revoked by the Internet Society or its successors or assigns.

   This document and the information contained herein is provided on an
   "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
   TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
   BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
   HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
   MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.




















Toward SPIRITS SIP Events Package-Faynberg-Gato-Gurbani-Lu February 2002