view Side-By-Side changes
Internet-Draft dynamicsoft Expires:January 16,April 25, 2005 H. Schulzrinne Columbia University O. Levin, Ed. Microsoft CorporationJuly 18,October 25, 2004 A Session Initiation Protocol (SIP) Event Package for Conference Statedraft-ietf-sipping-conference-package-05draft-ietf-sipping-conference-package-06 Status of this Memo This document is an Internet-Draft and is subject to all provisions of section 3 of RFC 3667. By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she become aware will be disclosed, in accordance with RFC 3668. 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 athttp:// www.ietf.org/ietf/1id-abstracts.txt.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. This Internet-Draft will expire onJanuary 16,April 25, 2005. Copyright Notice Copyright (C) The Internet Society (2004).All Rights Reserved.Abstract This document defines a conference event package for the Session Initiation Protocol (SIP) Events framework, along with a data format used in notifications for this package. The conference package Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page 1] Internet-Draft Conference PackageJulyOctober 2004 allows users to subscribe to a conference URI. Notifications are sent about changes in the membership of this conference and optionally about changes in the state of additional conference components. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . .45 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . .56 3. Conference Event Package . . . . . . . . . . . . . . . . . . .67 3.1 Event Package Name . . . . . . . . . . . . . . . . . . . .67 3.2 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . .67 3.3 Subscription Duration . . . . . . . . . . . . . . . . . .67 3.4 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . .78 3.5 Notifier Processing of SUBSCRIBE Requests . . . . . . . .78 3.6 Notifier Generation of NOTIFY Requests . . . . . . . . . .78 3.7 Subscriber Processing of NOTIFY Requests . . . . . . . . .89 3.8 Handling of Forked Requests . . . . . . . . . . . . . . .89 3.9 Rate of Notifications . . . . . . . . . . . . . . . . . .89 3.10 State Agents . . . . . . . . . . . . . . . . . . . . . . .89 4. Conference DataFormat .Model . . . . . . . . . . . . . . . . . . .10 4.1 Conference Information . .. 11 5. Constructing Coherent State . . . . . . . . . . . . . . .10 4.1.1 User Element. . 12 6. Conference Data . . . . . . . . . . . . . . . . . . .10 4.1.1.1 User Attributes. . . . 14 6.1 Conference Information . . . . . . . . . . . . .11 4.1.1.2 User Status Elements. . . . . 14 6.1.1 Conference Type . . . . . . . . . .12 4.1.1.3 Media Information. . . . . . . . . 14 6.1.1.1 conference-description of conference-description-type . . . . . . .13 4.1.1.3.1 Media Attributes. . . . 14 6.1.1.2 host-info of host-type . . . . . . . . . . .13 4.1.1.3.2 Media Elements. . . 14 6.1.1.3 conference-state of conference-state-type . . . . 15 6.1.1.4 user of user-type . . . . . . . . .14 4.1.1.4 User Role. . . . . . . 15 6.1.1.5 sidebars-by-ref of uris-type . . . . . . . . . . . 15 6.1.1.6 sidebar-by-val of conference-type . .14 4.1.2 Sidebar Element. . . . . . 15 6.1.2 Conference Description Type . . . . . . . . . . . . . 154.1.3 Additional Conference Identifiers6.1.2.1 display-text of string type . . . . . . . . . . . 154.1.4 Policy URIs6.1.2.2 subject of string type . . . . . . . . . . . . . . 15 6.1.2.3 free-text of string type . . . . . . . .15 4.1.5 Recording. . . . . 15 6.1.2.4 keywords of keywords-type . . . . . . . . . . . . 16 6.1.2.5 web-page of anyURI type . . . . .15 4.1.6 Streaming. . . . . . . . 16 6.1.2.6 conf-uris of uris-type . . . . . . . . . . . . . . 164.2 Constructing Coherent State .6.1.2.7 service-uris of uris-type . . . . . . . . . . . . 16 6.1.2.8 maximum-user-count of user-count-type . .16 4.2.1 The Algorithm. . . . 16 6.1.2.9 available-media of conference-medias-type . . . . 16 6.1.3 Host Type . . . . . . . . . . . .17 4.3 Schema. . . . . . . . . . 16 6.1.3.1 display-text of string type . . . . . . . . . . . 16 6.1.3.2 web-page of anyURI type . . . . .18 4.4 Example. . . . . . . . 17 6.1.3.3 uris of uris-type . . . . . . . . . . . . . . . . 17 6.1.4 Conference State Type .21 5. Security Considerations. . . . . . . . . . . . . . . 17 6.1.4.1 user-count of user-count-type . . . .23 6. IANA Considerations. . . . . . 17 Rosenberg, et al. Expires April 25, 2005 [Page 2] Internet-Draft Conference Package October 2004 6.1.4.2 security-level of security-level-type . . . . . . 17 6.1.4.3 active of Boolean type . . . . . . . . .24 6.1 conference Event Package Registration. . . . . 17 6.1.4.4 locked of Boolean type . . . . .24 6.2 application/conference-info+xml MIME Registration. . . .24 6.3 URN Sub-Namespace Registration for urn:ietf:params:xml:ns:conference-info. . . . . 17 6.1.4.5 recording of uris-type . . . . .24 6.4 XML Schema Registration. . . . . . . . . 17 6.1.4.6 active-media of conference-medias-type . . . . . . 18 6.1.5 User Type . .25 7. Acknowledgements. . . . . . . . . . . . . . . . . . . . 18 6.1.5.1 display-text of string type . . .26 8. Changes History. . . . . . . . 18 6.1.5.2 associated-aors of anyURI type . . . . . . . . . . 18 6.1.5.3 roles of user-roles-type . . . . .27 8.1 Changes since -04. . . . . . . . 18 6.1.5.4 language of language type . . . . . . . . . . . .27 Rosenberg, et al. Expires January 16, 2005 [Page 2] Internet-Draft Conference Package July 2004 8.2 Changes since -0319 6.1.5.5 cascaded-focus of anyURI type . . . . . . . . . . 19 6.1.5.6 endpoint of endpoint-type . . . . . . . . . .27 8.3 Changes since -02. . 19 6.1.6 Endpoint Type . . . . . . . . . . . . . . . . . .27 8.4 Changes since -01. . 19 6.1.6.1 display-text of string type . . . . . . . . . . . 20 6.1.6.2 referred of execution-type . . . . . . .28 9. References. . . . . 20 6.1.6.3 state of endpoint-state-type . . . . . . . . . . . 20 6.1.6.4 joining-method of joining-type . . . . . . . . . .29 9.1 Normative References21 6.1.6.5 joining-info of execution-type . . . . . . . . . . 21 6.1.6.6 disconnection-method of disconnection-type . . . . 22 6.1.6.7 disconnection-info of disconnection-type . . . . . 22 6.1.6.8 whispering-to of uris-type .29 9.2 Informative References. . . . . . . . . . . 22 6.1.6.9 media of media-type . . . . . . . .29 Authors' Addresses. . . . . . . 22 6.1.7 Media Type . . . . . . . . . . . . . . .30 Intellectual Property and Copyright Statements. . . . . . . 23 6.1.7.1 display-text of string type .32 Rosenberg, et al. Expires January 16, 2005 [Page 3] Internet-Draft Conference Package July 2004 1. Introduction The Session Initiation Protocol (SIP) [6] Events framework Events Framework [7] defines general mechanisms for subscribing to, and receiving notifications of, events within SIP networks. It introduces the notion. . . . . . . . . . 23 6.1.7.2 proto ofa package, which is a specific "instantiation"string type . . . . . . . . . . . . . . . 23 6.1.7.3 ssrc ofthe events framework for a well-defined setstring type . . . . . . . . . . . . . . . 23 6.1.7.4 label ofevents. Here, we define an event package for SIP conferences. This package provides the conference notification service as outlined in the SIP conferencing framework [14]. As described there, subscriptions to a conference URI are routed to the focus that is handling the conference. It acts as the notifier, and provides clients with updates on conference state. The information provided by this package is comprisedstring type . . . . . . . . . . . . . . . 24 6.1.7.5 state ofconference identifier(s), conference participants (optionally with their statuses and media description), conference sidebars, conference policy URIs, etc. Rosenberg, et al. Expires January 16, 2005 [Page 4] Internet-Draft Conference Package July 2004 2. Terminology In this document, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",media-state-type . . . . . . . . . . . . 24 6.1.7.6 snd-status of media-state-type . . . . . . . . . . 24 6.1.7.7 rcv-status state of media-state-type . . . . . . . 24 6.1.7.8 call of call-type . . . . . . . . . . . . . . . . 24 7. Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 8. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 8.1 Basic Example . . . . . . . . . . . . . . . . . . . . . . 33 8.2 Rich Example . . . . . . . . . . . . . . . . . . . . . . . 35 9. Security Considerations . . . . . . . . . . . . . . . . . . . 40 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . 41 10.1 conference Event Package Registration . . . . . . . . . . 41 10.2 application/conference-info+xml MIME Registration . . . . 41 10.3 URN Sub-Namespace Registration for urn:ietf:params:xml:ns:conference-info . . . . . . . . . . 41 10.4 XML Schema Registration . . . . . . . . . . . . . . . . . 42 11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 43 12. Changes History . . . . . . . . . . . . . . . . . . . . . . 44 12.1 Changes since -05 . . . . . . . . . . . . . . . . . . . . 44 12.2 Changes since -04 . . . . . . . . . . . . . . . . . . . . 44 12.3 Changes since -03 . . . . . . . . . . . . . . . . . . . . 44 12.4 Changes since -02 . . . . . . . . . . . . . . . . . . . . 44 Rosenberg, et al. Expires April 25, 2005 [Page 3] Internet-Draft Conference Package October 2004 12.5 Changes since -01 . . . . . . . . . . . . . . . . . . . . 45 13. References . . . . . . . . . . . . . . . . . . . . . . . . . 46 13.1 Normative References . . . . . . . . . . . . . . . . . . . . 46 13.2 Informative References . . . . . . . . . . . . . . . . . . . 46 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 47 Intellectual Property and Copyright Statements . . . . . . . . 49 Rosenberg, et al. Expires April 25, 2005 [Page 4] Internet-Draft Conference Package October 2004 1. Introduction The Session Initiation Protocol (SIP) [6] Events framework Events Framework [7] defines general mechanisms for subscribing to, and receiving notifications of, events within SIP networks. It introduces the notion of a package, which is a specific "instantiation" of the events framework for a well-defined set of events. Here, we define an event package for SIP conferences. This package provides the conference notification service as outlined in the SIP conferencing framework [15]. As described there, subscriptions to a conference URI are routed to the focus that is handling the conference. It acts as the notifier, and provides clients with updates on conference state. The information provided by this package is comprised of conference identifier(s), conference participants (optionally with their statuses and media description), conference sidebars, conference service URIs, etc. Rosenberg, et al. Expires April 25, 2005 [Page 5] Internet-Draft Conference Package October 2004 2. Terminology In this document, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and"OPTIONAL""OPTIONAL" are to be interpreted as described in RFC 2119 [2] and indicate requirement levels for compliant implementations. Rosenberg, et al. Expires April 25, 2005 [Page 6] Internet-Draft Conference Package October 2004 3. Conference Event Package The conference event package allows a user to subscribe to a conference. In SIP, conferences are represented by URIs. These URIs route to a SIP user agent, called a focus, that is responsible for ensuring that all users in the conference can communicate with each other, as described in Conferencing Framework [15]. The focus has sufficient information about the state of the conference to inform subscribers about it. It is possible a participant in the conference may in fact be another focus. In order to provide a more complete participant list, the focus MAY subscribe to the conference package of the other focus to discover the participant list in the cascaded conference. This information can then be included in notifications by using of the "cascaded-focus" element as specified by this package. This section provides the details for defining a SIP Events package, as specified by RFC 3265 [7]. 3.1 Event Package Name The name of this event package is "conference". This package name is carried in the Event and Allow-Events header, as defined in RFC 3265 [7]. 3.2 SUBSCRIBE Bodies A SUBSCRIBE for a conference package MAY contain a body. This body defines a filter to apply to the subscription. Filter documents are not specified in this document, and at the time of writing, are expected to be the subject of future standardization activity. A SUBSCRIBE for a conference package MAY be sent without a body. This implies the default subscription filtering policy. The default policy is: o Notifications are generated every time there is any change in the state of the conference. o Notifications do not normally contain full state; rather, they only indicate the state that has changed. The exception is a NOTIFY sent in response to a SUBSCRIBE. These NOTIFYs contain the full state of the information requested by the subscriber. 3.3 Subscription Duration The default expiration time for a subscription tobe interpreted as described ina conference is one hour. Once the conference ends, all subscriptions to that particular conference are terminated, with a reason of "noresource" RFC2119 [2] and indicate requirement levels for compliant implementations.3265 Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page5]7] Internet-Draft Conference PackageJulyOctober 20043. Conference Event Package The conference event package allows a user to subscribe to a conference. In SIP, conferences are represented by URIs. These URIs route to a SIP user agent, called a focus, that is responsible for ensuring that all users in the conference can communicate with each other, as[7]. 3.4 NOTIFY Bodies As described inConferencing Framework [14]. The focus has sufficient information aboutRFC 3265 [7], the NOTIFY message will contain bodies that describe the state of theconference to inform subscribers about it. Itsubscribed resource. This body ispossiblein aparticipantformat listed in theconference may in fact be another focus. In order to provideAccept header field of the SUBSCRIBE, or amore complete participant list,package-specific default if thefocus MAY subscribe toAccept header field was omitted from the SUBSCRIBE. In this event package, the body of the notification contains a conferencepackageinformation document. This document describes the state of a conference. All subscribers and notifiers MUST support the "application/conference-info+xml" data format described in Section 6. The subscribe request MAY contain an Accept header field. If no such header field is present, it has a default value of "application/conference-info+xml". If the header field is present, it MUST include "application/conference-info+xml", and MAY include any otherfocus to discovertypes. Of course, theparticipant list innotifications generated by thecascaded conference. This information can thenserver MUST beincludedinnotifications by usingone of the"cascaded-focus" attribute as specified by this package. This section provides the details for defining a SIP Events package, asformats specifiedby RFC 3265 [7]. 3.1 Event Package Name The name of this event package is "conference". This package name is carriedin theEvent and Allow-Events header, as definedAccept header field inRFC 3265 [7]. 3.2the SUBSCRIBEBodies Arequest. 3.5 Notifier Processing of SUBSCRIBEfor aRequests The conferencepackage MAY contain a body. This body defines a filter to apply to the subscription. Filter documents are not specified in this document,information contains very sensitive information. Therefore, all subscriptions SHOULD be authenticated and then authorized before approval. Authorization policy is at thetimediscretion ofwriting, are expected to bethesubject of future standardization activity. A SUBSCRIBE foradministrator, as always. However, aconference package MAYfew recommendations can besent without a body. This implies the default subscription filtering policy. The default policy is: o Notifications are generated every time theremade. It isany changeRECOMMENDED that all users in thestate ofconference be allowed to subscribe to the conference.o3.6 Notifier Generation of NOTIFY Requests Notificationsdo not normally contain full state; rather, they only indicateMUST be generated for the conference statethat has changed. The exception is a NOTIFY sent in response towhen aSUBSCRIBE. These NOTIFYs contain the full state of the information requested by the subscriber. 3.3 Subscription Duration The default expiration time fornew participant joins (i.e. gets "connected" to) or asubscriptionparticipant leaves (i.e. gets "disconnected" from) the conference. Subject to aconference is one hour. Oncelocal focus policy, additional changes in participants' status, changes in their media types, and other optional information MAY be reported by theconference ends, all subscriptionsfocus. Changes in sidebar rosters SHOULD be reported by the focus tothat particular conference are terminated, with a reason of "noresource" RFC 3265their participants and MAY be reported to others, subject to local policy. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page6]8] Internet-Draft Conference PackageJulyOctober 2004[7]. 3.4 NOTIFY Bodies As describedChanges inRFC 3265 [7],conference identifiers and service URIs SHOULD be reported by theNOTIFY message will contain bodies that describefocus to the Conference package subscribers. Changes in other conference stateofinformation MAY be reported by thesubscribed resource. This body is infocus to the Conference package subscribers. 3.7 Subscriber Processing of NOTIFY Requests The SIP Events framework expects packages to specify how aformat listedsubscriber processes NOTIFY requests in any package specific ways, and in particular, how it uses theAccept header fieldNOTIFY requests to construct a coherent view of theSUBSCRIBE, or a package-specific default ifstate of theAccept header field was omitted fromsubscribed resource. Typically, theSUBSCRIBE. In this event package,NOTIFY for thebodyconference package will only contain information about those users whose state in the conference has changed. To construct a coherent view of thenotification containstotal state of all users, a subscriber to the conference package will need to combine NOTIFYs received over time. Notifications within this package can convey partial information; that is, they can indicate informationdocument. This document describesabout a subset of the stateof a conference. All subscribers and notifiers MUST supportassociated with the"application/conference-info+xml" data format describedsubscription. This means that an explicit algorithm needs to be defined inSection 4.order to construct coherent and consistent state. Thesubscribe request MAY contain an Accept header field. If no such header field is present, it has a default valuedetails of"application/ conference-info+xml". Ifthis mechanism are specific to theheader field is present, it MUST include "application/conference-info+xml", and MAY include any other types capableparticular document type. See Section 5 for information on constructing coherent information from an application/conference-info+xml document. 3.8 Handling ofrepresenting dialog state. Of course,Forked Requests By their nature, thenotifications generatedconferences supported bythe serverthis package are centralized. Therefore, SUBSCRIBE requests for a conference should not generally fork. Users of this package MUSTbe in oneNOT install more than a single subscription as a result ofthe formats specified in the Accept header field in thea single SUBSCRIBE request.3.5 Notifier Processing3.9 Rate ofSUBSCRIBE Requests The conference information contains very sensitive information. Therefore, all subscriptions SHOULD be authenticated and then authorized before approval. Authorization policyNotifications For reasons of congestion control, it isatimportant that thediscretionrate ofthe administrator, as always. However,notifications not become excessive. As afew recommendations can be made. Itresult, it is RECOMMENDED thatall users in the conference be allowed to subscribe totheconference. 3.6 Notifier Generation of NOTIFY Requests Notifications SHOULD be generatedserver not generate notifications forthe conference whenever therea single subscriber at a rate faster than once every 5 seconds. 3.10 State Agents Conference state isa changeideally maintained in thestateelement inany ofwhich theinformation delivered toconference resides. Therefore, thesubscriber. The changes generally occur when a new participant joins (i.e. gets "connected" to) or a participant leaves (i.e. gets "disconnected" from)elements that maintain theconference. Subjectconference are the ones best suited toa local focus policy, additional changes in participant's status, changes in its media types, and other optional media attributes MAY be reported byhandle subscriptions to it. Therefore, thefocus.usage of state agents is NOT RECOMMENDED for this Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page7]9] Internet-Draft Conference PackageJulyOctober 2004Changes in sidebar rosterspackage. Rosenberg, et al. Expires April 25, 2005 [Page 10] Internet-Draft Conference Package October 2004 4. Conference Data Model Conference information is an XML document that MUST be well-formed and SHOULD bereportedvalid. Dialog information documents MUST be based on XML 1.0 and MUST be encoded using UTF-8. This specification makes use of XML namespaces for identifying dialog information documents and document fragments. The namespace URI for elements defined by this specification is a URN [3], using thefocus to their participantsnamespace identifier 'ietf' defined by [4] andMAY be reported to others, subject to local policy. Changesextended by [1]. This URN is: The conference information is described by a hierarchal XML structure with the root element "conference-info". The root element is the only element in the schema that carries meaningful version number for all the elements in the document. The whole conferenceidentifiersinformation is associated with this version number. All sub-elements in the "conference-info" hierarchal XML structure can be classified in two groups: those that carry relatively small amount of data andpolicy URIs SHOULD be reported bythose that can potentially carry a lot of data. During partial notifications, thefocus tolight elements are updated as atomic pieces of data. On theconference participants. 3.7 Subscriber Processingother hand, elements that can carry a substantial amount ofNOTIFY Requests The SIP Events framework expects packagesdata have the general "state" attribute attached tospecify how a subscriber processes NOTIFY requeststhem. That is inany package specific ways, andorder to support partial notifications for their content. A "state" attribute of a child element inparticular, how it usestheNOTIFY requestsdocument MUST adhere toconstruct a coherent viewits parent "state". It means that if the parent's "state" is "full", the state of its children MUST be "full". If the parent's "state" is "partial", the state of its children MAY be either "partial", "full", or "deleted". For elements with thesubscribed resource. Typically,optional "state" attribute, if theNOTIFY forattribute is omitted from theconference package will only contain information about those users whose state innotification for theconference has changed. To construct a coherent view ofelement, it means that thetotalreported element's stateof all users,is "full". All sub-elements, with possible multiple appearances under asubscribercommon parent, have keys defined to them in order to uniquely identify each element among others of theconferencesame type in the partial notification event. Rosenberg, et al. Expires April 25, 2005 [Page 11] Internet-Draft Conference Package October 2004 5. Constructing Coherent State A Conference packagewill need to combine NOTIFYs received over time. Notifications within thissubscriber MUST initialize the "version" attribute from the "conference-info" element with the value in the first document received. The conference packagecan convey partial information; that is, they can indicate information aboutsubscriber locally maintains asubset oflocal element for each element in thestate associatedschema and a table for each element withthe subscription. This means that an explicit algorithm needs to be definedkey(s) inorder to construct coherentthe schema andconsistent state. The detailsindexed by these key(s). Each time a new NOTIFY is received, the value ofthis mechanismthe local version number and the "version" attribute in the new received document arespecific tocompared. If theparticularvalue in the new documenttype. See Section 4.2 for information on constructing coherent information from an application/ conference-info+xml document. 3.8 Handling of Forked Requests By their nature,is one higher than theconferences supportedlocal version number, the local version number is increased bythis package are centralized. Therefore, SUBSCRIBE requests for a conference should not generally fork. Users of this package MUST NOT installone, and the document is processed. If the value in the document is more thana single subscription as a result of a single SUBSCRIBE request. 3.9 Rate of Notifications For reasons of congestion control, itone higher than the local version number, the local version number isimportant thatset to therate of notifications not become excessive. As a result, itvalue in the new document, the document isRECOMMENDED thatprocessed, and theserver notsubscriber SHOULD generatenotifications forasingle subscriber atrefresh request to trigger arate faster than once every 5 seconds. 3.10 State Agents Conferencefull stateis ideally maintained innotification. If theelementvalue inwhich the conference resides. Therefore,theelements that maintain the conference aredocument is less than theones best suited to handle subscriptions to it. Therefore,local version, theusage of state agents is NOT RECOMMENDED for this Rosenberg, et al. Expires January 16, 2005 [Page 8] Internet-Draft Conference Package July 2004 package. Rosenberg, et al. Expires January 16, 2005 [Page 9] Internet-Draft Conference Package July 2004 4. Conference Data Format Conference information is an XML document that MUST be well-formed and SHOULD be valid. Dialog information documents MUST be based on XML 1.0 and MUST be encoded using UTF-8. This specification makes use of XML namespaces for identifying dialog information documents anddocumentfragments. The namespace URI for elements defined by this specificationisa URN [3], usingdiscarded without processing. Further processing of thenamespace identifier 'ietf' defined by [4] and extended by [1]. This URN is: urn:ietf:params:xml:ns:conference-info Aconference information documentbegins withdepends on whether it contains full or partial state. If it contains full state, indicated by theroot element tag "conference-info". 4.1 Conference Information Conference information begins withvalue of thetop level element "conference-info". This element has three mandatory attributes: version: This mandatory"state" attributeallowsin therecipient of conference information documents to properly order them. Versions start at 0"conference-info" element, the whole local content is flushed andincrementrepopulated from the document. If it contains "deleted" state, indicated byone for each new document sent to a subscriber. Versions are scoped within a subscription. Versions MUST be represented using a 32 bit integer. state: This mandatorythe value of the "state" attributeindicates whetherin thedocument contains"conference-info" element, it means that thefullconferenceinformation, or whether it contains onlyceased to exist and theinformation that has changed sincesubscriber SHOULD terminate the SUBSCRIBE dialog. If thepreviousdocument(partial). entity: This mandatory attributecontains partial state, as indicated by theconference URI that identifiesvalue of theconference being described"state" attribute in thedocument. The"conference-info"element has zero or more "user" sub-elements which contain information on the users inelement, theconference. Thisdocument isfollowed by zero or more "sidebar" sub-elements which contain information onused to update thesidebarslocal content as described below. Starting from outer elements in theconference. This is followed by zero or more "conf-uri" sub-elements which contain information on additional URIs thatreceived document, 1. If theconference can be accessed by. This is followed by zero or more "policy-uri" sub-elements which contain information on additional URIs thatparent element contains "full" state, theconference policies can be accessed by. Thiswhole local element content isfollowed by "recording"flushed and"streaming"repopulated from the document. 2. Otherwise, if the parent element contains "deleted" state, the whole element MUST be removed from the local content. 3. Otherwise, if the parent element contains "partial" state: 3.1 For elementsdescribing recording and streaming statuses ofwith keys, theconference. 4.1.1 User Elementsubscriber compares the keys received in the update with the keys in the local tables. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page10]12] Internet-Draft Conference PackageJulyOctober 20044.1.1.1 User Attributes The user3.1.1 If a key does not exist in the local table, a row is added, and its content is set to the elementhas one mandatory attribute, "uri" that indicatesinformation from theURI forupdate. 3.1.2 Otherwise, if a key of theusersame value does exist, for each sub-element in theconference. This is a logical identifier, which corresponds to the authenticated identity ofrow theparticipant. The "uri" attribute MUST be uniquealgorithm is applied from step 2.2. 3.2 For each atomic element received in theuserschema, the elementlist because itisused asreplaced with thekey in partial notifications about users' state. If a conference participant has more thannew information as asingle signaling dialog associatedwhole. Also, for each non-atomic element received in the schema with either no "state" attribute included or theconference,state attribute is set to "full", theconference focus MAY presentelement is replaced with theuser's aggregatednew information(e.g. the statuses) and display all its media streams underas asingle user element. Note,whole. 3.2.1 If an element, which doesnĘt have key(s), is updated or created such that its content is empty, thatthe optionalelement"instance" of "media" (see below)MAY beused in this case to specifyremoved from theactual signaling dialog forlocal content at any time. 3.3 For eachmedia stream. An anonymous participant in a conference SHOULD be represented by an anonymous URI generated bynon-atomic element with thefocus. For multiple anonymous participants,state attribute set to "partial", thefocus must ensure that each anonymous URIalgorithm isunique. The guidelines for generating anonymous URIs in RFC 3323 [8] should be followed. For example, "Anonymous1" <sip:anonymous1@anonymous.invalid> could be used for a participant requesting privacy. The optional attribute "display-name" containsapplied recursively starting from step 3. Rosenberg, et al. Expires April 25, 2005 [Page 13] Internet-Draft Conference Package October 2004 6. Conference Data urn:ietf:params:xml:ns:conference-info A conference information document begins with the root element tag "conference-info". 6.1 Conference Information A conference instance is defined as adisplay name fortop level element "conference-info" of a type "conference-type". Sections below describe theuser.complex types composing the hierarchal "conference-type". Thestandard "xml:lang" languagefull XML schema is defined in Section 7. 6.1.1 Conference Type This type has the following attributes: version: This mandatory attributecan also be present to indicateallows thelanguagerecipient ofthe display-name. The optionalconference information documents to properly order them. Versions start at 0 and increment by one for each new document sent to a subscriber. Versions are scoped within a subscription. Versions MUST be represented using a 32 bit integer. entity: This mandatory attribute"cascaded-focus"containsa conference URI (different fromthemainconferenceURI) for usersURI thatare connected toidentifies themainconferenceas a result of focus cascading. In accordance with the SIP conferencing framework [14], this package allows for representation of peer-to-peer (i.e. "flat") focus cascading only. The actual cascading graph can not be deduced from the information providedbeing described in thepackage alone. Advanced applications can constructdocument. state: This mandatory attribute indicates whether thegraph by subscribing to both this package anddocument contains theDialog Package [15] ofwhole conference information ("full"), only thecascaded foci and correlatinginformation that has changed since therelevant information. Ifprevious document ("partial"), or themainconference"state" is "full",ceased to exist ("deleted"). For more details see Section 5. This type defines an extendable sequence of thestatefollowing optional child elements: 6.1.1.1 conference-description ofits user(s) MUST "full". Ifconference-description-type This element contains conference information that is derived from system conference policies, is set before themainconference"state"activation, and is"partial",rarely changed during thestateconference lifetime. 6.1.1.2 host-info ofits user(s) MAY be either "partial" or "full".host-type This element contains information about the entity that hosts the conference. This information is set before the conference activation, and is rarely changed during the conference lifetime, Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page11]14] Internet-Draft Conference PackageJulyOctober 20044.1.1.2 User Status Elements Three optional status elements are defined: status, joining-mode, and disconnection-reason. o "status": provides information about user's current levelunless the whole conference is moved to be hosted by another entity. 6.1.1.3 conference-state ofparticipation inconference-state-type This element contains theconference. o "joining-mode": if present, providesdynamic information about thewaycurrent state of the focus. 6.1.1.4 userjoinedof user-type This element contains theconference. o "disconnection-reason": if present, providesinformation aboutthe way the user lefta participant in the conference. Thefollowing statuses are defined forelement of the"status" element: connected: The user is auser-type can have unbounded number of appearance in the conference-type for each participant in the conference.Depending on6.1.1.5 sidebars-by-ref of uris-type This element provides a pointer to sidebar information through sidebar URIs. The recipient of themedia policies, he/sheinformation cansend and receive mediathen subscribe toandsidebar information independently fromother participants. disconnected: The user is notthe main Conference package subscription. 6.1.1.6 sidebar-by-val of conference-type This element provides sidebar information as aparticipant inpart of theconference and no active dialog exists betweenmain Conference package information. 6.1.2 Conference Description Type This element contains theuser and"state" attribute which can contain thefocus. on-hold: Active SIP dialog exists between a user and a focus, but user is "on-hold" for this conference, i.e. neither he/she is "hearing"values "full", "partial", or deleted". This type defines an extendable sequence of theconference mix, nor is his/her media being mixed infollowing optional child elements: 6.1.2.1 display-text of string type This element contains text information about the conference.As an example,6.1.2.2 subject of string type This element contains information about theuser has asked to joinsubject of a conference. 6.1.2.3 free-text of string type This element contains free form text about the conference. Rosenberg, et al. Expires April 25, 2005 [Page 15] Internet-Draft Conference Package October 2004 6.1.2.4 keywords of keywords-type This element contains a list of keywords which describe the conferenceusing SIP, but his/her participation is pending based on moderator approval. In the meantime he/she is hearing music-on-hold or some other kindtopic. 6.1.2.5 web-page ofrelated content. muted-via-focus: Active SIP dialog exists betweenanyURI type This element contains auser andURI of afocus and the user can "listen"web page that contains information related to theconference, but user's media is not being mixed into theconference.Note that sometimes a subset6.1.2.6 conf-uris ofuser media streamsuris-type This element contains information about additional conference URIs that this conference can bemuted by focus (such as poor quality video) while others (such as voice or IM)accessed by. Examples of such URIs include h323: [14] and tel: [13] URIs. 6.1.2.7 service-uris of uris-type This element contains the service-related URIs. These URIs canstillbeactive. In this case, it is RECOMMENDED that the "aggregated" user connectivity "status" reflectsused to manipulate thestatusconference policies or state, for example. 6.1.2.8 maximum-user-count of user-count-type This element contains a count of themostly active media. blocked: User is denied from ever participatingmaximum number of users permitted inthisthe conference.pending: User is not yetThe count can be specified for all participants in total (using thesession, but it is anticipated that he/she will join insub-element with value "any") or count thenear future. calling: User is being calledusers by their roles in thefocus. ringing: An PSTN ALERTING or SIP 180 Ringing was returned for the outbound call, user is being alerted. dialing-in: User is dialing intoconference. 6.1.2.9 available-media of conference-medias-type This element contains information about theconference, not yetmedia types available in a conference. The "entry" sub-element MUST be a value registered for "proto" of SDP [12]. 6.1.3 Host Type This element contains theroster (probably being authenticated). disconnecting: Focus is in"state" attribute which can contain theprocess of disconnecting user (either DISCONNECTvalues "full", "partial", orBYE was sent todeleted". This type defines an extendable sequence of theuser's device). removed:following optional child elements: 6.1.3.1 display-text of string type Thisstatus is used to removeelement contains display text information about the userfrom the roster using partial notifications mechanism. Note thathosting thedefined transient states (e.g., calling, ringing, etc.) could generate a lot of notifications. Implementations MAY choose not to generate notifications on these to all participants if it willconference. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page12]16] Internet-Draft Conference PackageJulyOctober 2004generate too much traffic. The following statuses are defined for6.1.3.2 web-page of anyURI type This element contains a web page URI about the"joining-mode" element: dialed-in: Theuserdialed intohosting theconference, i.e. sent INVITEconference. 6.1.3.3 uris of uris-type The "entity" sub-element contains additional URIs relating to thefocus,user hosting the conference. 6.1.4 Conference State Type This element contains the "state" attribute whichresultedcan contain the values "full", "partial", or deleted". This type defines an extendable sequence of the following optional child elements. 6.1.4.1 user-count of user-count-type This element contains a count of the current number of users insuccessful dialog establishment. dialed-out:the conference. Thefocus has broughtcount can be specified for all participants in total (using theuser intosub-element with value "any") or count theconferenceusers bysending a successful INVITEtheir roles in the conference. 6.1.4.2 security-level of security-level-type This element contains information about the conference security level. The values can be "none", "low", "medium", or "high". 6.1.4.3 active of Boolean type This element contains information about whether the conference is currently active or not. 6.1.4.4 locked of Boolean type This element contains information about whether the conference is currently locked. In this context, locked means that the conference roster can not be added to (although participants may leave or be removed from the conference). 6.1.4.5 recording of uris-type The "entry" sub-element contains URIs related to theuser. focus-owner: The user isrecording of thefocus for thisconference. Rosenberg, et al. Expires April 25, 2005 [Page 17] Internet-Draft Conference Package October 2004 6.1.4.6 active-media of conference-medias-type Thisstatuselement contains information about the media types currently active in the conference which isused only whenaparticipant UA acts as a conference focus. Thesubset of those listed in the "available-media" element. 6.1.5 User Type This type has the followingstatuses are definedattributes: entity: The mandatory attribute contains the URI for thedisconnection-reason element: departed: Theusersent a BYE, thus leavingin the conference.booted: The user was sentThis is aBYE bylogical identifier, which corresponds to thefocus, booting him/her outauthenticated identity of theconference. Alternatively, the user tried to dial into to conference without success because was rejected by the focus according to local policy decisions. failed:participant. Theserver tried to bring"entity" attribute MUST be unique in the userinto the conference, but its attempt to contactelement list because it is used as thespecific user resultedkey in partial notifications about users' state. An anonymous participant in anon-200 class final response. Alternatively, the user tried to dial into theconferencewithout success due to technical reasons. 4.1.1.3 Media Information Each user has zero or more "media" sub-elements. Each "media" element indicatesSHOULD be represented by an anonymous URI generated by themedia thatfocus. For multiple anonymous participants, theuser is currently connected to. Here, "connected to" impliesfocus must ensure thata user has a media line in his/her SDP [12] document(s). With this definition, a user is connected to a media stream even if he/sheeach anonymous URI isnot sending any media. 4.1.1.3.1 Media Attributesunique. The"media" element hasguidelines for generating anonymous URIs in RFC 3323 [8] should be followed. For example, "Anonymous1" <sip:anonymous1@anonymous.invalid> could be used for a participant requesting privacy. state: This mandatory"media-type"attributewhich identifiesindicates whether themediadocument contains the whole conference information ("full"), only the information that has changed since the previous document ("partial"), or the conference ceased to exist ("deleted"). This type(e.g. audio, video, message and application) and MUST have onedefines an extendable sequence of thevalues registered for "media" of SDP [12]. Thefollowing optional"id" attribute serves as a unique reference to a "media"child elements. 6.1.5.1 display-text of string type This elementwithincontains the"user" element. It MUST be includeddisplay text foreach "media"the user. 6.1.5.2 associated-aors of anyURI type This elementfor all notifications ifcontains associated URIs of thefocus uses "partial" user notifications foruser. Usually thisconference. Otherwise, the "id" attribute MAYinformation will beomitted. If the user "state" is "full",manually provided by a system administrator showing thestatelogical association between signaling entities otherwise independent. 6.1.5.3 roles ofits "media" element(s) MUST be "full". If the user "state" is "partial",user-roles-type This element contains thestateroles ofits "media" element(s) MAY be either "partial" or "full".the user. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page13]18] Internet-Draft Conference PackageJulyOctober 20044.1.1.3.2 Media Elements6.1.5.4 language of language type This element contains the language used by the user. 6.1.5.5 cascaded-focus of anyURI type This element contains a conference URI (different from the main conference URI) for users that are connected to the main conference as a result of focus cascading. In accordance with the SIP conferencing framework [15], this package allows for representation of peer-to-peer (i.e. "flat") focus cascading only. The"media"actual cascading graph can not be deduced from the information provided in the package alone. Advanced applications can construct the graph by subscribing to both this package and the Dialog Package [16] of the cascaded foci and correlating the relevant information. 6.1.5.6 endpoint of endpoint-type This elementhas alsocontains information about anoptional "proto" sub-element, which MUST hasendpoint of thevalue registered for "proto"user. The element ofSDP [12]. An optional "ssrc" sub-element, if present, carriesthevalueendpoint-type can have unbounded number ofSSRC (definedappearance inRTP/RTCP [10]) as generated bytheuseruser-type for each endpoint of thestream it sends. When an RTP mixer generatesuser participating in the conference. In aCSRC list according to RTP/RTCP [10], it insertscase when authentication is performed per endpoint (rather than per user) in alist of the SSRC identifierssystem, a focus can be not aware of thesources that contributed tological association among endpoints being used by thegeneration of a particular packet intosame user. In this case theRTP header of that packet. "An example application is audio conferencing where a mixer indicates allfocus MAY present thetalkers whose speech was combinedendpoints as belonging toproduce the outgoing packet, allowingseparate users in thereceiverconference schema. In a different case, due toindicateprivacy concerns for a user thecurrent talker, even though allfocus may want to shield theaudio packets containinformation about multiple endpoints from thesame SSRC identifier (thatrecipients of themixer)." An optional "info" sub-element, if present, carries a human readable description for this stream populated byConference document. To do so thefocus. The value of this element corresponds tofocus MAY aggregate the multiple endpoint informationmedia attribute "i" in SDP [12]. An optional "label" sub-element, if present, carriesinto aunique identifier for this stream among all streams in the conference and is assigned by the focus. The value of thissingle endpoint elementcorresponds tounder this user. 6.1.6 Endpoint Type This type has the"label" media attribute in SDP [12] and defined in [18]. An optional "instance" sub-element, if present, carries a URI, which MUST uniquely identifyfollowing attributes: entity: The mandatory attribute contains thesignaling dialog being usedendpoint URI forestablishing of this media stream.the user in the conference. InSIP, for example, values ofSIP terms, this is the Contact URI orGRUU [17] canGRUU. The "entity" attribute MUST beused for this purpose. Itunique in the endpoint element list because it isRECOMMENDED to includeused as the"instance" information for every user that has more thankey in partial notifications about users' endpoints. An anonymous participant in asingle dialog associated with the conference. This elementconference SHOULDNOTbeincluded forrepresented by an anonymousparticipant. An optional "status" sub-element, if present, is used to remove "media" elements during partial notifications. Optional "snd-status" and "rcv-status" sub-elements, if present, describeURI generated by thestatus of media streams infocus. For multiple anonymous participants, the focus must ensure that eachdirection. 4.1.1.4 User Roleanonymous URI is unique. Theoptional "role" element conveys the role of the user in the conference, e.g. participant, presenter, panelist, host, etc. User's role MAY change dynamically in the course of the conference. Also, a user MAY have more than a single roleguidelines for generating anonymous URIs inone time.RFC 3323 [8] should be followed. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page14]19] Internet-Draft Conference PackageJulyOctober 2004 state: Thisdocument does not define fixed values formandatory attribute indicates whether the"role" element, instead it is expected that conferencing applications will define custom-fit roles by templates. 4.1.2 Sidebar Element The sidebarelementis of the general "conference-type" and MAY use allcontains theattributes and elements defined by it. Typically,whole endpoint information ("full"), only the"entity", which uniquely identifies the sidebar, and the "user" elements will be useful to present toinformation that has changed since themajority ofprevious document ("partial"), or theparticipants inendpoint has been deleted from theconference. The "conference-type" mandatory attributes MUST be included for each sidebar. The valueconference ("deleted"). This type defines an extendable sequence of the"version" attribute is meaninglessfollowing optional child elements. 6.1.6.1 display-text of string type This element contains the display text for"sidebar" elements and MUST be ignored because it is always overruled bythe"version" attributeendpoint. 6.1.6.2 referred of execution-type This element contains themain "conference-info". IfURI of the user who's action resulted in this endpoint being brought into themainconference"state" is "full",(e.g. the user identified by this URI sent a REFER to the focus). 6.1.6.3 state ofits sidebar(s) MUST be "full". If the main conference "state" is "partial",endpoint-state-type This element contains the state ofits sidebar(s) MAY be either "full" or "partial". The "entity" URI attribute MUST be unique amongthesidebar identifiers ofendpoint, and can assume thesame conference. Attribute "entity"following values: connected: The endpoint isused as the key for "sidebar" elements in partial notifications for "conference-info". 4.1.3 Additional Conference Identifiers In addition to the Conference URI present in the "entity" attribute,aconference MAY have additional URIs of various types. Connecting to these URIs will resultparticipant injoining tothesameconference.4.1.4 Policy URIs A policy URI specifies whereDepending on the media policies, he/she can send andhow a certain policy pertainingreceive media to and from other participants. disconnected: The endpoint is not a participant in the conferencecan be accessed. The actual policy nameandusage is deduced fromno active dialog exists between theURI schema name. An exampleendpoint and the focus. on-hold: Active SIP dialog exists between an endpoint and a focus, but endpoint is "on-hold" for this conference, i.e. neither he/she is "hearing" the"policy-uri" usageconference mix, nor isinclusion ofhis/her media being mixed in theURI ofconference. As an example, theCPCP [16]. A subscriberendpoint has asked to join the conference using SIP, but his/her participation is pending based on moderator approval. In the meantime he/she is hearing music-on-hold or some other kind of related content. muted-via-focus: Active SIP dialog exists between an endpoint and a focus and theConference packageendpoint canuse the Policy URI"listen" toaccess and modifytheconference policy. 4.1.5 Recording In many cases, legal regulations require conference providers to announce toconference, but endpoint's media is not being mixed into theparticipantsconference. Note that sometimes aspecific conferencesubset of endpoint media streams can be muted by focus (such as poor quality video) while others (such as voice or IM) can still be active. In this case, it isbeingRECOMMENDED that the "aggregated" endpoint connectivity "status" reflects the status of the mostly active media. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page15]20] Internet-Draft Conference PackageJulyOctober 2004recorded. In additionpending: Endpoint is not yet in the session, but it is anticipated that he/she will join in the near future. alerting: A PSTN ALERTING or SIP 180 Ringing was returned for the outbound call, endpoint is being alerted. dialing-in: Endpoint is dialing into the conference, not yet in the roster (probably being authenticated). dialing-out: Focus has dialed out to connect therecording "status" information,endpoint to the"recording" element MAY includeconference, but theURIs specifyingendpoint is not yet in thelocation androster (probably being authenticated). disconnecting: Focus is in theformatprocess of disconnecting endpoint (either DISCONNECT or BYE was sent to therecorded data. Typically, the recorded data becomes available afterendpoint's device). Note that theconference ends. Multiple URIs can be provided, for example, specifying different content types. For Web-Page embedded media,defined transient states (e.g., disconnecting, alerting, etc.) could generate aplain HTTP URIlot of notifications. Implementations MAYbe provided. 4.1.6 Streaming The "streaming" element,choose not to generate notifications on these to all participants ifpresent, specifies whetherit will generate too much traffic. 6.1.6.4 joining-method of joining-type This element contains method by which theconference output is being streamed (to general public, for example),endpoint joined the conference, and can assume the following values: dialed-in: The endpoint dialed into the conference, i.e. sent INVITE to the focus, which resulted inwhat streaming format, and at what (e.g. multicast) addresses it can be listened at. RTSP [11] is an example of such streaming protocol. 4.2 Constructing Coherent Statesuccessful dialog establishment. dialed-out: The focus has brought the endpoint into the conferenceinformation is describedby sending ahierarchal XML structure withsuccessful INVITE to theroot element "conference-info".endpoint. focus-owner: Theroot elementendpoint is the focus for this conference. This status is used only when a participant UA acts as a conference focus. 6.1.6.5 joining-info of execution-type This elementincontains information about how theschemaendpoint joined and can contain the following sub-elements: when: This element contains the date and time thatcarries meaningful version number for alltheelements inendpoint joined thedocument. The whole conference information is associated with this version number. The version number MUST be initialized withconference. Rosenberg, et al. Expires April 25, 2005 [Page 21] Internet-Draft Conference Package October 2004 reason: This element contains thevalue ofreason the"version" attribute fromendpoint joined the"conference-info"conference. by: This elementin the first document received. Each time a new document is received,contains thevalueURI of thelocal version number, andentity who caused the"version" attribute inendpoint to join thenew document, are compared. Ifconference. 6.1.6.6 disconnection-method of disconnection-type This element contains method by which thevalue inendpoint departed thenew document is one higher thanconference, and can assume thelocal version number,following values: departed: The endpoint sent a BYE, thus leaving thelocal version number is increasedconference. booted: The endpoint was sent a BYE byone, andthedocument is processed. If the value infocus, booting him/her out of thedocument is more than one higher thanconference. Alternatively, thelocal version number,endpoint tried to dial into to conference without success because was rejected by the focus according to localversion number is setpolicy decisions. failed: The server tried to bring thevalue in the new document, the document is processed, andendpoint into thesubscriber SHOULD generate a refresh requestconference, but its attempt totrigger a full state notification. Ifcontact thevaluespecific endpoint resulted in a non-200 class final response. Alternatively, thedocument is less than the local version,endpoint tried to dial into thedocument is discardedconference withoutprocessing. Further processingsuccess due to technical reasons. 6.1.6.7 disconnection-info of disconnection-type This element contains information about the endpoint's departure from the conferenceinformation document depends on whether it contains full or partial state. If itand can contain the following sub-elements: when: This element containsfull state, indicated bythevalue ofdate and time that the"state" attribute inendpoint departed the"conference-info" element,conference. reason: This element contains thewhole local content is flushed and repopulated fromreason thedocument. Ifendpoint departed thedocumentconference. by: This element containspartial state, as indicated bythevalueURI of the"state" attribute in the "conference-info" element,entity who caused thedocument is usedendpoint toupdatedepart thelocal content as described below. Rosenberg, et al. Expires January 16, 2005 [Page 16] Internet-Draft Conference Package July 2004 All sub-elementsconference. 6.1.6.8 whispering-to of uris-type If an endpoint is participating in a whisper session with other entities, the"conference-info" hierarchal XML structure canURIs of these other entities MAY beclassifiedcontained intwo groups: those that carry relatively small amountthis element. 6.1.6.9 media ofdata and those that can potentially carrymedia-type This element contains information about alotmedia stream ofdata. During partial notifications, the light elements are updated as atomic piecesthis endpoint. The element ofdata. Ontheother hand, elements thatmedia-type cancarry a substantial amount of data have the general "state" attribute attached to them. That is in order to support partial notifications for their content. A "state" attributehave unbounded number ofa child elementRosenberg, et al. Expires April 25, 2005 [Page 22] Internet-Draft Conference Package October 2004 appearance in thedocument MUST adhere to its parent "state". It means that if the parent's "state" is "full", the stateendpoint-type for each media stream ofits children MUST be "full". Iftheparent's "state"endpoint. Note that it is"partial", the state of its childrenpossible that media streams listed under a common endpoint MAY beeither "partial" or "full". For elements with optional "state" attribute, ifestablished by separate signaling means and consequently belong to different signaling "calls". 6.1.7 Media Type This type has the following attributes: entity: The mandatory attribute isnot included for an element, it means that the element's statea unique identifier of a media stream on a per endpoint basis. This attribute is"full". Forused as aparent element with "state", its sub-elements with possible multiple appearances under the parent have keys that uniquelykey to identifyeach element among others inmedia streams which may be added and deleted on a dynamic basis during thesame list. 4.2.1 The Algorithmconference. Theconference package subscriber locally maintains a local element for eachvalue of this elementinSHOULD correspond to theschema and a table for each "element with key(s)""mid" value in theschema. The tables are indexed by the key(s)SDP document as defined inschema for the element. Starting from outer elementsGrouping of Media Lines in thereceived document, 1. IfSDP [9]. state: This mandatory attribute indicates whether theparentelement containsfull state,theelement is replaced withwhole media information ("full"), only thenewinformationas a whole. 2. Otherwise, ifthat has changed since theparentprevious document ("partial"), or the media element has been deleted from the conference document ("deleted"). This type defines an extendable sequence of the following optional child elements. 6.1.7.1 display-text of string type This element containspartial state, 2.1 For elements with keys, the subscriber comparesthekeys received indisplay text for theupdate withmedia stream. 6.1.7.2 proto of string type This element contains thekeys inmedia type for thelocal tables. 2.1.1 Ifmedia stream. The value of this element MUST be akey doesn't existvalue registered for "proto" of SDP [12]. 6.1.7.3 ssrc of string type The "ssrc" element carries the value of SSRC (defined in RTP/RTCP [10]) as generated by thelocal table,endpoint for the stream it sends. When an RTP mixer generates arow is added, and its content is setCSRC list according to RTP/RTCP [10], it inserts a list of theelement information fromSSRC identifiers of theupdate. 2.1.2 Otherwise, ifsources that contributed to the generation of akeyparticular packet into the RTP header of that packet. "An example application is audio conferencing where a mixer indicates all thesame value does exist, for each sub-element intalkers whose speech was combined to produce therowoutgoing packet, allowing thealgorithm is applied from step 2.2. 2.2 For each atomic element received inreceiver to indicate theschema,current talker, even though all theelement is replaced withaudio packets contain thenew information as a whole. Also, for each non-atomic element received insame SSRC identifier (that of theschema with either no "state"mixer)." Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page17]23] Internet-Draft Conference PackageJulyOctober 2004 6.1.7.4 label of string type The element "label" carries a unique identifier for this stream among all streams in the conference and is assigned by the focus. The value of this element corresponds to the "label" media attributeincludedin SDP [12] and defined in [19]. 6.1.7.5 state of media-state-type The element "state" contains the state of the media stream and can have the values "active", "inactive", or "muted". 6.1.7.6 snd-status of media-state-type The element "state" contains the stateattribute is set to "full",of theelement is replaced withsending media stream (from thenew information as a whole. 2.2.1 Ifperspective of theupdatedendpoint) and can have the values "active", "inactive", orcreated"muted". 6.1.7.7 rcv-status state of media-state-type The elementcarries"state" contains the"removed" status, that element SHOULD be removed fromstate of thelocal content. Ifreceiving media stream (from theelement is updatedperspective of the endpoint) and can have the values "active", "inactive", orcreated, such that it is empty, that"muted". 6.1.7.8 call of call-type The "call" elementMAY be removed fromcontains thelocal content at any time. 2.3 For each non-atomic element with"sip" sub-element which contains thestate attribute set to "partial",SIP dialog identifier of thealgorithm is applied recursively starting from step 2. 4.3endpoint's dialog with the focus. The "sip" element includes sub-elements "display-text", "call-id", "to-tag", "from-tag" Rosenberg, et al. Expires April 25, 2005 [Page 24] Internet-Draft Conference Package October 2004 7. Schema <?xml version="1.0" encoding="UTF-8" ?> <xs:schema targetNamespace="urn:ietf:params:xml:ns:conference-info" xmlns:tns="urn:ietf:params:xml:ns:conference-info" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:ietf:params:xml:ns:conference-info" elementFormDefault="qualified" attributeFormDefault="unqualified"> <!-- This import brings in the XML language attribute xml:lang --> <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/03/xml.xsd" /> <!-- CONFERENCE ELEMENT --> <xs:element name="conference-info"type="tns:conference-type"/>type="conference-type"/> <!-- CONFERENCE TYPE --> <xs:complexType name="conference-type"> <xs:sequence> <xs:element name="conference-description" type="conference-description-type" minOccurs="0"/> <xs:element name="host-info" type="host-type" minOccurs="0"/> <xs:element name="conference-state" type="conference-state-type" minOccurs="0"/> <xs:element name="user" type="user-type" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="sidebars-by-ref" type="uris-type" minOccurs="0"/> <xs:element name="sidebar-by-val" type="conference-type" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="entity" type="xs:anyURI" use="required"/> <xs:attribute name="state" type="state-type" use="optional"/> <xs:attribute name="version" type="xs:string" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- STATE TYPE --> <xs:simpleType name="state-type"> <xs:restriction base="xs:string"> <xs:enumerationvalue="full" />value="full"/> <xs:enumerationvalue="partial" />value="partial"/> <xs:enumeration value="deleted"/> </xs:restriction> </xs:simpleType> <!-- CONFERENCE DESCRIPTION TYPE --> <xs:complexTypename="conference-type">name="conference-description-type"> <xs:sequence> Rosenberg, et al. Expires April 25, 2005 [Page 25] Internet-Draft Conference Package October 2004 <xs:elementname="user" type="user-type" minOccurs="0" maxOccurs="unbounded" />name="display-text" type="xs:string" minOccurs="0"/> <xs:elementname="sidebar" type="conference-type"name="subject" type="xs:string" minOccurs="0"/> <xs:element name="free-text" type="xs:string" minOccurs="0"/> <xs:element name="keywords" type="keywords-type" minOccurs="0"/> <xs:element name="web-page" type="xs:anyURI" minOccurs="0"/> <xs:element name="conf-uris" type="uris-type" minOccurs="0"/> <xs:element name="service-uris" type="uris-type" minOccurs="0"/> <xs:element name="maximum-user-count" type="user-count-type" minOccurs="0"/> <xs:element name="available-media" type="conference-medias-type" minOccurs="0"/> <xs:element name="extended" type="extended-type" minOccurs="0"maxOccurs="unbounded" />maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="state" type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- HOST TYPE --> <xs:complexType name="host-type"> <xs:sequence> <xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="web-page" type="xs:anyURI" minOccurs="0"/> <xs:element name="uris" type="uris-type" minOccurs="0"/> <xs:elementname="conf-ids" type="conf-ids-type"name="extended" type="extended-type" minOccurs="0"maxOccurs="1" />maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="state" type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- CONFERENCE STATE TYPE --> <xs:complexType name="conference-state-type"> <xs:sequence> <xs:element name="user-count" type="user-count-type" minOccurs="0"/> <xs:element name="security-level" type="security-level-type" minOccurs="0"/> <xs:element name="active" type="xs:boolean" minOccurs="0"/> <xs:elementname="policy-ids" type="policy-ids-type" minOccurs="0" maxOccurs="1" />name="locked" type="xs:boolean" minOccurs="0"/> <xs:element name="recording"type="recording-type" minOccurs="0" maxOccurs="1" />type="uris-type" minOccurs="0"/> <xs:elementname="streaming" type="streaming-type" minOccurs="0" maxOccurs="1" /> <xs:any processContents="lax"name="active-media" type="conference-medias-type" minOccurs="0"/> <xs:element name="extended" type="extended-type" minOccurs="0"maxOccurs="unbounded" />maxOccurs="unbounded"/> </xs:sequence> <xs:attributename="version" type="xs:nonNegativeInteger" use="required"/> <xs:attributename="state"type="tns:state-type" use="required"/> <xs:attribute name="entity" type="xs:anyURI" use="required"/> <xs:anyAttribute />type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- CONFERENCE MEDIAS TYPE --> <xs:complexType name="conference-medias-type"> <xs:sequence> <xs:element name="entry" type="conference-media-type" maxOccurs="unbounded"/> Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page18]26] Internet-Draft Conference PackageJulyOctober 2004 </xs:sequence> <xs:attribute name="state" type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- CONFERENCE MEDIA TYPE --> <xs:complexTypename="conf-ids-type">name="conference-media-type"> <xs:sequence> <xs:elementname="conf-uri" type="xs:anyURI" minOccurs="0" maxOccurs="unbounded" /> <xs:any processContents="lax"name="proto" type="xs:string"/> <xs:element name="extended" type="extended-type" minOccurs="0"maxOccurs="unbounded" />maxOccurs="unbounded"/> </xs:sequence><xs:anyAttribute /><xs:anyAttribute/> </xs:complexType> <!-- CONFERENCE URIs TYPE --> <xs:complexTypename="policy-ids-type">name="uris-type"> <xs:sequence> <xs:elementname="policy-uri" type="xs:anyURI" minOccurs="0" maxOccurs="unbounded" /> <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded" />name="entry" type="uri-type" maxOccurs="unbounded"/> </xs:sequence><xs:anyAttribute /><xs:attribute name="state" type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- CONFERENCE URI TYPE --> <xs:complexTypename="recording-type">name="uri-type"> <xs:sequence> <xs:element name="uri"type="xs:anyURI" minOccurs="0" maxOccurs="unbounded" /> <xs:any processContents="lax"type="xs:anyURI"/> <xs:element name="label" type="xs:string" minOccurs="0"/> <xs:element name="modified" type="execution-type" minOccurs="0"/> <xs:element name="extended" type="extended-type" minOccurs="0"maxOccurs="unbounded" />maxOccurs="unbounded"/> </xs:sequence> <xs:anyAttribute/> </xs:complexType> <!-- USER COUNT TYPE --> <xs:complexType name="user-count-type"> <xs:sequence> <xs:element name="entry" type="count-type" maxOccurs="unbounded"/> </xs:sequence> <xs:attributename="status" type=="stream-status-type" use="required"/> <xs:anyAttribute />name="state" type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- Rosenberg, et al. Expires April 25, 2005 [Page 27] Internet-Draft Conference Package October 2004 COUNT TYPE --> <xs:complexTypename="streaming-type">name="count-type"> <xs:sequence> <xs:elementname="uri" type="xs:anyURI" minOccurs="0" maxOccurs="unbounded" /> <xs:any processContents="lax"name="role" type="user-role-type"/> <xs:element name="count" type="xs:nonNegativeInteger"/> <xs:element name="extended" type="extended-type" minOccurs="0"maxOccurs="unbounded" />maxOccurs="unbounded"/> </xs:sequence><xs:attribute name="status" type="stream-status-type" use="required"/> <xs:anyAttribute /><xs:anyAttribute/> </xs:complexType> <!-- SECURITY LEVEL TYPE --> <xs:simpleType name="security-level-type"> <xs:restriction base="xs:string"> <xs:enumeration value="none"/> <xs:enumeration value="low"/> <xs:enumeration value="medium"/> <xs:enumeration value="high"/> </xs:restriction> </xs:simpleType> <!-- KEWORDS TYPE --> <xs:simpleType name="keywords-type"> <xs:list itemType="xs:string"/> </xs:simpleType> <!-- USER TYPE --> <xs:complexType name="user-type"> <xs:sequence> <xs:elementname="status" type="tns:user-status-type"name="display-text" type="xs:string" minOccurs="0"/> <xs:elementname="joining-mode" type="tns:user-joining-mode-type"name="associated-aors" type="uris-type" minOccurs="0"/> <xs:elementname="disconnection-reason" type="tns:user-disconnection-reason-type"name="roles" type="user-roles-type" minOccurs="0"/> <xs:elementname="media" type="tns:media-type"name="language" type="xs:language" minOccurs="0"/> <xs:element name="cascaded-focus" type="xs:anyURI" minOccurs="0"/> <xs:element name="endpoint" type="endpoint-type" minOccurs="0" maxOccurs="unbounded"/> <xs:elementname="role" type="xs:string"name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="entity" type="xs:anyURI"/> <xs:attribute name="state" type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- USER ROLES TYPE --> <xs:complexType name="user-roles-type"> Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page19]28] Internet-Draft Conference PackageJulyOctober 2004<xs:any processContents="lax" minOccurs="0"<xs:sequence> <xs:element name="entry" type="user-role-type" maxOccurs="unbounded"/> </xs:sequence> <xs:attributename="uri" type="xs:anyURI" use="required"/> <xs:attribute name="display-name" type="xs:string"name="state" type="state-type" use="optional"/> <xs:anyAttribute/> </xs:complexType> <!-- USER ROLE TYPE --> <xs:complexType name="user-role-type"> <xs:choice> <xs:element name="label" type="xs:string"/> </xs:choice> <xs:attributeref="xml:lang"name="conf-template" type="xs:string" use="optional"/> </xs:complexType> <!-- ENDPOINT TYPE --> <xs:complexType name="endpoint-type"> <xs:sequence> <xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="referred" type="execution-type" minOccurs="0"/> <xs:element name="state" type="endpoint-state-type" minOccurs="0"/> <xs:element name="whispering-to" type="uris-type" minOccurs="0"/> <xs:element name="joining-method" type="joining-type" minOccurs="0"/> <xs:element name="joining-info" type="execution-type" minOccurs="0"/> <xs:element name="disconnection-method" type="disconnection-type" minOccurs="0"/> <xs:element name="disconnection-info" type="execution-type" minOccurs="0"/> <xs:element name="media" type="media-type" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attributename="cascaded-focus" type="xs:anyURI" use="optional"/>name="entity" type="xs:anyURI"/> <xs:attribute name="state"type="tns:state-type"type="state-type" use="optional"/><xs:anyAttribute /><xs:anyAttribute/> </xs:complexType> <!-- ENDPOINT STATE TYPE --> <xs:simpleTypename="user-status-type">name="endpoint-state-type"> <xs:restriction base="xs:string"> <xs:enumerationvalue="connected"/> <xs:enumeration value="disconnected"/> <xs:enumeration value="on-hold"/>value="pending"/> <xs:enumerationvalue="muted-via-focus"/>value="dialing-out"/> <xs:enumerationvalue="blocked"/>value="dialing-in"/> <xs:enumerationvalue="pending"/>value="alerting"/> <xs:enumerationvalue="calling"/>value="on-hold"/> <xs:enumerationvalue="ringing"/>value="connected"/> <xs:enumerationvalue="dialing-in"/>value="muted-via-focus"/> Rosenberg, et al. Expires April 25, 2005 [Page 29] Internet-Draft Conference Package October 2004 <xs:enumeration value="disconnecting"/> <xs:enumerationvalue="removed"/>value="disconnected"/> </xs:restriction> </xs:simpleType> <!-- JOINING TYPE --> <xs:simpleTypename="user-joining-mode-type">name="joining-type"> <xs:restriction base="xs:string"> <xs:enumerationvalue="dialed-in" />value="dialed-in"/> <xs:enumerationvalue="dialed-out" />value="dialed-out"/> <xs:enumerationvalue="focus-owner" />value="focus-owner"/> </xs:restriction> </xs:simpleType> <!-- DISCONNECTION TYPE --> <xs:simpleTypename="user-disconnection-reason-type">name="disconnection-type"> <xs:restriction base="xs:string"> <xs:enumerationvalue="departed" />value="departed"/> <xs:enumerationvalue="booted" />value="booted"/> <xs:enumerationvalue="failed" />value="failed"/> </xs:restriction> </xs:simpleType> <!-- EXECUTION TYPE --> <xs:complexType name="execution-type"> <xs:sequence> <xs:element name="when" type="xs:dateTime" minOccurs="0"/> <xs:element name="reason" type="xs:string" minOccurs="0"/> <xs:element name="by" type="xs:anyURI" minOccurs="0"/> </xs:sequence> <xs:anyAttribute/> </xs:complexType> <!-- MEDIA TYPE --> <xs:complexType name="media-type"> <xs:sequence> <xs:elementname="proto"name="display-text" type="xs:string" minOccurs="0"/>Rosenberg, et al. Expires January 16, 2005 [Page 20] Internet-Draft Conference Package July 2004<xs:elementname="ssrc" type="xs:nonNegativeInteger"name="proto" type="xs:string" minOccurs="0"/> <xs:elementname="info"name="ssrc" type="xs:string" minOccurs="0"/> <xs:element name="label" type="xs:string" minOccurs="0"/> <xs:elementname="instance" type="xs:anyURI" minOccurs="0"/> <xs:element name="status" type="tns:media-status-type"name="state" type="media-state-type" minOccurs="0"/> <xs:element name="snd-status"type="tns:stream-status-type"type="media-state-type" minOccurs="0"/> <xs:element name="rcv-status"type="tns:stream-status-type"type="media-state-type" minOccurs="0"/><xs:any processContents="lax"Rosenberg, et al. Expires April 25, 2005 [Page 30] Internet-Draft Conference Package October 2004 <xs:element name="call" type="call-type" minOccurs="0"/> <xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attributename="media"name="entity" type="xs:string" use="required"/> <xs:attributename="id" type="nonNegativeInteger" use="optional"/> <xs:attributename="state"type="tns:state-type"type="state-type" use="optional"/><xs:anyAttribute /><xs:anyAttribute/> </xs:complexType> <!-- MEDIA STATUS TYPE --> <xs:simpleTypename="media-status-type"> <xs:restriction base="xs:string"> <xs:enumeration value="removed" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="stream-status-type">name="media-state-type"> <xs:restriction base="xs:string"> <xs:enumerationvalue="on"/>value="active"/> <xs:enumerationvalue="off"/>value="inactive"/> <xs:enumerationvalue="muted" />value="muted"/> </xs:restriction> </xs:simpleType> <!-- CALL TYPE --> <xs:complexType name="call-type"> <xs:choice> <xs:element name="sip" type="sip-dialog-id-type"/> <xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> </xs:choice> <xs:anyAttribute/> </xs:complexType> <!-- SIP DIALOG ID TYPE --> <xs:complexType name="sip-dialog-id-type"> <xs:sequence> <xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="dialog-id" type="xs:string"/> <xs:element name="from-tag" type="xs:string"/> <xs:element name="to-tag" type="xs:string"/> <xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:anyAttribute/> </xs:complexType> <!-- EXTENDED TYPE --> <xs:complexType name="extended-type"> <xs:sequence> <xs:any minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="target-namespace" type="xs:string" use="required"/> Rosenberg, et al. Expires April 25, 2005 [Page 31] Internet-Draft Conference Package October 2004 </xs:complexType> </xs:schema>4.4Rosenberg, et al. Expires April 25, 2005 [Page 32] Internet-Draft Conference Package October 2004 8. Examples 8.1 Basic Example The following is an example conference information document: <conference-info entity="sips:conf233@example.com" state="partial" version="5" > <!-- CONFERENCE INFO --> <conference-description> <subject>Agenda: This month's target</subject> <service-uris> <entry> <uri>http://salesgroup.example.com/conference-policies/sales-weekly-meeting.xml</uri> <label>CPCP</label> </entry> </service-uris> </conference-description> <!-- CONFERENCE STATE --> <conference-state> <user-count> <entry> <role> <label>any</label> </role> <count>33</count> </entry> </user-count> <active-media> <entry> <proto>audio</proto> </entry> </active-media> </conference-state> <!-- USER --> <user entity="sip:bob@example.com" state="full"> <display-text>Bob Hoskins</display-text> <!-- ENDPOINTS --> <endpoint entity="sip:bob@pc33.example.com"> Rosenberg, et al. Expires April 25, 2005 [Page 33] Internet-Draft Conference Package October 2004 <display-text>Bob's Laptop</display-text> <state>disconnected</state> <disconnection-method>departed</disconnection-method> <disconnection-info> <when>2005-03-04T20:00:00Z</when> <reason>bad voice quality</reason> <by>sip:mike@example.com</by> </disconnection-info> <!-- MEDIA --> <media entity="1"> <display-text>main audio</display-text> <proto>audio</proto> <ssrc>432424</ssrc> <label>34567</label> <state>active</state> </media> </endpoint> </user> <!-- USER --> <user entity="sip:alice@example.net" state="full"> <display-text>Alice</display-text> <!-- ENDPOINTS --> <endpoint entity="sip:4kfk4j392jsu@example.net;grid=433kj4j3u"> <state>connected</state> <joining-method>dialed-out</joining-method> <joining-info> <when>2005-03-04T20:00:00Z</when> <by>sip:mike@example.com</by> </joining-info> <!-- MEDIA --> <media entity="1"> <display-text>main audio</display-text> <proto>audio</proto> <ssrc>534232</ssrc> <label>34564</label> <state>active</state> </media> Rosenberg, et al. Expires April 25, 2005 [Page 34] Internet-Draft Conference Package October 2004 </endpoint> </user> </conference-info> 8.2 Rich Example The following is an example conference information document. In this example of a partial state notification, there are 32 participants in a voice conference. The user Bob has been booted from the conference by Mike due to bad voice quality. Note that there are three sidebars in the conference, two are referenced just by their sidebar URI and information about the third sidebar is included in this notification. Also note that while this conference offers both audio and video capabilities, only audio is currently in use. <conference-info entity="sips:conf233@example.com" state="partial" version="5" > <!-- CONFERENCE INFO --> <conference-description> <display-text>Weekly Sales Meeting</display-text> <subject>Agenda: This month's target</subject> <free-text>xyz</free-text> <keywords>sales, meeting, weekly</keywords> <web-page>http://sharepoint/salesgroup/</web-page> <conf-uris> <entry> <uri>tel:+18005671234</uri> <label>TTI Bridge</label> </entry> <entry> <uri>h323:conf545@h323.example.com</uri> </entry> </conf-uris> <service-uris> <entry> <uri>http://salesgroup.example.com/conference-policies/sales-weekly-meeting.xml</uri> <label>CPCP</label> </entry> </service-uris> <maximum-user-count> <entry> <role> <label>any</label> </role> <count>52</count> Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page21]35] Internet-Draft Conference PackageJulyOctober 2004<?xml version="1.0" encoding="utf-8" ?> <conference-info version="0" state="full" entity="sip:conf233@example.com"></entry> <entry> <role conf-template="Basic"> <label>participant</label> </role> <count>50</count> </entry> </maximum-user-count> <available-media> <entry> <proto>audio</proto> </entry> <entry> <proto>video</proto> </entry> </available-media> </conference-description> <!-- HOST INFO --> <host-info> <display-text>Sales Host</display-text> <web-page>http://sharepoint/salesgroup/hosts/</web-page> <uris> <entry> <uri>sip:sales@example.com</uri> </entry> </uris> </host-info> <!-- CONFERENCE STATE --> <conference-state> <user-count> <entry> <role> <label>any</label> </role> <count>33</count> </entry> <entry> <role conf-template="Basic"> <label>participant</label> </role> <count>32</count> </entry> </user-count> <security-level>medium</security-level> Rosenberg, et al. Expires April 25, 2005 [Page 36] Internet-Draft Conference Package October 2004 <active>true</active> <locked>false</locked> <recording> <entry> <uri>http://quicktime.streaming.com/54634/recording.mov</uri> <label>Quicktime</label> </entry> <entry> <uri>http://real.streaming.com/54634/recording.ram</uri> </entry> </recording> <active-media> <entry> <proto>audio</proto> </entry> </active-media> </conference-state> <!-- USERS --> <useruri="sip:bob@example.com" display-name="Bob Jones"> <status>connected</status> <joining-mode>dialed-in</joining-mode>entity="sip:bob@example.com" state="full"> <display-text>Bob Hoskins</display-text> <associated-aors> <entry> <uri>mailto:bob@example.com</uri> <label>email</label> </entry> </associated-aors> <roles> <entry> <label>participant</label> </entry> </roles> <language>en</language> <!-- ENDPOINTS --> <endpoint entity="sip:bob@pc33.example.com"> <display-text>Bob's Laptop</display-text> <referred> <when>2005-03-04T20:00:00Z</when> <by>sip:mike@example.com</by> </referred> <state>disconnecting</state> <whispering-to> <entry> <uri>sip:rob@example.com</uri> Rosenberg, et al. Expires April 25, 2005 [Page 37] Internet-Draft Conference Package October 2004 </entry> <entry> <uri>sip:helen@example.com</uri> </entry> </whispering-to> <joining-method>dialed-out</joining-method> <joining-info> <when>2005-03-04T20:00:00Z</when> <reason>invitation</reason> <by>sip:mike@example.com</by> </joining-info> <disconnection-method>booted</disconnection-method> <disconnection-info> <when>2005-03-04T20:00:00Z</when> <reason>bad voice quality</reason> <by>sip:mike@example.com</by> </disconnection-info> <!-- MEDIA --> <mediamedia="audio"> <proto>RTP/AVP</proto> <ssrc>583398</ssrc>entity="1" state="full"> <display-text>main audio</display-text> <proto>audio</proto> <ssrc>432424</ssrc> <label>34567</label> <state>active</state> <call> <sip> <display-text>full info</display-text> <dialog-id>hsjh8980vhsb78</dialog-id> <from-tag>vav738dvbs</from-tag> <to-tag>8954jgjg8432</to-tag> </sip> </call> </media> </endpoint> </user> <!-- SIDEBARS BY REFERENCE --> <sidebars-by-ref> <entry> <uri>sips:conf233@example.com; grid=45</uri> Rosenberg, et al. Expires April 25, 2005 [Page 38] Internet-Draft Conference Package October 2004 <label>sidebar with Carol</label> </entry> <entry> <uri>sips:conf233@example.com; grid=21</uri> <label>private sidebar with Peter</label> </entry> </sidebars-by-ref> <!-- SIDEBARS BY VALUE --> <sidebar-by-val entity="sips:conf233@example.com; grid=77" state="partial"> <useruri="sip:barbara@example.com" display-name="Barbara Jones"> <status>on-hold</status> </user> <user uri="sip:bill@example.com" display-name="Bill Minelli"> <status>on-hold</status> </user> <sidebar version="0" state="full" entity="sip:conf233.1@example.com">entity="sip:bob@example.com" state="partial"></user> <useruri="sip:barbara@example.com" />entity="sip:mark@example.com" state="partial"></user> <useruri="sip:bill@example.com" /> </sidebar> <conf-ids> <conf-uri>tel:+18005671234</conf-uri> <conf-uri>h323:conf545@example.com</conf-uri> </conf-ids> <recording status="on"> <uri>http://quicktime.streaming.com/54634/recording.mov</uri> <uri>http://real.streaming.com/54634/recording.ram</uri> <uri>http://windowsmedia.streaming.com/54634/recording.wmv</uri> <uri>http://www.streaming.com/54634/recording.html</uri> </recording>entity="sip:dan@example.com" state="partial"></user> </sidebar-by-val> </conference-info>This conference currently has three users, two of which are in a sidebar conversation. The conference is being recorded. There are additional means to join the conference either by phone using tel URI [14] or by H.323 protocol using H.323 URL [13].Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page22]39] Internet-Draft Conference PackageJulyOctober 20045.9. Security Considerations Subscriptions to conference state can reveal very sensitive information. For this reason, the document recommends authentication and authorization, and provides guidelines on sensible authorization policies. Since the data in notifications is sensitive as well, end-to-end SIP encryption mechanisms using S/MIME SHOULD be used to protect it. Since a focus provides participants identity information using this event package, participant privacy needs to be taken into account. A focus MUST support requests by participants for privacy. Privacy can be indicated by the conference policy - for every participant or select participants. It can also be indicated in the session signaling. In SIP this can be done using the Privacy header field described in RFC 3323 [8]. For a participant requesting privacy, no identity information SHOULD be revealed by the focus such as a URI (e.g. the Address of Record, Contact, or GRUU). For these cases, the anonymous URI generation method outlined in section "User Element" of this document MUST be followed. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page23]40] Internet-Draft Conference PackageJulyOctober 20046.10. IANA Considerations This document registers a SIP event package, a new MIME type, application/conference-info+xml, a new XML namespace, and a new XML schema.6.110.1 conference Event Package Registration This specification registers an event package, based on the registration procedures defined in RFC 3265 [7]. The following is the information required for such a registration: Package Name: conference Package or Template-Package: This is a package. Published Document: RFC XXXX (Note to RFC Editor: Please fill in XXXX with the RFC number of this specification). Person to Contact: Jonathan Rosenberg, jdrosen@jdrosen.net.6.210.2 application/conference-info+xml MIME Registration MIME media type name: application MIME subtype name: conference-info+xml Mandatory parameters: none Optional parameters: Same as charset parameter application/xml as specified in RFC 3023 [5]. Encoding considerations: Same as encoding considerations of application/xml as specified in RFC 3023 [5]. Security considerations: See Section 10 of RFC 3023 [5] and Section59 of this specification. Interoperability considerations: none. Published specification: This document. Applications which use this media type: This document type has been used to support SIP conferencing applications. Additional Information: Magic Number: None File Extension: .cif or .xml Macintosh file type code: "TEXT" Personal and email address for further information: Jonathan Rosenberg, <jdrosen@jdrosen.net> Intended usage: COMMON Author/Change controller: The IETF.6.310.3 URN Sub-Namespace Registration for urn:ietf:params:xml:ns:conference-info This section registers a new XML namespace, as per the guidelines in [1]. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page24]41] Internet-Draft Conference PackageJulyOctober 2004 URI: The URI for this namespace is urn:ietf:params:xml:ns:conference-info. Registrant Contact: IETF, SIPPING working group, <sipping@ietf.org>, Jonathan Rosenberg <jdrosen@jdrosen.net>. XML: BEGIN <?xml version="1.0"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="content-type" content="text/html;charset=iso-8859-1"/> <title>Conference Information Namespace</title> </head <body> <h1>Namespace for Conference Information</h1> <h2>urn:ietf:params:xml:ns:conference-info</h2> <p>See <a href="[[[URL of published RFC]]]">RFCXXXX</a>.</p> </body> </html> END6.410.4 XML Schema Registration This specification registers a schema, as per the guidelines in in [1]. URI: please assign. Registrant Contact: IETF, SIPPING Working Group (sipping@ietf.org), Jonathan Rosenberg (jdrosen@jdrosen.net). XML: The XML can be found as the sole content of Section4.3.7. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page25]42] Internet-Draft Conference PackageJulyOctober 20047.11. Acknowledgements The authors would like to thank Dan Petrie, Sean Olson, Alan Johnston, and Rohan Mahy for their comments and inputs. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page26]43] Internet-Draft Conference PackageJulyOctober 20048.12. Changes History8.112.1 Changes since -05 o General schema clean-up. o Definition of common types being used by multiple elements. o Introduction of an "endpoint" element as a part of hierarchy: user/endpoint/media. 12.2 Changes since -04 o o "Sidebar-type" has been removed. "Sidebar" conference element is defined using the general "conference-type". o "Recording" conference attribute has been replaced with "recording" and "streaming" elements within "conference-type". New "recording-type" and "streaming-type" have been introduced. o Attribute "state" has been added to "user-type". o Element "media-stream" within "user-type" has been renamed to "media". o Element "role" within "user-type" has been introduced. o The following statuses have been added to "user-status-type": blocked, pending, calling, ringing, dialing-in, disconnecting, removed. o User status "muted-by-focus" has been renamed to "muted-via-focus". o Attributes "id" and "state" have been added to "media-type". o Elements "status", "snd-status" and "rcv-status" have been added to "media-type". o Element "dialog-id" has been renamed to "instance". o "Constructing Coherent State" section has been updated to include user and media partial notifications.8.212.3 Changes since -03 o "Constructing Coherent State" section has been updated. o In order to support partial notifications, two placeholders "conference-ids" and "policy-ids" (for "conf-uri" and "policy-uri" elements, correspondingly) are created. o Discussion and security considerations regarding anonymous participation have been added. o Optional elements "dialog-uri", "info" and "label" per media stream are added.8.312.4 Changes since -02 o State "muted-by-focus" is added to user's status. o Optional conference attribute "recording" is added. o Policy URI placeholder (i.e. element "policy-uri") is created. o Example's syntax is corrected. o Optional attribute "cascaded-focus" URI per user is added. Rosenberg, et al. Expires April 25, 2005 [Page 44] Internet-Draft Conference Package October 2004 o Optional additional conference identifiers (i.e. element "conf-uri") are added. o In order to cover all possible cases, participant's status is expressed using three optional statuses: "status", "joining-mode" and "disconnection-reason". That is instead of "activity-status", "history-status" and "is-on-dial-out-list".Rosenberg, et al. Expires January 16, 2005 [Page 27] Internet-Draft Conference Package July 2004 8.412.5 Changes since -01 o Package parameters are removed. Decision about performing "recursive" membership algorithm is perceived as a focus local policy. o General information (i.e. pointers to additional available services) is removed. The defined XML schema can be extended in future to include those when XCON work matures. o Dialog information is removed. It can be obtained by direct subscription to a dialog package of a participant. o Media stream information is aligned with SDP definitions (media and proto) and SSRC attribute is added. o Participant's status is expressed using two optional statuses: "activity" and "history". Optional "is-on-a-dial-out-list" indication is added. o Normative references to XCON work are removed. o Optional sidebar rosters are added. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page28]45] Internet-Draft Conference PackageJulyOctober 20049.13. References9.113.1 Normative References [1] Mealling, M., "The IETF XML Registry", draft-mealling-iana-xmlns-registry-05 (work in progress), June 2003. [2] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [3] Moats, R., "URN Syntax", RFC 2141, May 1997. [4] Moats, R., "A URN Namespace for IETF Documents", RFC 2648, August 1999. [5] Murata, M., St. Laurent, S. and D. Kohn, "XML Media Types", RFC 3023, January 2001. [6] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP: Session Initiation Protocol", RFC 3261, June 2002. [7] Roach, A., "Session Initiation Protocol (SIP)-Specific Event Notification", RFC 3265, June 2002. [8] Peterson, J., "A Privacy Mechanism for the Session Initiation Protocol (SIP)", RFC 3323, November 2002. [9] Camarillo, G., Eriksson, G., Holler, J. and H. Schulzrinne, "Grouping of Media Lines in the Session Description Protocol (SDP)", RFC 3388, December 2002. [10] Schulzrinne, H., Casner, S., Frederick, R. and V. Jacobson, "RTP: A Transport Protocol for Real-Time Applications", STD 64, RFC 3550, July 2003.9.213.2 Informative References [11] Schulzrinne, H., Rao, A. and R. Lanphier, "Real Time Streaming Protocol (RTSP)", RFC 2326, April 1998. [12] Handley, M. and V. Jacobson, "SDP: Session Description Protocol", RFC 2327, April 1998. [13]Levin, O., "H.323 Uniform Resource Locator (URL) Scheme Registration",Vaha-Sipila, A., "URLs for Telephone Calls", RFC3508,2806, April2003.2000. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page29]46] Internet-Draft Conference PackageJulyOctober 2004 [14] Levin, O., "H.323 Uniform Resource Locator (URL) Scheme Registration", RFC 3508, April 2003. [15] Rosenberg, J., "A Framework for Conferencing with the Session Initiation Protocol",draft-ietf-sipping-conferencing-framework-02draft-ietf-sipping-conferencing-framework-03 (work in progress),JuneOctober 2004.[15][16] Rosenberg, J. and H. Schulzrinne, "An INVITE Inititiated Dialog Event Package for the Session Initiation Protocol (SIP)", draft-ietf-sipping-dialog-package-04 (work in progress), February 2004.[16][17] Koskelainen, P. and H. Khartabil, "Requirements for Conference Policy Control Protocol",draft-ietf-xcon-cpcp-reqs-03draft-ietf-xcon-cpcp-reqs-04 (work in progress),AprilAugust 2004.[17][18] Rosenberg, J., "Obtaining and Using Globally Routable User Agent (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)", draft-ietf-sip-gruu-02 (work in progress), July 2004.[18][19] Levin, O. and G. Camarillo, "The SDP (Session Description Protocol) Label Attribute",draft-levin-mmusic-sdp-media-label-00draft-ietf-mmusic-sdp-media-label-00 (work in progress),JulySeptember 2004. Authors' Addresses Jonathan Rosenberg dynamicsoft 600 Lanidex Plaza Parsippany, NJ 07054 US Phone: +1 973 952-5000 EMail: jdrosen@dynamicsoft.com URI: http://www.jdrosen.net Rosenberg, et al. Expires April 25, 2005 [Page 47] Internet-Draft Conference Package October 2004 Henning Schulzrinne Columbia University M/S 0401 1214 Amsterdam Ave. New York, NY 10027 US EMail: schulzrinne@cs.columbia.edu URI: http://www.cs.columbia.edu/~hgsRosenberg, et al. Expires January 16, 2005 [Page 30] Internet-Draft Conference Package July 2004Orit Levin (editor) Microsoft Corporation One Microsoft Way Redmond, WA 98052 USA EMail: oritl@microsoft.com Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page31]48] Internet-Draft Conference PackageJulyOctober 2004 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Disclaimer of Validity This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM 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. Copyright Statement Copyright (C) The Internet Society (2004). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Rosenberg, et al. ExpiresJanuary 16,April 25, 2005 [Page32]49] ----