rfc-6502

Conference Event Package Data Format Extension for Centralized Conferencing (XCON)

G. Camarillo, S. Srinivasan, R. Even, J. Urpalainen
date2012-03 streamIETF arearai wgxcon statusPROPOSED STANDARD pages14 canonicalhttps://www.rfc-editor.org/rfc/rfc6502 doi10.17487/RFC6502
This document specifies the notification mechanism for XCON (centralized conferencing). This mechanism reuses the SIP (Session Initiation Protocol) event package for conference state. Additionally, the notification mechanism includes support for the XCON data model and for partial notifications. [STANDARDS-TRACK]

Extracted elements (25)

design-rationale §5

Partial notifications were introduced because generating a full conference-state document for every small change is inefficient in bandwidth-constrained environments. The XML patch operations mechanism (RFC 5261) was chosen over the RFC 4575 <state>-based partial mechanism to allow finer-grained updates.

sip, realtime

interoperability-note §4.1

Backwards compatibility is achieved by requiring XCON-capable servers to also support the legacy 'application/conference-info+xml' MIME type, ensuring that legacy clients which only understand that format can still receive notifications.

sip, realtime

normative-requirement §4.1 SHOULD

Clients that support 'application/xcon-conference-info+xml' SHOULD also support 'application/conference-info+xml' to interoperate with legacy servers that only send the older format.

sip, realtime

normative-requirement §4.1 MUST

Conference servers that support 'application/xcon-conference-info+xml' MUST also support 'application/conference-info+xml' so that legacy clients can receive notifications in a format they understand.

sip, realtime

normative-requirement §5.2 SHOULD

If a subscriber encounters a processing error while processing an 'application/xcon-conference-info-diff+xml' document, it SHOULD renew its subscription; it can fall back by omitting the diff MIME type from the new SUBSCRIBE.

sip, realtime

normative-requirement §5.1 MUST

If the server changes from a non-diff content type to partial notifications, it MUST first deliver full state using 'application/xcon-conference-info+xml' before generating its first partial notification.

sip, realtime

normative-requirement §5.2 MUST

If the server changes the content type used in notifications within an existing subscription, the subscriber MUST discard all previously received information and process the new content as specified for that content type.

sip, realtime

normative-requirement §5.2 MUST

On receiving a subsequent 'application/xcon-conference-info+xml' notification, the subscriber MUST replace its local document copy entirely; on receiving an 'application/xcon-conference-info-diff+xml' notification, it MUST apply the indicated changes to its local copy.

sip, realtime

normative-requirement §5.1 MUST

Once a subscription is accepted and installed, the server MUST deliver full state in its first notification, setting Content-Type to 'application/xcon-conference-info+xml'.

sip, realtime

normative-requirement §5 MUST NOT

Servers compliant with this specification MUST NOT use the partial notification mechanism based on <state> elements defined in RFC 4575. Instead, they MUST use the XML patch-based partial notification mechanism specified in Section 5.

sip, realtime

normative-requirement §5.1 MUST

The server MUST construct partial notifications so that added information is listed inside <add> elements, removed information inside <remove> elements, and changed information inside <replace> elements.

sip, realtime

normative-requirement §5.1 MUST NOT

The server MUST NOT send a new NOTIFY with a partial notification until it has received a final response from the subscriber for the previous one, or the previous NOTIFY has timed out.

sip, realtime

normative-requirement §5.1 MUST

To deliver a partial notification, the server MUST set Content-Type to 'application/xcon-conference-info-diff+xml' and SHOULD only include information that has changed compared to the previous notification.

sip, realtime

normative-requirement §5.2 MUST

When a subscriber receives the first notification containing full state, it MUST store the received full document as its local copy.

sip, realtime

normative-requirement §5.1 SHOULD

When the server receives a SUBSCRIBE request (refresh or termination) within the associated subscription, it SHOULD send a NOTIFY containing the full document using 'application/xcon-conference-info+xml'.

sip, realtime

protocol-element §3

A document in 'application/xcon-conference-info-diff+xml' format provides the subscriber with only the changes to conference state since the last notification, using XML patch operations (RFC 5261).

sip, realtime

protocol-element §3

A document in 'application/xcon-conference-info+xml' format provides the subscriber with the complete state of a conference instance, following the XCON data model defined in RFC 6501.

sip, realtime

protocol-element §5.3

The <conference-info-diff> element's mandatory 'entity' attribute holds the conference object identifier (XCON-URI) identifying the conference being described. Unknown extension elements from other namespaces MUST be ignored by the client.

sip, realtime

protocol-element §3

The XCON notification mechanism reuses the SIP event package for conference state defined in RFC 4575, extended to carry XML documents in two new MIME formats: 'application/xcon-conference-info+xml' (full state) and 'application/xcon-conference-info-diff+xml' (partial updates).

sip, realtime

registry §6.2

This document registers the MIME type 'application/xcon-conference-info-diff+xml' for carrying partial XCON conference state updates (XML patch operations) in NOTIFY bodies.

registry, sip, realtime

registry §6.3

This document registers the URN sub-namespace 'urn:ietf:params:xml:ns:xcon-conference-info-diff' for the partial notification XML namespace.

registry, sip, realtime

registry §6.4

This document registers the XML schema 'urn:ietf:params:xml:schema:xcon-conference-info-diff' (the schema defined in Section 5.4) in the IETF XML registry per RFC 3688.

registry, sip, realtime

security-consideration §7

Encoding notifications in the new XCON formats does not introduce additional security implications beyond those of the underlying SIP event package. Implementers MUST follow the security considerations of RFC 4575 Section 8 regardless of the notification format used.

security, sip, realtime

wire-format §5.3

An xcon-conference-info-diff document is an XML document that MUST be well-formed and SHOULD be valid. The root element is <conference-info-diff> in namespace 'urn:ietf:params:xml:ns:xcon-conference-info' with a mandatory 'entity' attribute (XCON-URI string) and an unordered sequence of <add>, <replace>, and <remove> children.

sip, realtime

wire-format §5.4

The XML Schema for 'application/xcon-conference-info-diff+xml' (Section 5.4) extends RFC 5261 patch-ops types: <add>, <remove>, and <replace> elements each allow arbitrary additional attributes via xs:anyAttribute, and the root accepts any foreign-namespace elements for extensibility.

sip, realtime