Internet DRAFT - draft-ietf-xcon-ccmp
draft-ietf-xcon-ccmp
XCON Working Group M. Barnes
Internet-Draft Polycom
Intended status: Standards Track C. Boulton
Expires: February 4, 2012 NS-Technologies
S P. Romano
University of Napoli
H. Schulzrinne
Columbia University
August 3, 2011
Centralized Conferencing Manipulation Protocol
draft-ietf-xcon-ccmp-15
Abstract
The Centralized Conferencing Manipulation Protocol (CCMP) allows an
XCON conferencing system client to create, retrieve, change, and
delete objects that describe a centralized conference. CCMP is a
means to control basic and advanced conference features such as
conference state and capabilities, participants, relative roles, and
details. CCMP is a state-less, XML-based, client server protocol
that carries, in its request and response messages, conference
information in the form of XML documents and fragments conforming to
the centralized conferencing data model schema.
Status of this Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
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."
This Internet-Draft will expire on February 4, 2012.
Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the
document authors. All rights reserved.
Barnes, et al. Expires February 4, 2012 [Page 1]
Internet-Draft CCMP August 2011
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Conventions and Terminology . . . . . . . . . . . . . . . . . 4
3. XCON Conference Control System Architecture . . . . . . . . . 5
3.1. Conference Objects . . . . . . . . . . . . . . . . . . . 7
3.2. Conference Users . . . . . . . . . . . . . . . . . . . . 7
4. Protocol Overview . . . . . . . . . . . . . . . . . . . . . . 8
4.1. Protocol Operations . . . . . . . . . . . . . . . . . . . 9
4.2. Data Management . . . . . . . . . . . . . . . . . . . . . 10
4.3. Data Model Compliance . . . . . . . . . . . . . . . . . . 11
4.4. Implementation Approach . . . . . . . . . . . . . . . . . 12
5. CCMP messages . . . . . . . . . . . . . . . . . . . . . . . . 13
5.1. CCMP Request Message Type . . . . . . . . . . . . . . . . 13
5.2. CCMP Response Message Type . . . . . . . . . . . . . . . 15
5.3. Detailed messages . . . . . . . . . . . . . . . . . . . . 17
5.3.1. blueprintsRequest and blueprintsResponse . . . . . . 20
5.3.2. confsRequest and confsResponse . . . . . . . . . . . 22
5.3.3. blueprintRequest and blueprintResponse . . . . . . . 23
5.3.4. confRequest and confResponse . . . . . . . . . . . . 25
5.3.5. usersRequest and usersResponse . . . . . . . . . . . 29
5.3.6. userRequest and userResponse . . . . . . . . . . . . 31
5.3.7. sidebarsByValRequest and sidebarsByValResponse . . . 36
5.3.8. sidebarByValRequest and sidebarByValResponse . . . . 37
5.3.9. sidebarsByRefRequest and sidebarsByRefResponse . . . 40
5.3.10. sidebarByRefRequest and sidebarByRefResponse . . . . 42
5.3.11. extendedRequest and extendedResponse . . . . . . . . 45
5.3.12. optionsRequest and optionsResponse . . . . . . . . . 46
5.4. CCMP Response Codes . . . . . . . . . . . . . . . . . . . 50
6. A complete example of the CCMP in action . . . . . . . . . . 53
6.1. Alice retrieves the available blueprints . . . . . . . . 54
6.2. Alice gets detailed information about a specific
blueprint . . . . . . . . . . . . . . . . . . . . . . . . 57
6.3. Alice creates a new conference through a cloning
operation . . . . . . . . . . . . . . . . . . . . . . . . 59
6.4. Alice updates conference information . . . . . . . . . . 61
6.5. Alice inserts a list of users in the conference object . 63
Barnes, et al. Expires February 4, 2012 [Page 2]
Internet-Draft CCMP August 2011
6.6. Alice joins the conference . . . . . . . . . . . . . . . 65
6.7. Alice adds a new user to the conference . . . . . . . . . 67
6.8. Alice asks for the CCMP server capabilities . . . . . . . 69
6.9. Alice exploits a CCMP server extension . . . . . . . . . 72
7. Locating a Conference Control Server . . . . . . . . . . . . 74
8. Managing Notifications . . . . . . . . . . . . . . . . . . . 76
9. HTTP Transport . . . . . . . . . . . . . . . . . . . . . . . 77
10. Security Considerations . . . . . . . . . . . . . . . . . . . 79
10.1. Assuring that the Proper Conferencing Server has been
contacted . . . . . . . . . . . . . . . . . . . . . . . . 80
10.2. User Authentication and Authorization . . . . . . . . . . 80
10.3. Security and Privacy of Identity . . . . . . . . . . . . 82
10.4. Mitigating DoS Attacks . . . . . . . . . . . . . . . . . 83
11. XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . 83
12. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 101
12.1. URN Sub-Namespace Registration . . . . . . . . . . . . . 101
12.2. XML Schema Registration . . . . . . . . . . . . . . . . . 102
12.3. MIME Media Type Registration for 'application/ccmp+xml' . 102
12.4. DNS Registrations . . . . . . . . . . . . . . . . . . . . 103
12.4.1. Registration of a Conference Control Server
Application Service Tag . . . . . . . . . . . . . . . 104
12.4.2. Registration of a Conference Control Server
Application Protocol Tag for CCMP . . . . . . . . . . 104
12.5. CCMP Protocol Registry . . . . . . . . . . . . . . . . . 104
12.5.1. CCMP Message Types . . . . . . . . . . . . . . . . . 105
12.5.2. CCMP Response Codes . . . . . . . . . . . . . . . . . 107
13. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 109
14. References . . . . . . . . . . . . . . . . . . . . . . . . . 109
14.1. Normative References . . . . . . . . . . . . . . . . . . 109
14.2. Informative References . . . . . . . . . . . . . . . . . 110
Appendix A. Appendix A: Evaluation of other protocol models
and transports considered for CCMP . . . . . . . . 111
A.1. Using SOAP for the CCMP . . . . . . . . . . . . . . . . . 112
A.2. A RESTful approach for the CCMP . . . . . . . . . . . . . 113
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 114
Barnes, et al. Expires February 4, 2012 [Page 3]
Internet-Draft CCMP August 2011
1. Introduction
The Framework for Centralized Conferencing [RFC5239] (XCON Framework)
defines a signaling-agnostic framework, naming conventions and
logical entities required for building advanced conferencing systems.
The XCON Framework introduces the conference object as a logical
representation of a conference instance, representing the current
state and capabilities of a conference.
The Centralized Conferencing Manipulation Protocol (CCMP) defined in
this document allows authenticated and authorized users to create,
manipulate and delete conference objects. Operations on conferences
include adding and removing participants, changing their roles, as
well as adding and removing media streams and associated end points.
The CCMP implements the client-server model within the XCON
Framework, with the Conference Control Client and Conference Control
Server acting as client and server, respectively. The CCMP uses HTTP
[RFC2616] as the protocol to transfer requests and responses, which
contain the domain-specific XML-encoded data objects defined in
[I-D.ietf-xcon-common-data-model] Conference Information Data Model
for Centralized Conferencing (XCON Data Model).
Section 2 clarifies the conventions and terminology used in the
document. Section 3 provides an overview of the Conference Control
functionality of the XCON framework, together with a description of
the main targets CCMP deals with, namely conference objects and
conference users. A general description of the operations associated
with protocol messages is given in Section 4 together with
implementation details. Section 5 delves into the details of the
specific CCMP messages. A complete, not normative, example of the
operation of the CCMP, describing a typical call flow associated with
conference creation and manipulation, is provided in Section 6. A
survey of the methods that can be used to locate a Conference Control
Server is provided in Section 7, whereas Section 8 discusses
potential approaches to notifications management. CCMP transport
over HTTP is highlighted in Section 9. Security considerations are
presented in Section 10. Finally, Section 11 provides the XML
schema.
2. Conventions and Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
[RFC2119].
Barnes, et al. Expires February 4, 2012 [Page 4]
Internet-Draft CCMP August 2011
In additon to the terms defined in the Framework for Centralized
Conferencing [RFC5239], this document uses the following terms and
acronyms:
XCON aware client: An XCON conferencing system client which is able
to issue CCMP requests.
First-Party Request: A request issued by the client to manipulate
their own conferencing data.
Third-Party Request: A request issued by a client to manipulate the
conference data of another client.
3. XCON Conference Control System Architecture
CCMP supports the XCON framework . Figure 1 depicts a subset of the
"Conferencing System Logical Decomposition" architecture from the
XCON framework document. It illustrates the role that CCMP assumes
within the overall centralized architecture.
Barnes, et al. Expires February 4, 2012 [Page 5]
Internet-Draft CCMP August 2011
........................................................
. Conferencing System .
. .
. +---------------------------------------+ .
. | C O N F E R E N C E O B J E C T | .
. +-+-------------------------------------+ | .
. | C O N F E R E N C E O B J E C T | | .
. +-+-------------------------------------+ | | .
. | C O N F E R E N C E O B J E C T | | | .
. | | |-+ .
. | |-+ .
. +---------------------------------------+ .
. ^ .
. | .
. v .
. +-------------------+ .
. | Conference Control| .
. | Server | .
. +-------------------+ .
. ^ .
.........................|..............................
|
|Centralized
|Conferencing
|Manipulation
|Protocol
|
.........................|..............................
. V .
. +----------------+ .
. | Conference | .
. | Control | .
. | Client | .
. +----------------+ .
. .
. Conferencing Client .
........................................................
Figure 1: Conference Client Interaction
The Centralized Conferencing Manipulation Protocol (CCMP) allows the
conference control client to interface with the conference object
maintained by the conferencing system, as depicted in Figure 1. Note
that additional functionality of the Conference Control Client and
Conferencing System is discussed in the XCON framework and related
documents.
Barnes, et al. Expires February 4, 2012 [Page 6]
Internet-Draft CCMP August 2011
This section provides details of the identifiers REQUIRED to address
and manage the clients associated with a conferencing system using
the CCMP.
3.1. Conference Objects
Conference objects feature a simple dynamic inheritance-and-override
mechanism. Conference objects are linked into a tree known as
"cloning tree" (see Section 7.1 of [RFC5239]). Each cloning tree
node inherits attributes from its parent node. The roots of these
inheritance trees are conference templates also known as
"blueprints". Nodes in the inheritance tree can be active
conferences or simply descriptions that do not currently have any
resources associated with them (i.e., conference reservations). An
object can mark certain of its properties as unalterable, so that
they cannot be overridden. Per the framework, a client may specify a
parent object (a conference or blueprint) from which to inherit
values when a conference is created using the Conference Control
Protocol.
Conference objects are uniquely identified by the XCON-URI within the
scope of the conferencing system. The XCON-URI is introduced in the
XCON framework and defined in the XCON common data model.
Conference objects are comprehensively represented through XML
documents compliant with the XML Schema defined in the XCON data
model [I-D.ietf-xcon-common-data-model]. The root element of such
documents, called "<conference-info>", is of type "conference-type".
It encompasses other XML elements describing different conference
features and users as well. Using the CCMP, conferencing clients can
use these XML structures to express their preferences in creating or
updating a conference. A conferencing server can convey conference
information using the XML elements back to the clients.
3.2. Conference Users
Each conference can have zero or more users. All conference
participants are users, but some users may have only administrative
functions and do not contribute or receive media. Users are added
one user at a time to simplify error reporting. When a conference is
cloned from a parent object, users are inherited as well, so that it
is easy to set up a conference that has the same set of participants
or a common administrator. The Conference Control Server creates
individual users, assigning them a unique Conference User Identifier
(XCON-USERID). The XCON-USERID as identifier of each conferencing
system client is introduced in the XCON framework and defined in the
XCON common data model. Each CCMP request, with an exception pointed
out in Section 5.3.6 representing the case of a user at his first
Barnes, et al. Expires February 4, 2012 [Page 7]
Internet-Draft CCMP August 2011
entrance in the system as a conference participant, must carry the
XCON-USERID of the requestor in the proper "confUserID" parameter.
The XCON-USERID acts as a pointer to the user's profile as a
conference actor, e.g. her signalling URI and other XCON protocol
URIs in general, her role (moderator, participant, observer, etc.),
her display text, her joining information and so on. A variety of
elements defined in the common <conference-info> element as specified
in the XCON data model are used to describe the users related to a
conference including the <users> element, as well as each <user>
element included within it. For example, it is possible to determine
how a specific user expects and is allowed to join a conference by
looking at the <allowed-user-list> in <users>: each <target> element
involved in such a list represents a user and shows a "method"
attribute defining how the user is expected to join the conference,
i.e. "dial-in" for users that are allowed to dial, "dial-out" for
users that the conference focus will be trying to reach (with
"dial-in" being the default mode). If the conference is currently
active, dial-out users are contacted immediately; otherwise, they are
contacted at the start of the conference. The CCMP, acting as the
Conference Control Protocol, provides a means to manipulate these and
other kinds of user-related features.
As a consequence of an explicit user registration to a specific XCON
conferencing system, conferencing clients are usually provided
(besides the XCON-USERID) with log-in credentials (i.e. username and
password). Such credentials can be used to authenticate the XCON
aware client issuing CCMP requests. Thus, both username and password
should be carried in a CCMP request as part of the "subject"
parameter whenever a registered conferencing client wishes to contact
a CCMP server. The CCMP does not maintain user's subscriptions at
the conference server; hence, it does not provide any specific
mechanism allowing clients to register their conferencing accounts.
The "subject" parameter is just used for carrying authentication data
associated with pre-registered clients, with the specific
registration modality outside the scope of this document.
4. Protocol Overview
CCMP is a client-server, XML-based protocol for user creation,
retrieval, modification and deletion of conference objects. CCMP is
a stateless protocol, such that implementations can safely handle
transactions independently from each other. CCMP messages are XML
documents or XML document fragments compliant with the XCON data
model representation [I-D.ietf-xcon-common-data-model].
Section 4.1 specifies the basic operations that can create, retrieve,
Barnes, et al. Expires February 4, 2012 [Page 8]
Internet-Draft CCMP August 2011
modify and delete conference-related information in a centralized
conference. The core set of objects manipulated in the CCMP includes
conference blueprints, the conference object, users, and sidebars.
Each operation in the protocol model, as summarized in Section 4.1 is
atomic and either succeeds or fails as a whole. The conference
server MUST ensure that the operations are atomic in that the
operation invoked by a specific conference client completes prior to
another client's operation on the same conference object. While the
details for this data locking functionality are out of scope for the
CCMP protocol specification and are implementation specific for a
conference server, some core functionality for ensuring the integrity
of the data is provided by the CCMP as described in Section 4.2.
While the XML documents that are carried in the CCMP need to comply
with the XCON data model, there are situations in which the values
for mandatory elements are unknown by the client. The mechanism for
ensuring compliance with the data model in these cases is described
in Section 4.3.
CCMP is completely independent from underlying protocols, which means
that there can be different ways to carry CCMP messages from a
conferencing client to a conferencing server. The specification
describes the use of HTTP as a transport solution, including CCMP
requests in HTTP POST messages and CCMP responses in HTTP 200 OK
replies. This implementation approach is further described in
Section 4.4.
4.1. Protocol Operations
The main operations provided by CCMP belong in four general
categories:
create: for the creation of a conference object, a conference user,
a sidebar, or a blueprint.
retrieve: to get information about the current state of either a
conference object (be it an actual conference or a blueprint, or a
sidebar) or a conference user. A retrieve operation can also be
used to obtain the XCON-URIs of the current conferences (active or
registered) handled by the conferencing server and/or the
available blueprints.
update: to modify the current features of a specified conference or
conference user.
Barnes, et al. Expires February 4, 2012 [Page 9]
Internet-Draft CCMP August 2011
delete: to remove from the system a conference object or a
conference user.
Thus, the main targets of CCMP operations are:
o conference objects associated with either active or registered
conferences,
o conference objects associated with blueprints,
o conference objects associated with sidebars, both embedded in the
main conference (i.e. <entry> elements in <sidebars-by-value>) and
external to it (i.e. whose xcon-uris are included in the <entry>
elements of <sidebars-by-ref>),
o <user> elements associated with conference users,
o the list of XCON-URIs related to conferences and blueprints
available at the server, for which only retrieval operations are
allowed.
4.2. Data Management
The XCON Framework defines a model whereby the conference server
centralizes and maintains the conference information. Since multiple
clients can modify the same conference objects a conference client
might not have the latest version of a specific conference object
when they initiate operations. To determine whether the client has
the most up to date conference information, a versioning approach is
defined for the CCMP. Each conference object is associated with a
version number. All CCMP response messages containing a conference
document (or a fragment thereof) MUST contain a "version" parameter.
When a client sends an update message to the server, which includes
modifications to a conference object, if the modifications are all
successfully applied, the server MUST return a "200" response
containing the version number of the modified object. With this
approach, a client working on version "X" of a conference object that
receives a "200" response with a version number which is "X+1" can be
certain that the version it manipulated was the most up to date.
However, if the "200" response contains a version which is at least
"X+2", the client knows that the object modified by the server was
more up to date than the object the client was manipulating. In
order to ensure that the client always has the latest version of the
modified object, the client can send a "retrieve" request to the
conference server. The client can then update the relevant data
elements in the conference object prior to invoking a specific
operation. Note that a client subscribed to the XCON event package
[I-D.ietf-xcon-event-package] notifications about conference object
Barnes, et al. Expires February 4, 2012 [Page 10]
Internet-Draft CCMP August 2011
modifications, will receive the most up to date version of that
object upon receipt of a notification.
The "version" parameter is OPTIONAL for requests, since it is not
needed by the server: as long as the required modifications can be
applied to the target conference object without conflicts, the server
does not care whether the client has stored an up to date view of the
information. In addition, to ensure the integrity of the data, the
conference server first checks all the parameters, before making any
changes to the internal representation of the conference object. For
example, it would be undesirable to change the <subject> of the
conference, but then detect an invalid URI in one of the <service-
uris> and abort the remaining updates.
4.3. Data Model Compliance
The XCON data model [I-D.ietf-xcon-common-data-model] identifies some
elements/attributes as mandatory. Since the XML documents carried in
the body of the CCMP requests/responses need to be compliant with the
XCON data model, there can be a problem in cases of client-initiated
operations, such as the initial creation of conference objects and
cases whereby a client updates a conference object adding new
elements, such as a new user. In such cases, not all of the
mandatory data can be known in advance to the client issuing a CCMP
request. As an example, a client has no means to know, at the time
it issues a conference creation request, the XCON-URI that the server
will assign to the yet-to-be-created conference and hence it is not
able to appropriately fill with that value the mandatory "entity"
attribute of the conference document contained in the request. To
solve this issue, the CCMP client fills all mandatory data model
fields, for which no value is available at the time the request is
constructed, with fake values in the form of a wildcard string,
AUTO_GENERATE_X (all uppercase), with X being a unique numeric index
for each data model field for which the value is unknown. This form
of wildcard string is chosen, rather than the use of random unique
strings (e.g, FOO_BAR_LA) or non-numeric values for X, to simplify
processing at the server. The values of AUTO_GENERATE_X are only
unique within the context of the specific request. The fake
AUTO_GENERATE_X values MUST be within the value part of an attribute/
element (e.g., <userinfo entity=
"xcon-userid:AUTO_GENERATE_1@example.com">).
When the server receives requests containing values in the form of
AUTO_GENERATE_X, the server does the following:
Barnes, et al. Expires February 4, 2012 [Page 11]
Internet-Draft CCMP August 2011
(a) Generates the proper identifier for each instance of
AUTO_GENERATE_X in the document. If an instance of
AUTO_GENERATE_X is not within the value part of the attribute/
element, the server MUST respond with an error of 400 Bad
Request. In cases where AUTO_GENERATE_X appears only in the
user part of a URI (i.e., in the case of XCON-USERIDs or XCON-
URIs), the server needs to ensure that the domain name is one
that is within the server's domain of responsibility. If the
domain name is not within the server's domain of responsibility,
then the server MUST return a 427 Invalid Domain Name. The
server MUST replace each instance of a specific wildcard field
(e.g., AUTO_GENERATE_1) with the same identifier. The
identifiers MUST be unique for each instance of AUTO_GENERATE_X
within the same XML document received in the request - e.g., the
value that replaces AUTO_GENERATE_1 MUST NOT be the same as the
value that replaces AUTO_GENERATE_2. Note that the values that
replace the instances of AUTO_GENERATE_X are not the same across
all conference objects - e.g., different values can be used to
replace AUTO_GENERATE_1 in two different documents.
(b) Sends a response in which all values of AUTO_GENERATE_X received
in the request have been replaced by the newly created one(s).
With this approach compatibility with the data model requirements is
maintained, while allowing for client-initiated manipulation of
conference objects at the server's side. Note that the use of this
mechanism could be avoided in come cases by using multiple
operations, such as creating a new user and then adding the new user
to an existing conference. However, the AUTO_GENERATE_X mechanism
allows a single operation to be used to effect the same change on the
conference object.
4.4. Implementation Approach
CCMP is implemented using HTTP, placing the CCMP request messages
into the body of an HTTP POST operation and placing the CCMP
responses into the body of the HTTP response messages. A non-
exhaustive summary of the other approaches that were considered and
the perceived advantages of the HTTP solution described in this
document are provided in Appendix A.
Most CCMP commands can pend indefinitely, thus increasing the
potential that pending requests can continue to increase when a
server is receiving more requests than it can process within a
specific time period. In this case a server SHOULD return a 510
response code to the pending requests. In addition, to mitigate the
situation clients MUST NOT wait indefinitely for a response and MUST
implement a timer such that when it expires, the client MUST close
Barnes, et al. Expires February 4, 2012 [Page 12]
Internet-Draft CCMP August 2011
the connection. Thirty seconds is RECOMMENDED as the default value
for this timer. Sixty seconds is considered a reasonable upper
range. Note, that there may be cases where a response message is
lost and a request has been successful (e.g., user added to a
conference), yet the client will be unaware and close the connection.
However, as described in Section 4.2, there is a versioning mechanism
for the conference objects, thus there is a mechanism for the
conference object stored by the client to be brought up to date.
CCMP messages have a MIME-type of "application/ccmp+xml", which
appears inside the "Content-Type" and "Accept" fields of HTTP
requests and responses. The XML documents in the CCMP messages MUST
be encoded in UTF-8. This specification follows the recommendations
and conventions described in [RFC3023], including the naming
convention of the type ('+xml' suffix) and the usage of the 'charset'
parameter. The 'charset' parameter MUST be included with the XML
document. Section 9 provides the complete requirements for an HTTP
implementation to support the CCMP.
5. CCMP messages
CCMP messages are either requests or responses. The general CCMP
request message is defined in Section 5.1. The general CCMP response
message is defined in Section 5.2. The details of the specific
message type which is carried in the CCMP request and response
messages are described in Section 5.3. CCMP response codes are
listed in Section 5.4
5.1. CCMP Request Message Type
A CCMP request message is comprised of the following parameters:
subject: An OPTIONAL parameter containing username and password of
the client registered at the conferencing system. Each user who
subscribes to the conferencing system is assumed to be equipped
with those credentials and SHOULD enclose them in each CCMP
request she issues. These fields can be used to control that the
user sending the CCMP request has the authority to perform the
entailed operation. The same fields can also be exploited to
carry out other authorization and authentication procedures.
confUserID: An OPTIONAL parameter containing the XCON-USERID of the
client. The XCON-USERID is used to identify any conferencing
client within the context of the conferencing system and it is
assigned by the conferencing server at each conferencing client
who interacts with it. The "confUserID" parameter is REQUIRED in
the CCMP request and response messages with the exception of the
Barnes, et al. Expires February 4, 2012 [Page 13]
Internet-Draft CCMP August 2011
case of a user who has no XCON-USERID and who wants to enter, via
CCMP, a conference whose identifier is known. In such case, a
side-effect of the request is that the user is provided with an
appropriate XCON-USERID. An example of the above mentioned case
will be provided in Section 5.3.6.
confObjID: An OPTIONAL parameter containing the XCON-URI of the
target conference object.
operation: An OPTIONAL parameter refining the type of specialized
request message. The "operation" parameter is REQUIRED in all
requests except for the "blueprintsRequest" and "confsRequest"
specialized messages.
conference-password: An OPTIONAL parameter that MUST be inserted in
all requests whose target conference object is password-protected
(as per the <conference-password> element in
[I-D.ietf-xcon-common-data-model]). A CCMP response code of "423"
MUST be returned if a conference-password is not included in the
request when required.
specialized request message: This is specialization of the generic
request message (e.g., blueprintsRequest), containing parameters
that are dependent on the specific request sent to the server. A
specialized request message MUST be included in the CCMP request
message. The details for the specialized messages and associated
parameters are provided in Section 5.3.
Barnes, et al. Expires February 4, 2012 [Page 14]
Internet-Draft CCMP August 2011
<!-- Definition of CCMP Request -->
<xs:element name="ccmpRequest" type="ccmp-request-type" />
<!-- Definition of ccmp-request-type-->
<xs:complexType name="ccmp-request-type">
<xs:sequence>
<xs:element name="ccmpRequest"
type="ccmp-request-message-type" />
</xs:sequence>
</xs:complexType>
<!-- Definition of ccmp-request-message-type -->
<xs:complexType abstract="true"
name="ccmp-request-message-type">
<xs:sequence>
<xs:element name="subject" type="subject-type"
minOccurs="0" maxOccurs="1" />
<xs:element name="confUserID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" type="operationType"
minOccurs="0" maxOccurs="1" />
<xs:element name="conference-password" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 2: Structure of CCMP Request messages
5.2. CCMP Response Message Type
A CCMP response message is comprised of the following parameters:
confUserID: A REQUIRED parameter in CCMP response messages
containing the XCON-USERID of the conferencing client who issued
the CCMP request message.
Barnes, et al. Expires February 4, 2012 [Page 15]
Internet-Draft CCMP August 2011
confObjID: An OPTIONAL parameter containing the XCON-URI of the
target conference object.
operation: An OPTIONAL parameter for CCMP response messages. This
parameter is REQUIRED in all responses except for the
"blueprintsResponse" and "confsResponse" specialized messages.
response-code: A REQUIRED parameter containing the response code
associated with the request. The response code MUST be chosen
from the codes listed in Section 5.4.
response-string: An OPTIONAL reason string associated with the
response. In case of an error, in particular, this string can be
used to provide the client with detailed information about the
error itself.
version: An OPTIONAL parameter reflecting the current version number
of the conference object referred by the confObjID. This number
is contained in the "version" attribute of the <conference-info>
element related to that conference. This parameter is REQUIRED in
CCMP response messages and SHOULD NOT be included in CCMP request
messages.
specialized response message: This is specialization of the generic
response message, containing parameters that are dependent on the
specific request sent to the server (e.g., blueprintsResponse). A
specialized response message SHOULD be included in the CCMP
response message, except in an error situation where the CCMP
request message did not contain a valid specialized message. In
this case, the conference server MUST return a "response-code" of
"400". The details for the specialized messages and associated
parameters are provided in Section 5.3.
Barnes, et al. Expires February 4, 2012 [Page 16]
Internet-Draft CCMP August 2011
<!-- Definition of CCMP Response -->
<xs:element name="ccmpResponse" type="ccmp-response-type" />
<!-- Definition of ccmp-response-type -->
<xs:complexType name="ccmp-response-type">
<xs:sequence>
<xs:element name="ccmpResponse"
type="ccmp-response-message-type" />
</xs:sequence>
</xs:complexType>
<!-- Definition of ccmp-response-message-type -->
<xs:complexType abstract="true"
name="ccmp-response-message-type">
<xs:sequence>
<xs:element name="confUserID" type="xs:string"
minOccurs="1" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" minOccurs="0"
maxOccurs="1" />
<xs:element name="response-code"
type="response-codeType"
minOccurs="1" maxOccurs="1" />
<xs:element name="response-string" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="version" type="xs:positiveInteger"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 3: Structure of CCMP Response message
5.3. Detailed messages
Based on the request and response message structures described in
Section 5.1 and Section 5.2, the following summarizes the specialized
CCMP request/response types described in this document:
Barnes, et al. Expires February 4, 2012 [Page 17]
Internet-Draft CCMP August 2011
1. blueprintsRequest/blueprintsResponse
2. confsRequest/confsResponse
3. blueprintRequest/blueprintResponse
4. confRequest/confResponse
5. usersRequest/usersResponse
6. userRequest/userResponse
7. sidebarsByValRequest/sidebarsByValResponse
8. sidebarsByRefRequest/sidebarsByRefResponse
9. sidebarByValRequest/sidebarByValResponse
10. sidebarByRefRequest/sidebarByRefResponse
11. extendedRequest/extendedResponse
12. optionsRequest/optionsResponse
These CCMP request/response pairs use the fundamental CCMP operations
as defined in Section 4.1 to manipulate the conference data. These
request/response pairs are included in an IANA registry as defined in
Section 12.5. Table 1 summarizes the remaining CCMP operations and
corresponding actions that are valid for a specific CCMP request
type, noting that neither the blueprintsRequest/blueprintsResponse
nor confsRequest/confsResponse require an "operation" parameter. An
entity MUST support the response message for each of the request
messages that are supported. The corresponding response message MUST
contain the same operation. Note that some entries are labeled "N/A"
indicating the operation is invalid for that request type. In the
case of an "N/A*", the operation MAY be allowed for specific
privileged users or system administrators, but is not part of the
functionality included in this document.
Barnes, et al. Expires February 4, 2012 [Page 18]
Internet-Draft CCMP August 2011
+---------------+------------+------------+------------+------------+
| Operation | Retrieve | Create | Update | Delete |
| ------------- | | | | |
| Request Type | | | | |
+---------------+------------+------------+------------+------------+
| blueprints | Get list | N/A | N/A | N/A |
| Request | of | | | |
| | blueprints | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| blueprint | Get | N/A* | N/A* | N/A* |
| Request | blueprint | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| confsRequest | Get list | N/A | N/A | N/A |
| | of confs | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| confRequest | Gets | Creates | Changes | Deletes |
| | conference | conference | conference | conference |
| | object | object | object | object |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| usersRequest | Gets | N/A(**) | Changes | N/A(**) |
| | <users> | | <users> | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| userRequest | Gets | Adds a | Changes | Deletes |
| | specified | <user> to | specified | specified |
| | <user> | a conf | <user> | <user> |
| | | (***) | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarsByVal | Gets | N/A | N/A | N/A |
| Request | <sidebars- | | | |
| | by-val> | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarsByRef | Gets | N/A | N/A | N/A |
| Request | <sidebars- | | | |
| | by-ref> | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarByVal | Gets | Creates | Changes | Deletes |
| Request | sidebar- | sidebar- | sidebar- | sidebar- |
| | by-val | by-val | by-val | by-val |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarByRef | Gets | Creates | Changes | Deletes |
| Request | sidebar- | sidebar- | sidebar- | sidebar- |
| | by-ref | by-ref | by-ref | by-ref |
+---------------+------------+------------+------------+------------+
Table 1: Request Type Operation Specific Processing
(**): These operations are not allowed for a usersRequest message,
since the <users> section, which is the target element of such a
Barnes, et al. Expires February 4, 2012 [Page 19]
Internet-Draft CCMP August 2011
request, is created and removed in conjunction with, respectively,
the creation and deletion of the associated conference document.
Thus, "update" and "retrieve" are the only semantically correct
operations for such message.
(***): This operation can involve the creation of an XCON-USERID, if
the sender does not add it in the "confUserID" parameter, and/or if
the "entity" field of the "userInfo" parameter is void.
Additional parameters included in the specialized CCMP request/
response messages are detailed in the subsequent sections. If a
required parameter is not included in a request, the conference
server MUST return a 400 response code per Section 5.4.
5.3.1. blueprintsRequest and blueprintsResponse
A "blueprintsRequest" (Figure 4) message is sent to request the list
of XCON-URIs associated with the available blueprints from the
conference server. These XCON-URIs can be subsequently used by the
client to access detailed information about a specified blueprint
with a specific blueprintRequest message per Section 5.3.3.
The "confUserID" parameter MUST be included in every
blueprintsRequest/Response message and reflect the XCON-USERID of the
conferencing client issuing the request. Since a blueprintsRequest
message is not targetted to a specific conference instance and is a
"retrieve-only" request, the "confObjID" and "operation" MUST NOT be
included in the blueprintsRequest/Response messages.
In order to obtain a specific subset of the available blueprints, a
client may specify a selection filter providing an appropriate xpath
query in the OPTIONAL "xpathFilter" parameter of the request. The
information in the blueprints typically represents general
capabilities and characteristics. For example, to select blueprints
having both audio and video stream support, a possible xpathFilter
value could be: "/conference-info[conference-description/
available-media/entry/type='audio' and conference-description/
available-media/entry/type='video']". A conference server SHOULD NOT
provide any sensitive information (e.g., passwords) in the
blueprints.
The associated "blueprintsResponse" message SHOULD contain, as shown
in Figure 4, a "blueprintsInfo" parameter containing the above
mentioned XCON-URI list.
<!-- blueprintsRequest -->
Barnes, et al. Expires February 4, 2012 [Page 20]
Internet-Draft CCMP August 2011
<xs:complexType name="ccmp-blueprints-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintsRequestType -->
<xs:element name="blueprintsRequest" type="blueprintsRequestType"/>
<xs:complexType name="blueprintsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- blueprintsResponse -->
<xs:complexType name="ccmp-blueprints-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintsResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintsResponseType -->
<xs:element name="blueprintsResponse" type="blueprintsResponseType"/>
<xs:complexType name="blueprintsResponseType">
<xs:sequence>
<xs:element name="blueprintsInfo"
type="info:uris-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Barnes, et al. Expires February 4, 2012 [Page 21]
Internet-Draft CCMP August 2011
Figure 4: Structure of the blueprintsRequest and blueprintsResponse
messages
5.3.2. confsRequest and confsResponse
A "confsRequest" message is used to retrieve, from the server, the
list of XCON-URIs associated with active and registered conferences
currently handled by the conferencing system. The "confUserID"
parameter MUST be included in every confsRequest/Response message and
reflect the XCON-USERID of the conferencing client issuing the
request. The "confObjID" parameter MUST NOT be included in the
confsRequest message. The "confsRequest" message is of a "retrieve-
only" type, since the sole purpose is to collect information
available at the conference server. Thus, an "operation" parameter
MUST NOT be included in a "confsRequest" message. In order to
retrieve a specific subset of the available conferences, a client may
specify a selection filter providing an appropriate xpath query in
the OPTIONAL "xpathFilter" parameter of the request. For example, to
select only the registered conferences, a possible xpathFilter value
could be: "/conference-info[conference-description/conference-state/
active='false']". The associated "confsResponse" message SHOULD
contain the list of XCON-URIs in the "confsInfo" parameter. A user,
upon receipt of the response message, can interact with the available
conference objects through further CCMP messages.
<!-- confsRequest -->
<xs:complexType name="ccmp-confs-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confsRequestType -->
<xs:element name="confsRequest" type="confsRequestType" />
<xs:complexType name="confsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
Barnes, et al. Expires February 4, 2012 [Page 22]
Internet-Draft CCMP August 2011
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confsResponse -->
<xs:complexType name="ccmp-confs-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confsResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confsResponseType -->
<xs:element name="confsResponse" type="confsResponseType"/>
<xs:complexType name="confsResponseType">
<xs:sequence>
<xs:element name="confsInfo" type="info:uris-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 5: Structure of the confsRequest and confsResponse messages
5.3.3. blueprintRequest and blueprintResponse
Through a "blueprintRequest", a client can manipulate the conference
object associated with a specified blueprint. Further than the
"confUserID" parameter, the request MUST include the "confObjID" and
the "operation" one. Again, the "confUserID" parameter MUST be
included in every blueprintRequest/Response message and reflect the
XCON-USERID of the conferencing client issuing the request. The
"confObjID" parameter MUST contain the XCON-URI of the blueprint,
which might have been previously retrieved through a
"blueprintsRequest" message.
The blueprintRequest message SHOULD NOT contain an "operation"
parameter other than "retrieve". The "create", "update" and "delete"
operations SHOULD NOT be included in a "blueprintRequest" message
except in the case of privileged users (e.g. the conference server
Barnes, et al. Expires February 4, 2012 [Page 23]
Internet-Draft CCMP August 2011
administration staff), who might authenticate themselves by the mean
of the "subject" request parameter.
A blueprintRequest/retrieve carrying a "confObjID" which is not
associated with one of the available system's blueprints will
generate, on the server's side, a blueprintResponse message
containing a "404" error code. This holds also for the case in which
the mentioned "confObjID" is related to an existing conference
document stored at the server, but associated with an actual
conference (be it active or registered) or with a sidebar rather than
a blueprint.
In the case of "response-code" of "200" for a "retrieve" operation,
the "blueprintInfo" parameter MUST be included in the
"blueprintResponse" message. The "blueprintInfo" parameter contains
the conference document associated with the blueprint as identified
by the "confObjID" parameter specified in the blueprintRequest.
<!-- blueprintRequest -->
<xs:complexType name="ccmp-blueprint-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintRequestType -->
<xs:element name="blueprintRequest" type="blueprintRequestType" />
<xs:complexType name="blueprintRequestType">
<xs:sequence>
<xs:element name="blueprintInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- blueprintResponse -->
Barnes, et al. Expires February 4, 2012 [Page 24]
Internet-Draft CCMP August 2011
<xs:complexType name="ccmp-blueprint-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintResponseType -->
<xs:element name="blueprintResponse" type="blueprintResponseType"/>
<xs:complexType name="blueprintResponseType">
<xs:sequence>
<xs:element name="blueprintInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded">
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 6: Structure of the blueprintRequest and blueprintResponse
messages
5.3.4. confRequest and confResponse
With a "confRequest" message, CCMP clients can manipulate conference
objects associated with either active or registered conferences. The
"confUserID" parameter MUST be included in every confRequest/Response
message and reflect the XCON-USERID of the conferencing client
issuing the request. ConfRequest and confResponse messages MUST also
include an "operation" parameter. ConfResponse messages MUST return
to the requestor a "response-code" and MAY contain a "response-
string" explaining it. Depending upon the type of "operation", a
"confObjID" and "confInfo" parameter MAY be included in the
confRequest and response. The requirements for inclusion of
"confObjID" and "confInfo" parameter in the confRequest/confResponse
messages and are detailed below for each "operation" case.
The creation case deserves care. To create a new conference through
a "confRequest" message, two approaches can be considered:
Barnes, et al. Expires February 4, 2012 [Page 25]
Internet-Draft CCMP August 2011
1. Creation through explicit cloning: the "confObjID" parameter MUST
contain the XCON-URI of the blueprint or of the conference to be
cloned, while the "confInfo" parameter MUST NOT be included in
the confRequest. Note that cloning of an active conference is
only done in the case of a sidebar operation per the XCON
framework and as described in Section 5.3.8.
2. Creation through implicit cloning (also known as "direct
creation"): the "confObjID" parameter MUST NOT be included in the
request and the CCMP client can describe the desired conference
to be created using the "confInfo" parameter. If no "confInfo"
parameter is provided in the request, the new conference will be
created as a clone of the system default blueprint.
In both creation cases, the confResponse, for a successful completion
of a "create" operation, contains a response-code of "200" and MUST
contain the XCON-URI of the newly created conference in the
"confObjID" parameter, in order to allow the conferencing client to
manipulate that conference through following CCMP requests. In
addition, the "confInfo" parameter transporting the created
conference document MAY be included, at the discretion of the
conferencing system implementation, along with the REQUIRED "version"
parameter initialized at "1", since at creation time the conference
object is at its first version.
In the case of a confRequest with a "retrieve" operation, the
"confObjID" representing the XCON-URI of the target conference MUST
be included and the "confInfo" parameter MUST NOT be included in the
request. The conferencing server MUST ignore any "confInfo"
parameter that is received in a confRequest/retrieve. If the
confResponse for the "retrieve" operation contains a "response-code"
of "200", the "confInfo" parameter MUST be included in the response.
The "confInfo" parameter MUST contain the entire conference document
describing the target conference object in its current state. The
current state of the retrieved conference object MUST also be
reported in the proper "version" response parameter.
In case of a confRequest with an "update" operation, the "confInfo"
and "confObjID" MUST be included in the request. The "confInfo"
represents an object of type "conference-type" containing all the
changes to be applied to the conference whose identifier is
"confObjID". Note that, in such a case, though the confInfo
parameter has indeed to follow the rules indicated in the XCON data
model, it does not represent the entire updated version of the target
conference, since it rather conveys just the modifications to apply
to that conference. For example, in order to change the conference
title, the confInfo parameter will be of the form:
Barnes, et al. Expires February 4, 2012 [Page 26]
Internet-Draft CCMP August 2011
<confInfo entity="xcon:8977777@example.com">
<conference-description>
<display-text> *** NEW CONFERENCE TITLE *** </display-text>
</conference-description>
</confInfo>
Figure 7: Updating a conference object: modifying the title of a
conference
Similarly, to remove the title of an existing conference, a
confRequest/update carrying the following "confInfo" parameter would
do the job.:
<confInfo entity="xcon:8977777@example.com">
<conference-description>
<display-text/>
</conference-description>
</confInfo>
Figure 8: Updating a conference object: removing the title of a
conference
In the case of a confResponse/update with a response-code of "200",
no additional information is REQUIRED in the response message, which
means the return of confInfo parameter is OPTIONAL. A subsequent
confRequest/retrieve transaction might provide the CCMP client with
the current aspect of the conference upon the modification, or the
Notification Protocol might address that task as well. A "200"
response-code indicates that the conference object has been changed
accordingly to the request by the conferencing server. The "version"
parameter MUST be enclosed in the confResponse/update message, in
order to let the client understand what is the actual current
conference-object version, upon the applied modifications. An "409"
response-code indicates that the changes reflected in the request
"confInfo" are not feasible. This could be due to policies,
requestor roles, specific privileges, unacceptable values etc., with
the reason specific to a conferencing system and its configuration.
Together with the "409" response-code, the "version" parameter MUST
be attached in the confResponse/update, by this way allowing the
client to eventually retrieve the current version of the target
conference if the one she attempted to modify was not the most up-to-
date.
In the case of a confRequest with a "delete" operation, the
Barnes, et al. Expires February 4, 2012 [Page 27]
Internet-Draft CCMP August 2011
"confObjID" representing the XCON-URI of the target conference MUST
be included while the "confInfo" MUST NOT be included in the request.
The conferencing server MUST ignore any "confInfo" parameter that is
received within such a request. The confResponse MUST contain the
same "confObjID" that was included in the confRequest. If the
confResponse/delete operation contains a "200" response-code, the
conference indicated in the "confObjID" has been successfully
deleted. A "200" confResponse/delete MUST NOT contain the "confInfo"
parameter. The "version" parameter SHOULD NOT be returned in any
confResponse/delete. If the conferencing server cannot delete the
conference referenced by the "confObjID" received in the confRequest
because it is the parent of another conference object that is in use,
the conferencing server MUST return a response-code of "425".
A confRequest with an "operation" of "retrieve", "update" or "delete"
carrying a "confObjID" which is not associated with one of the
conferences (active or registered) the system is holding will
generate, on the server's side, a confResponse message containing a
"404" error code. This holds also for the case in which the
mentioned "confObjID" is related to an existing conference object
stored at the server, but associated with a blueprint or with a
sidebar rather than an actual conference.
The schema for the confRequest/confResponse pair is shown in
Figure 9.
<!-- confRequest -->
<xs:complexType name="ccmp-conf-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confRequestType -->
<xs:element name="confRequest" type="confRequestType" />
<xs:complexType name="confRequestType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
Barnes, et al. Expires February 4, 2012 [Page 28]
Internet-Draft CCMP August 2011
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confResponse -->
<xs:complexType name="ccmp-conf-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confResponseType -->
<xs:element name="confResponse" type="confResponseType" />
<xs:complexType name="confResponseType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 9: Structure of the confRequest and confResponse messages
5.3.5. usersRequest and usersResponse
The "usersRequest" message allows a client to manipulate the <users>
element of the conference object represented by the "confObjID". The
<users> element contains the list of <user> elements associated with
conference participants, the list of the users to which access to the
conference is allowed/denied, conference participation policies, etc.
The "confObjID" MUST be included in a "usersRequest" message.
A "usersInfo" parameter MAY be included in a usersRequest message
depending upon the operation. If the "usersInfo" parameter is
included in the usersRequest message, the parameter MUST be compliant
with the <users> field of the XCON data model.
Barnes, et al. Expires February 4, 2012 [Page 29]
Internet-Draft CCMP August 2011
Two operations are allowed for a "usersRequest" message:
1. "retrieve": In this case the request MUST NOT include a
"usersInfo" parameter, while the successful response MUST contain
the desired <users> element in the "usersInfo" parameter. The
conference server MUST ignore a "usersInfo" parameter if it is
received in a request with a "retrieve" operation.
2. update: In this case, the "usersInfo" parameter MUST contain the
modifications to be applied to the referred <users> element. If
the "response-code" is "200", then the "usersInfo" parameter
SHOULD NOT be returned. Any "usersInfo" parameter that is
returned SHOULD be ignored. A "response-code" of "426" indicates
that the conferencing client is not allowed to make the changes
reflected in the "usersInfo" contained in the usersRequest
message. This could be due to policies, roles, specific
privileges, etc., with the reason specific to a conferencing
system and its configuration.
Operations of "create" and "delete" are not applicable to a
usersRequest message and MUST NOT be considered by the server, which
means that a "response-code" of "403" MUST be included in the
usersResponse message.
<!-- usersRequest -->
<xs:complexType name="ccmp-users-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="usersRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- usersRequestType -->
<xs:element name="usersRequest" type="usersRequestType" />
<xs:complexType name="usersRequestType">
<xs:sequence>
<xs:element name="usersInfo"
type="info:users-type" minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
Barnes, et al. Expires February 4, 2012 [Page 30]
Internet-Draft CCMP August 2011
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- usersResponse -->
<xs:complexType name="ccmp-users-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="usersResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- usersResponseType -->
<xs:element name="usersResponse" type="usersResponseType" />
<xs:complexType name="usersResponseType">
<xs:sequence>
<xs:element name="usersInfo" type="info:users-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 10: Structure of the usersRequest and usersResponse messages
5.3.6. userRequest and userResponse
A "userRequest" message is used to manipulate <user> elements inside
a conference document associated with a conference identified by the
"confObjID" parameter. Besides retrieving information about a
specific conference user, the message is used to request that the
conference server either create, modify, or delete information about
a user. A "userRequest" message MUST include the "confObjID", the
"operation" parameter, and MAY include a "userInfo" parameter
containing the detailed user's information depending upon the
operation and whether the "userInfo" has already been populated for a
specific user. Note that a user may not necessarily be a
conferencing control client (i.e., some participants in a conference
are not "XCON aware").
Barnes, et al. Expires February 4, 2012 [Page 31]
Internet-Draft CCMP August 2011
An XCON-USERID SHOULD be assigned to each and every user subscribed
to the system. In such a way, a user who is not a conference
participant can make requests (provided she has successfully passed
authorization and authentication checks), like creating a conference,
retrieving conference information, etc..
Conference users can be created in a number of different ways. In
each of these cases the operation MUST be set to "create" in the
userRequest message. Each of the userResponse messages for these
cases MUST include the "confObjID", "confUserID", "operation" and
"response-code" parameters. In the case of a response code of "200",
the userResponse message MAY include the "userInfo" parameter
depending upon the manner in which the user was created:
o Conferencing client with an XCON-USERID adds itself to the
conference: In this case, the "userInfo" parameter MAY be included
in the userRequest. The "userInfo" parameter MUST contain a
<user> element (compliant with the XCON data model) and the
"entity" attribute MUST be set to a value which represents the
XCON-USERID of the user initiating the request. No additional
parameters beyond those previously described are required in the
userResponse message, in the case of a "response-code" of "200".
o Conferencing client acts on behalf of a third user whose XCON-
USERID is known: in this case, the "userInfo" parameter MUST be
included in the userRequest. The "userInfo" parameter MUST
contain a <user> element and the "entity" attribute value MUST be
set to the XCON-USERID of the third user in question. No
additional parameters beyond those previously described are
required in the userResponse message, in the case of a "response-
code" of "200".
o A conferencing client who has no XCON-USERID and who wants to
enter, via CCMP, a conference whose identifier is known. In this
case, a side-effect of the request is that the user is provided
with a new XCON-USERID (created by the server) carried inside the
"confUserID" parameter of the response. This is the only case in
which a CCMP request can be valid though carrying a void
"confUserID" parameter. A "userInfo" parameter MUST be enclosed
in the request, providing at least a contact URI of the joining
client, in order to let the focus instigate the signaling phase
needed to add her to the conference. The mandatory "entity"
attribute of the "userInfo" parameter in the request MUST be
filled with a fake value with the user part of the XCON-USERID
containing a value of AUTO_GENERATE_X as described in Section 4.3,
to conform to the rules contained in the XCON data model XML
schema. The messages (userRequest and userResponse) in this case
should look like the following:
Barnes, et al. Expires February 4, 2012 [Page 32]
Internet-Draft CCMP August 2011
Request fields:
confUserID=null;
confObjID=confXYZ;
operation=create;
userInfo=
<userInfo entity="xcon-userid:AUTO_GENERATE_1@example.com">
<endpoint entity="sip:GHIL345@example.com">
...
Response fields (in case of success):
confUserID=user345;
confObjID=confXYZ;
operation=create;
response-code=200;
userInfo=null; //or the entire userInfo object
Figure 11: userRequest and userResponse in the absence of an xcon-
userid
o Conferencing client is unaware of the XCON-USERID of a third user:
In this case, the XCON-USERID in the request "confUserID" is the
sender's one and the "entity" attribute of the attached userInfo
is filled with the fake value
"xcon-userid:AUTO_GENERATE_1@example.com". The XCON-USERID for
the third user MUST be returned to the client issuing the request
in the "entity" attribute of the response "userInfo" parameter, if
the "response-code" is "200". This scenario is intended to
support both the case where a brand new conferencing system user
is added to a conference by a third party (i.e. a user who is not
yet provided with an XCON-USERID) and the case where the CCMP
client issuing the request does not know the to-be-added user's
XCON-USERID (which means such an identifier could already exist on
the server's side for that user). In this last case, the
conferencing server is in charge of avoiding XCON-URI duplicates
for the same conferencing client, looking at key fields in the
request provided "userInfo" parameter, such as the signalling URI:
if the joining user is a brand new one, then the generation of a
new XCON identifier is needed; otherwise, if that user is an
existing one, the server must recover the corresponding XCON
identifier.
Barnes, et al. Expires February 4, 2012 [Page 33]
Internet-Draft CCMP August 2011
In the case of a userRequest with a "retrieve" operation, the
"confObjID" representing the XCON-URI of the target conference MUST
be included. The "confUserID", containing the CCMP client's xcon-
userid, MUST also be included in the userRequest message. If the
client wants to retrieve information about her profile in the
specified conference, no "userInfo" parameter is needed in the
retrieve request. On the other hand, if the client wants to obtain
someone else's info within the given conference, she MUST include in
the userRequest/retrieve a "userInfo" parameter whose "entity"
attribute conveys the desired user's xcon-userid. If the
userResponse for the "retrieve" operation contains a "response-code"
of "200", the "userInfo" parameter MUST be included in the response.
In case of a userRequest with an "update" operation, the "confObjID",
"confUserID" and "userInfo" MUST be included in the request. The
"userInfo" is of type "user-type" and contains all the changes to be
applied to a specific <user> element in the conference object
identified by the "confObjID" in the userRequest message. The user
to be modified is identified through the "entity" attribute of the
"userInfo" parameter included in the request. In the case of a
userResponse with a "response-code" of "200", no additional
information is required in the "userResponse" message. A "response-
code" of "200" indicates that the referenced user element has been
updated by the conference server. A "response-code" of "426"
indicates that the conferencing client is not allowed to make the
changes reflected in the "userInfo" in the initial request. This
could be due to policies, roles, specific privileges, etc., with the
reason specific to a conferencing system and its configuration.
In the case of a userRequest with a "delete" operation, the
"confObjID" representing the XCON-URI of the target conference MUST
be included. The "confUserID", containing the CCMP client's xcon-
userid, MUST be included in the userRequest message. If the client
wants to exit the specified conference, no "userInfo" parameter is
needed in the delete request. On the other hand, if the client wants
to remove another participant from the given conference, she MUST
include in the userRequest/delete a "userInfo" parameter whose
"entity" attribute conveys the xcon-userid of that participant. The
userResponse MUST contain the same "confObjID" that was included in
the userRequest. The userResponse MUST contain a "response-code" of
"200" if the target <user> element has been successfully deleted. If
the userResponse for the "delete" operation contains a "response-
code" of "200", the userResponse MUST NOT contain the "userInfo"
parameter.
<!-- userRequest -->
Barnes, et al. Expires February 4, 2012 [Page 34]
Internet-Draft CCMP August 2011
<xs:complexType name="ccmp-user-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="userRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- userRequestType -->
<xs:element name="userRequest" type="userRequestType" />
<xs:complexType name="userRequestType">
<xs:sequence>
<xs:element name="userInfo"
type="info:user-type" minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- userResponse -->
<xs:complexType name="ccmp-user-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="userResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- userResponseType -->
<xs:element name="userResponse" type="userResponseType" />
<xs:complexType name="userResponseType">
<xs:sequence>
<xs:element name="userInfo" type="info:user-type
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
Barnes, et al. Expires February 4, 2012 [Page 35]
Internet-Draft CCMP August 2011
</xs:complexType>
Figure 12: Structure of the userRequest and userResponse messages
5.3.7. sidebarsByValRequest and sidebarsByValResponse
A "sidebarsByValRequest" is used to execute a retrieve-only operation
on the <sidebars-by-val> field of the conference object represented
by the "confObjID". The "sidebarsByValRequest" message is of a
"retrieve-only" type, so an "operation" parameter MUST NOT be
included in a "sidebarsByValRequest" message. As with blueprints and
conferences, also with sidebars, CCMP allows for the use of xpath
filters whenever a selected subset of the sidebars available at the
server's side has to be retrieved by the client. This applies both
to sidebars by reference and to sidebars by value. A
"sidebarsByValResponse" with a "response-code" of "200" MUST contain
a "sidebarsByValInfo" parameter containing the desired <sidebars-by-
val> element. A "sidebarsByValResponse" message MUST carry back to
the client a "version" element related to the current version of the
main conference object (i.e. the one whose identifier is contained in
the "confObjId" field of the request) to which the sidebars in
question are associated. The "sidebarsByValInfo" parameter contains
the list of the conference objects associated with the sidebars by
value derived from the main conference. The retrieved sidebars can
then be updated or deleted using the "sidebarByValRequest" message,
which is described in Section 5.3.8.
<!-- sidebarsByValRequest -->
<xs:complexType name="ccmp-sidebarsByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByValRequestType -->
<xs:element name="sidebarsByValRequest"
type="sidebarsByValRequestType" />
<xs:complexType name="sidebarsByValRequestType">
<xs:sequence>
Barnes, et al. Expires February 4, 2012 [Page 36]
Internet-Draft CCMP August 2011
<xs:element name="xpathFilter" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByValResponse -->
<xs:complexType name="ccmp-sidebarsByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByValResponseType -->
<xs:element name="sidebarsByValResponse"
type="sidebarsByValResponseType" />
<xs:complexType name="sidebarsByValResponseType">
<xs:sequence>
<xs:element name="sidebarsByValInfo"
type="info:sidebars-by-val-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 13: Structure of the sidebarsByValRequest and
sidebarsByValResponse messages
5.3.8. sidebarByValRequest and sidebarByValResponse
A sidebarByValRequest message MUST contain the "operation" parameter
which discriminates among retrieval, creation, modification and
deletion of a specific sidebar. The other required parameters depend
upon the type of operation.
In the case of a "create" operation, the "confObjID" parameter MUST
Barnes, et al. Expires February 4, 2012 [Page 37]
Internet-Draft CCMP August 2011
be included in the sidebyValRequest message. In this case, the
"confObjID" parameter contains the XCON-URI of the main conference in
which the sidebar has to be created. If no "sidebarByValInfo"
parameter is included, as envisaged in the XCON framework
([RFC5239]), the sidebar is created by cloning the main conference,
following the implementation specific cloning rules. Otherwise,
similarly to the case of direct creation, the sidebar conference
object is built on the basis of the "sidebarByValInfo" parameter
provided by the requestor. As a consequence of a sidebar-by-val
creation, the conference server MUST update the main conference
object reflected by the "confObjID" parameter in the
sidebarbyValRequest/create message introducing the new sidebar object
as a new new <entry> in the proper section <sidebars-by-val>. The
newly created sidebar conference object MAY be included in the
sidebarByValResponse in the "sidebarByValInfo" parameter, if the
"response-code" is "200". The XCON-URI of the newly created sidebar
MUST appear in the "confObjID" parameter of the response. The
conference server can notify any conferencing clients that have
subscribed to the conference event package, and are authorized to
receive the notifications, of the addition of the sidebar to the
conference.
In the case of a "sidebarByVal" request with an operation of
"retrieve", the URI for the conference object created for the sidebar
(received in the response to a "create" operation or in a
sidebarsByValResponse message) MUST be included in the "confObjID"
parameter in the request. This "retrieve" operation is handled by
the conference server in the same manner as a "retrieve" operation
included in a confRequest message as detailed in Section 5.3.4.
In the case of a "sidebarByVal" request with an operation of
"update", the "sidebarByValInfo" MUST also be included in the
request. The "confObjID" parameter contained in the request message
identifies the specific sidebar instance to be updated. An "update"
operation on the "sidebarByValInfo" is handled by the conference
server in the same manner as an "update" operation on the confInfo
included in a confRequest message as detailed in Section 5.3.4. A
"sidebarByValResponse" message MUST carry back to the client a
"version" element related to the current version of the sidebar whose
identifier is contained in the "confObjId" field of the request.
If an "operation" of "delete" is included in the sidebarByVal
request, the "sidebarByValInfo" parameter MUST NOT be included in the
request. Any "sidebarByValInfo" included in the request MUST be
ignored by the conference server. The URI for the conference object
associated with the sidebar MUST be included in the "confObjID"
parameter in the request. If the specific conferencing user as
reflected by the "confUserID" in the request is authorized to delete
Barnes, et al. Expires February 4, 2012 [Page 38]
Internet-Draft CCMP August 2011
the conference, the conference server deletes the conference object
reflected by the "confObjID" parameter and updates the data in the
conference object from which the sidebar was cloned. The conference
server can notify any conferencing clients that have subscribed to
the conference event package, and are authorized to receive the
notifications, of the deletion of the sidebar to the conference.
If a sidebarByValRequest with an "operation" of "retrieve", "update"
or "delete" carries a "confObjID" which is not associated with any
existing sidebar-by-val, a confResponse message containing a "404"
error code will be generated on the server's side. This holds also
for the case in which the mentioned "confObjID" is related to an
existing conference object stored at the server, but associated with
a blueprint or with an actual conference or with a sidebar-by-ref
rather than a sidebar-by-val.
<!-- sidebarByValRequest -->
<xs:complexType name="ccmp-sidebarByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarByValRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByValRequestType -->
<xs:element name="sidebarByValRequest"
type="sidebarByValRequestType" />
<xs:complexType name="sidebarByValRequestType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByValResponse -->
Barnes, et al. Expires February 4, 2012 [Page 39]
Internet-Draft CCMP August 2011
<xs:complexType name="ccmp-sidebarByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByValResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByValResponseType -->
<xs:element name="sidebarByValResponse"
type="sidebarByValResponseType" />
<xs:complexType name="sidebarByValResponseType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 14: Structure of the sidebarByValRequest and
sidebarByValResponse messages
5.3.9. sidebarsByRefRequest and sidebarsByRefResponse
Similar to the sidebarsByValRequest, a sidebarsByRefRequest can be
invoked to retrieve the <sidebars-by-ref> element of the conference
object identified by the "confObjID" parameter. The
"sidebarsByRefRequest" message is of a "retrieve-only" type, so an
"operation" parameter MUST NOT be included in a
"sidebarsByRefRequest" message. In the case of a "response-code" of
"200", the "sidebarsByRefInfo" parameter, containing the <sidebars-
by-ref> element of the conference object, MUST be included in the
response. The <sidebars-by-ref> element represents the set of URIs
of the sidebars associated with the main conference, whose
description (in the form of a standard XCON conference document) is
external to the main conference itself. Through the retrieved URIs,
it is then possible to access single sidebars using the
"sidebarByRef" request message, described in Section 5.3.10. A
"sidebarsByRefResponse" message MUST carry back to the client a
"version" element related to the current version of the main
conference object (i.e. the one whose identifier is contained in the
Barnes, et al. Expires February 4, 2012 [Page 40]
Internet-Draft CCMP August 2011
"confObjId" field of the request) to which the sidebars in question
are associated.
<!-- sidebarsByRefRequest -->
<xs:complexType name="ccmp-sidebarsByRef-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByRefRequestType -->
<xs:element name="sidebarsByRefRequest"
type="sidebarsByRefRequestType" />
<xs:complexType name="sidebarsByRefRequestType">
<xs:sequence>
<xs:element name="xpathFilter"
type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByRefResponse -->
<xs:complexType name="ccmp-sidebarsByref-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByRefResponseType -->
<xs:element name="sidebarsByRefResponse"
Barnes, et al. Expires February 4, 2012 [Page 41]
Internet-Draft CCMP August 2011
type="sidebarsByRefResponseType" />
<xs:complexType name="sidebarsByRefResponseType">
<xs:sequence>
<xs:element name="sidebarsByRefInfo"
type="info:uris-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 15: Structure of the sidebarsByRefRequest and
sidebarsByRefResponse messages
5.3.10. sidebarByRefRequest and sidebarByRefResponse
A sidebarByRefRequest message MUST contain the "operation" parameter
which discriminates among retrieval, creation, modification and
deletion of a specific sidebar. The other required parameters depend
upon the type of operation.
In the case of a "create" operation, the "confObjID" parameter MUST
be included in the sidebyRefRequest message. In this case, the
"confObjID" parameter contains the XCON-URI of the main conference in
which the sidebar has to be created. If no "sidebarByRefInfo"
parameter is included, as envisaged in the XCON framework
([RFC5239]), the sidebar is created by cloning the main conference,
following the implementation specific cloning rules. Otherwise,
similarly to the case of direct creation, the sidebar conference
object is built on the basis of the "sidebarByRefInfo" parameter
provided by the requestor. If the creation of the sidebar is
successful, the conference server MUST update the "sidebars-by-ref"
element in the conference object from which the sidebar was created
(i.e., as identified by the "confObjID" in the original sidebarByRef
request), with the URI of the newly created sidebar. The newly
created conference object MAY be included in the response in the
"sidebarByRefInfo" parameter with a "response-code" of "200". The
URI for the conference object associated with the newly created
sidebar object MUST appear in the "confObjID" parameter of the
response. The conference server can notify any conferencing clients
that have subscribed to the conference event package, and are
authorized to receive the notifications, of the addition of the
sidebar to the conference.
In the case of a "sidebarByRef" request with an operation of
"retrieve", the URI for the conference object created for the sidebar
Barnes, et al. Expires February 4, 2012 [Page 42]
Internet-Draft CCMP August 2011
MUST be included in the "confObjID" parameter in the request. A
"retrieve" operation on the "sidebarByRefInfo" is handled by the
conference server in the same manner as a "retrieve" operation on the
confInfo included in a confRequest message as detailed in
Section 5.3.4.
In the case of a "sidebarByRef" request with an operation of
"update", the URI for the conference object created for the sidebar
MUST be included in the "confObjID" parameter in the request. The
"sidebarByRefInfo" MUST also be included in the request in the case
of an "operation" of "update". An "update" operation on the
"sidebarByRefInfo" is handled by the conference server in the same
manner as an "update" operation on the confInfo included in a
confRequest message as detailed in Section 5.3.4. A
"sidebarByRefResponse" message MUST carry back to the client a
"version" element related to the current version of the sidebar whose
identifier is contained in the "confObjId" field of the request.
If an "operation" of "delete" is included in the sidebarByRef
request, the "sidebarByRefInfo" parameter MUST NOT be included in the
request. Any "sidebarByRefInfo" included in the request MUST be
ignored by the conference server. The URI for the conference object
for the sidebar MUST be included in the "confObjID" parameter in the
request. If the specific conferencing user as reflected by the
"confUserID" in the request is authorized to delete the conference,
the conference server SHOULD delete the conference object reflected
by the "confObjID" parameter and SHOULD update the "sidebars-by-ref"
element in the conference object from which the sidebar was
originally cloned. The conference server can notify any conferencing
clients that have subscribed to the conference event package, and are
authorized to receive the notifications, of the deletion of the
sidebar.
If a sidebarByRefRequest with an "operation" of "retrieve", "update"
or "delete" carries a "confObjID" which is not associated with any
existing sidebar-by-ref, a confResponse message containing a "404"
error code will be generated on the server's side. This holds also
for the case in which the mentioned "confObjID" is related to an
existing conference object stored at the server, but associated with
a blueprint or with an actual conference or with a sidebar-by-val
rather than a sidebar-by-ref.
<!-- sidebarByRefRequest -->
<xs:complexType name="ccmp-sidebarByRef-request-message-type">
<xs:complexContent>
Barnes, et al. Expires February 4, 2012 [Page 43]
Internet-Draft CCMP August 2011
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByRefRequestType -->
<xs:element name="sidebarByRefRequest"
type="sidebarByRefRequestType" />
<xs:complexType name="sidebarByRefRequestType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByRefResponse -->
<xs:complexType name="ccmp-sidebarByRef-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByRefResponseType -->
<xs:element name="sidebarByRefResponse"
type="sidebarByRefResponseType" />
<xs:complexType name="sidebarByRefResponseType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
Barnes, et al. Expires February 4, 2012 [Page 44]
Internet-Draft CCMP August 2011
</xs:complexType>
Figure 16: Structure of the sidebarByRefRequest and
sidebarByRefResponse messages
5.3.11. extendedRequest and extendedResponse
In order to facilitate the possibility of specifying new request/
response pairs for conference control, CCMP makes available the
"extendedRequest" and "extendedResponse" messages. Such messages
constitute a CCMP skeleton in which implementors can transport the
information needed to realize conference control mechanisms not
explicitly envisioned in the CCMP specification; these mechanisms are
called, in this context, "extensions". Each extension is assumed to
be characterized by an appropriate name that MUST be carried in the
extendedRequest/extendedResponse pair in the provided <extensionName>
field. Extension-specific information can be transported in the form
of schema-defined XML elements inside the <any> element present in
both extendedRequest and extendedResponse.
The conferencing client SHOULD be able to be informed about the
extensions supported by a CCMP server and to recover the XML Schema
defining the related specific elements by means of an optionsRequest/
optionsResponse CCMP transaction (see Section 5.3.12).
The meaning of the common CCMP parameters inherited by the
extendedRequest and extendedResponse from the basic CCMP request and
response messages SHOULD be preserved and exploited appropriately
while defining an extension.
<!-- extendedRequest -->
<xs:complexType name="ccmp-extended-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="extendedRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- extendedRequestType -->
<xs:element name="extendedRequest" type="extendedRequestType"/>
Barnes, et al. Expires February 4, 2012 [Page 45]
Internet-Draft CCMP August 2011
<xs:complexType name="extendedRequestType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string" minOccurs="1"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- extendedResponse -->
<xs:complexType name="ccmp-extended-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="extendedResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- extendedResponseType -->
<xs:element name="extendedResponse" type="extendedResponseType"/>
<xs:complexType name="extendedResponseType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string"
minOccurs="1"/>
<xs:any namespace="##other"
processContents="lax"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
Figure 17: Structure of the extendedRequest and extendedResponse
messages
5.3.12. optionsRequest and optionsResponse
The "optionsRequest" (Figure 18) message is used to retrieve general
information about conference server capabilities. These capabilities
include the standard CCMP messages (request/response pairs) and
potential extension messages supported by the conference server. As
such it is a basic CCMP message, rather than a specialization of the
Barnes, et al. Expires February 4, 2012 [Page 46]
Internet-Draft CCMP August 2011
general CCMP request.
The "optionsResponse" returns, in the appropriate <options> field, a
list of the supported CCMP message pairs as defined in this
specification. These messages are in the form of a list, <standard-
message-list> including each of the supported messages as reflected
by <standard-message> elements. The "optionsResponse" message also
allows for an <extended-message-list>, which is a list of additional
message types in the form of <extended-message-list> elements that
are currently undefined, to allow for future extensibility. The
following information is provided for both types of messages:
o <name> (REQUIRED): in case of standard messages, it can be one of
the ten standard message names defined in this document (i.e.
"blueprintsRequest", "confsRequest", etc.). In case of
extensions, this element MUST carry the same value of the
<extension-name> inserted in the corresponding extendedRequest/
extendedResponse message pair
o <operations> (OPTIONAL): this field is a list of <operation>
entries, each representing the CRUD operation supported by the
server for the message. If this element is absent, the client
SHOULD assume the server is able to handle the entire set of CRUD
operations or, in case of standard messages, all the operations
envisioned for that message in this document.
o <schema-ref> (OPTIONAL): since all CCMP messages can potentially
contain XML elements not envisioned in the CCMP schema (due to the
presence of <any> elements and attributes), a reference to a
proper schema definition specifying such new elements/attributes
can also be sent back to the clients by means of such field. If
this element is absent, no new elements are introduced in the
messages further than those explicitly defined in the CCMP
specification.
o <description> (OPTIONAL): human readable information about the
related message
The only parameter needed in the optionsRequest is the sender
confUserID, which is mirrored in the homologous parameter of the
corresponding optionsResponse.
The CCMP server MUST include the <standard-message-list> containing
at least one <operation> element in the optionsResponse, since a CCMP
server is REQUIRED to be able to handle both the request and response
messages for at least one of the operations.
Barnes, et al. Expires February 4, 2012 [Page 47]
Internet-Draft CCMP August 2011
<!-- optionsRequest -->
<xs:complexType name="ccmp-options-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type"/>
</xs:complexContent>
</xs:complexType>
<!-- optionsResponse -->
<xs:complexType name="ccmp-options-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="optionsResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- optionsResponseType -->
<xs:element name="optionsResponse"
type="optionsResponseType" />
<xs:complexType name="optionsResponseType">
<xs:sequence>
<xs:element name="options"
type="options-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- options-type -->
<xs:complexType name="options-type">
<xs:sequence>
<xs:element name="standard-message-list"
type="standard-message-list-type"
minOccurs="1"/>
<xs:element name="extended-message-list"
type="extended-message-list-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
Barnes, et al. Expires February 4, 2012 [Page 48]
Internet-Draft CCMP August 2011
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-list-type -->
<xs:complexType name="standard-message-list-type">
<xs:sequence>
<xs:element name="standard-message"
type="standard-message-type"
minOccurs="1" maxOccurs="10"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-type -->
<xs:complexType name="standard-message-type">
<xs:sequence>
<xs:element name="name"
type="standard-message-name-type"
minOccurs="1"/>
<xs:element name="operations"
type="operations-type"
minOccurs="0"/>
<xs:element name="schema-def"
type="xs:string" minOccurs="0"/>
<xs:element name="description"
type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-name-type -->
<xs:simpleType name="standard-message-name-type">
<xs:restriction base="xs:token">
<xs:enumeration value="confsRequest"/>
<xs:enumeration value="confRequest"/>
<xs:enumeration value="blueprintsRequest"/>
<xs:enumeration value="blueprintRequest"/>
<xs:enumeration value="usersRequest"/>
<xs:enumeration value="userRequest"/>
<xs:enumeration value="sidebarsByValRequest"/>
<xs:enumeration value="sidebarByValRequest"/>
Barnes, et al. Expires February 4, 2012 [Page 49]
Internet-Draft CCMP August 2011
<xs:enumeration value="sidebarsByRefRequest"/>
<xs:enumeration value="sidebarByRefRequest"/>
</xs:restriction>
</xs:simpleType>
<!-- operations-type -->
<xs:complexType name="operations-type">
<xs:sequence>
<xs:element name="operation" type="operationType"
minOccurs="1" maxOccurs="4"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 18: Structure of the optionsRequest and optionsResponse
messages
5.4. CCMP Response Codes
All CCMP response messages MUST include a "response-code". This
document defines an IANA registry for the CCMP response codes as
described in Section 12.5.2. The following summarizes the CCMP
response codes:
200 Success: Successful completion of the requested operation.
400 Bad Request: Syntactically malformed request.
401 Unauthorized: User not allowed to perform the required
operation.
403 Forbidden: Operation not allowed (e.g., cancellation of a
blueprint).
404 Object Not Found: Target conference object missing at the server
(it refers to the "confObjID" parameter in the generic request
message)
409 Conflict: A generic error associated with all those situations
in which a requested client operation cannot be successfully
completed by the server. An example of such situation is when the
modification of an object cannot be applied due to conflicts
arising at the server's side, e.g. because the client version of
the object is an obsolete one and the requested modifications
collide with the up-to-date state of the object stored at the
server. Such code would also be used if a client attempts to
Barnes, et al. Expires February 4, 2012 [Page 50]
Internet-Draft CCMP August 2011
create an object (conference or user) with an entity that already
exists.
420 User Not Found: Target user missing at the server (it is related
to the XCON-USERID in the "entity" attribute of the "userInfo"
parameter when it is included in userRequests)
421 Invalid confUserID: User missing at the server (this code is
returned in the case of requests in which the "confUserID" of the
sender is invalid).
422 Invalid Conference Password: Target conference object's password
contained in the request is wrong.
423 Conference Password Required: "conference-password" missing in a
request to access a password-protected conference object.
424 Authentication Required: User's authentication information is
missing or invalid.
425 Forbidden Delete Parent: Cancel operation failed since the
target object is a parent of child objects which depend on it, or
because it effects, based on the "parent-enforceable" mechanism,
the corresponding element in a child object.
426 Forbidden Change Protected: Update refused by the server because
the target element cannot be modified due to its implicit
dependence on the value of a parent object ("parent-enforceable"
mechanism).
427 Invalid Domain Name: The domain name in an AUTO_GENERATE_X
instance in the conference object is not within the CCMP server's
domain of responsibility.
500 Server Internal Error: The server cannot complete the required
service due to a system internal error.
501 Not Implemented: Operation envisaged in the protocol, but not
implemented in the contacted server.
510 Request Timeout: The time required to serve the request has
exceeded the envisaged service threshold.
511 Resources Not Available: This code is used when the CCMP server
cannot execute a command because of resource issues, e.g. it
cannot create a sub conference because the system has reached its
limits on the number of sub conferences, or if a request for
adding a new user fails because the max number of users has been
Barnes, et al. Expires February 4, 2012 [Page 51]
Internet-Draft CCMP August 2011
reached for the conference or the max number of users has been
reached for the conferencing system.
The handling of a "response-code" of "404", "409", "420", "421",
"425", "426" and "427" are only applicable to specific operations for
specialized message responses and the details are provided in
Section 5.3. The following table summarizes these response codes and
the specialized message and operation to which they are applicable:
+----------+-------------+--------------+-------------+-------------+
| Response | Create | Retrieve | Update | Delete |
| code | | | | |
+----------+-------------+--------------+-------------+-------------+
| 404 | userRequest | All retrieve | All update | All delete |
| | sidebarBy | requests | requests | requests |
| | ValRequest, | EXCEPT: | | |
| | sidebarsBy | blueprints | | |
| | RefRequest | Request, | | |
| | | confsRequest | | |
| -------- | ----------- | ------------ | ----------- | ----------- |
| | - | | | |
| 409 | N/A | N/A | All update | N/A |
| | | | requests | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 420 | userRequest | userRequest | userRequest | userRequest |
| | (3rd party | | | |
| | invite with | | | |
| | third user | | | |
| | entity) (*) | | | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 421 | All create | All retrieve | All update | All delete |
| | requests | requests | requests | requests |
| | EXCEPT: | | | |
| | userRequest | | | |
| | with no | | | |
| | confUserID | | | |
| | (**) | | | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 425 | N/A | N/A | N/A | All delete |
| | | | | request |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 426 | N/A | N/A | All update | N/A |
| | | | requests | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 427 | ConfRequest | N/A | All update | N/A |
| | UserRequest | | requests | |
+----------+-------------+--------------+-------------+-------------+
Barnes, et al. Expires February 4, 2012 [Page 52]
Internet-Draft CCMP August 2011
Table 2: Response codes and associated operations
(*) "420" in answer to a "userRequest/create" operation: in the case
of a third-party invite, this code can be returned if the
"confUserID" (contained in the "entity" attribute of the "userInfo"
parameter) of the user to be added is unknown. In the case above, if
instead it is the "confUserID" of the sender of the request that is
invalid, a "421" error code is returned to the client.
(**) "421" is not sent in answers to "userRequest/create" messages
having a "null" confUserID, since this case is associated with a user
who is unaware of his own XCON-USERID, but wants to enter a known
conference.
In the case of a response code of "510", a conferencing client MAY
re-attempt the request within a period of time that would be specific
to a conference control client or conference control server.
A response code of "400" indicates that the conference control client
sent a malformed request, which is indicative of an error in the
conference control client or in the conference control server. The
handling is specific to the conference control client implementation
(e.g., generate a log, display an error message, etc.). It is NOT
RECOMMENDED that the client re-attempt the request in this case.
Response codes such as "401" and "403" indicate the client does not
have the appropriate permissions, or there is an error in the
permissions: re-attempting the request would likely not succeed and
thus it is NOT RECOMMENDED.
Any unexpected or unknown "response-code" SHOULD be treated by the
client in the same manner as a "500" "response-code", the handling of
which is specific to the conference control client implementation.
6. A complete example of the CCMP in action
In this section a typical, not normative, scenario in which the CCMP
comes into play is described, by showing the actual composition of
the various CCMP messages. In the call flows of the example, the
Conference Control Client is a CCMP-enabled client, whereas the
Conference Control Server is a CCMP-enabled server. The "confUserID"
of the client, Alice, is "xcon-userid:alice@example.com" and appears
in all requests. The sequence of operations is as follows:
1. Alice retrieves from the server the list of available blueprints
(Section 6.1);
Barnes, et al. Expires February 4, 2012 [Page 53]
Internet-Draft CCMP August 2011
2. Alice asks for detailed information about a specific blueprint
(Section 6.2);
3. Alice decides to create a new conference by cloning the retrieved
blueprint (Section 6.3);
4. Alice modifies information (e.g. XCON-URI, name, description)
associated with the newly created blueprint (Section 6.4);
5. Alice specifies a list of users to be contacted when the
conference is activated (Section 6.5);
6. Alice joins the conference (Section 6.6);
7. Alice lets a new user, Ciccio, (whose "confUserID" is
"xcon-userid:Ciccio@example.com") join the conference
(Section 6.7).
8. Alice asks for the CCMP server capabilities (Section 6.8);
9. Alice exploits an extension of the CCMP server (Section 6.9).
Note, the examples do not include any details beyond the basic
operation.
In the following sections we deal with each of the above mentioned
actions separately.
6.1. Alice retrieves the available blueprints
This section illustrates the transaction associated with retrieval of
the blueprints, together with a dump of the two messages exchanged
("blueprintsRequest" and "blueprintsResponse"). As it comes out from
the figure, the "blueprintsResponse" message contains, in the
"blueprintsInfo" parameter, information about the available
blueprints, in the form of the standard XCON-URI of the blueprint,
plus additional (and optional) information, like its display-text and
purpose.
Alice retrieves from the server the list of available blueprints:
CCMP Client CCMP Server
| |
| CCMP blueprintsRequest message |
| - confUserID: Alice |
Barnes, et al. Expires February 4, 2012 [Page 54]
Internet-Draft CCMP August 2011
| - confObjID: (null) |
|------------------------------------------------------>|
| |
| CMP blueprintsResponse message |
| - confUserID: Alice |
| - confObjID: (null) |
| - response-code: 200 |
| - blueprintsInfo: bp123,bp124,.. |
|<------------------------------------------------------|
| |
. .
. .
1. blueprintsRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprints-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<ccmp:blueprintsRequest/>
</ccmpRequest>
</ccmp:ccmpRequest>
2. blueprintsResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprints-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<response-code>200</response-code>
<ccmp:blueprintsResponse>
<blueprintsInfo>
<info:entry>
<info:uri>xcon:AudioRoom@example.com</info:uri>
<info:display-text>AudioRoom</info:display-text>
<info:purpose>Simple Room:
conference room with public access,
where only audio is available, more users
Barnes, et al. Expires February 4, 2012 [Page 55]
Internet-Draft CCMP August 2011
can talk at the same time
and the requests for the AudioFloor
are automatically accepted.
</info:purpose>
</info:entry>
<info:entry>
<info:uri>xcon:VideoRoom@example.com</info:uri>
<info:display-text>VideoRoom</info:display-text>
<info:purpose>Video Room:
conference room with public access,
where both audio and video are available,
8 users can talk and be seen at the same time,
and the floor requests are automatically accepted.
</info:purpose>
</info:entry>
<info:entry>
<info:uri>xcon:AudioConference1@example.com</info:uri>
<info:display-text>AudioConference1</info:display-text>
<info:purpose>Public Audio Conference:
conference with public access,
where only audio is available,
only one user can talk at the same time,
and the requests for the AudioFloor MUST
be accepted by a Chair.
</info:purpose>
</info:entry>
<info:entry>
<info:uri>xcon:VideoConference1@example.com</info:uri>
<info:display-text>VideoConference1</info:display-text>
<info:purpose>Public Video Conference: conference
where both audio and video are available,
only one user can talk
</info:purpose>
</info:entry>
<info:entry>
<info:uri>xcon:AudioConference2@example.com</info:uri>
<info:display-text>AudioConference2</info:display-text>
<info:purpose>Basic Audio Conference:
conference with private access,
where only audio is available,
only one user can talk at the same time,
and the requests for the AudioFloor MUST
be accepted by a Chair.
</info:purpose>
</info:entry>
</blueprintsInfo>
</ccmp:blueprintsResponse>
</ccmpResponse>
Barnes, et al. Expires February 4, 2012 [Page 56]
Internet-Draft CCMP August 2011
</ccmp:ccmpResponse>
Figure 19: Getting blueprints from the server
6.2. Alice gets detailed information about a specific blueprint
This section illustrates the second transaction in the overall flow.
In this case, Alice, who now knows the XCON-URIs of the blueprints
available at the server, makes a drill-down query, in the form of a
CCMP "blueprintRequest" message, to get detailed information about
one of them (the one called with XCON-URI
"xcon:AudioRoom@example.com"). The picture shows such transaction.
Notice that the response contains, in the "blueprintInfo" parameter,
a document compliant with the standard XCON data model.
Alice retrieves detailed information about a specified blueprint:
CCMP Client CCMP Server
| |
| CCMP blueprintRequest message |
| - confUserID: Alice |
| - confObjID: bp123 |
| - operation: retrieve |
| - blueprintInfo: (null) |
|------------------------------------------------------>|
| |
| CCMP blueprintResponse message |
| - confUserID: Alice |
| - confObjID: bp123 |
| - operation: retrieve |
| - response-code: 200 |
| - blueprintInfo: bp123Info |
|<------------------------------------------------------|
| |
. .
. .
1. blueprintRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
Barnes, et al. Expires February 4, 2012 [Page 57]
Internet-Draft CCMP August 2011
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprint-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:AudioRoom@example.com</confObjID>
<operation>retrieve</operation>
<ccmp:blueprintRequest/>
</ccmpRequest>
</ccmp:ccmpRequest>
2. blueprintResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprint-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:AudioRoom@example.com</confObjID>
<operation>retrieve</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<ccmp:blueprintResponse>
<blueprintInfo entity="xcon:AudioRoom@example.com">
<info:conference-description>
<info:display-text>AudioRoom</info:display-text>
<info:available-media>
<info:entry label="audioLabel">
<info:display-text>audio stream</info:display-text>
<info:type>audio</info:type>
</info:entry>
</info:available-media>
</info:conference-description>
<info:users>
<xcon:join-handling>allow</xcon:join-handling>
</info:users>
<xcon:floor-information>
<xcon:floor-request-handling>confirm</xcon:floor-request-handling>
<xcon:conference-floor-policy>
<xcon:floor id="audioFloor">
<xcon:media-label>audioLabel</xcon:media-label>
</xcon:floor>
</xcon:conference-floor-policy>
</xcon:floor-information>
</blueprintInfo>
</ccmp:blueprintResponse>
Barnes, et al. Expires February 4, 2012 [Page 58]
Internet-Draft CCMP August 2011
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 20: Getting info about a specific blueprint
6.3. Alice creates a new conference through a cloning operation
This section illustrates the third transaction in the overall flow.
Alice decides to create a new conference by cloning the blueprint
having XCON-URI "xcon:AudioRoom@example.com", for which she just
retrieved detailed information through the "blueprintRequest"
message. This is achieved by sending a "confRequest/create" message
having the blueprint's URI in the "confObjID" parameter. The picture
shows such transaction. Notice that the response contains, in the
"confInfo" parameter, the document associated with the newly created
conference, which is compliant with the standard XCON data model.
The "confObjID" in the response is set to the XCON-URI of the new
conference (in this case, "xcon:8977794@example.com"). We also
notice that this value is equal to the value of the "entity"
attribute of the <conference-info> element of the document
representing the newly created conference object.
Alice creates a new conference by cloning the
"xcon:AudioRoom@example.com" blueprint:
CCMP Client CCMP Server
| |
| CCMP confRequest message |
| - confUserID: Alice |
| - confObjID: AudioRoom |
| - operation: create |
| - confInfo: (null) |
|------------------------------------------------------>|
| |
| CCMP confResponse message |
| - confUserID: Alice |
| - confObjID: newConfId |
| - operation: create |
| - response-code: 200 |
| - version: 1 |
| - confInfo: newConfInfo |
|<------------------------------------------------------|
| |
Barnes, et al. Expires February 4, 2012 [Page 59]
Internet-Draft CCMP August 2011
. .
. .
1. confRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-conf-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:AudioRoom@example.com</confObjID>
<operation>create</operation>
<ccmp:confRequest/>
</ccmpRequest>
</ccmp:ccmpRequest>
2. confResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-conf-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>1</version>
<ccmp:confResponse>
<confInfo entity="xcon:8977794@example.com">
<info:conference-description>
<info:display-text>
New conference by Alice cloned from AudioRoom
</info:display-text>
<info:available-media>
<info:entry label="333">
<info:display-text>audio stream</info:display-text>
<info:type>audio</info:type>
</info:entry>
</info:available-media>
Barnes, et al. Expires February 4, 2012 [Page 60]
Internet-Draft CCMP August 2011
</info:conference-description>
<info:users>
<xcon:join-handling>allow</xcon:join-handling>
</info:users>
<xcon:floor-information>
<xcon:floor-request-handling>confirm</xcon:floor-request-handling>
<xcon:conference-floor-policy>
<xcon:floor id="11">
<xcon:media-label>333</xcon:media-label>
</xcon:floor>
</xcon:conference-floor-policy>
</xcon:floor-information>
</confInfo>
</ccmp:confResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 21: Creating a new conference by cloning a blueprint
6.4. Alice updates conference information
This section illustrates the fourth transaction in the overall flow.
Alice decides to modify some of the details associated with the
conference she just created. More precisely, she changes the
<display-text> element under the <conference-description> element of
the document representing the conference. This is achieved through a
"confRequest/update" message carrying the fragment of the conference
document to which the required changes have to be applied. As shown
in the picture, the response contains a code of "200", which
acknowledges the modifications requested by the client, while also
updating the conference version number from 1 to 2, as reflected in
the "version" parameter.
Alice updates information about the conference she just created:
CCMP Client CCMP Server
| |
| CCMP confRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - confInfo: confUpdates |
|------------------------------------------------------>|
Barnes, et al. Expires February 4, 2012 [Page 61]
Internet-Draft CCMP August 2011
| |
| CCMP confResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - response-code: 200 |
| - version: 2 |
| - confInfo: (null) |
|<------------------------------------------------------|
| |
. .
. .
1. confRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-conf-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>update</operation>
<ccmp:confRequest>
<confInfo entity="xcon:8977794@example.com">
<info:conference-description>
<info:display-text>
Alice's conference
</info:display-text>
</info:conference-description>
</confInfo>
</ccmp:confRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
2. confResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Barnes, et al. Expires February 4, 2012 [Page 62]
Internet-Draft CCMP August 2011
xsi:type="ccmp:ccmp-conf-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>update</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>2</version>
<ccmp:confResponse/>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 22: Updating conference information
6.5. Alice inserts a list of users in the conference object
This section illustrates the fifth transaction in the overall flow.
Alice modifies the <allowed-users-list> under the <users> element in
the document associated with the conference she created. To the
purpose, she exploits the "usersRequest" message provided by the
CCMP. The picture below shows the transaction.
Alice updates information about the list of users to whom access to
the conference is permitted:
CCMP Client CCMP Server
| |
| CCMP usersRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - usersInfo: usersUpdates |
|------------------------------------------------------>|
| |
| CCMP usersResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - response-code: 200 |
| - version: 3 |
| - usersInfo: (null) |
|<------------------------------------------------------|
| |
. .
. .
Barnes, et al. Expires February 4, 2012 [Page 63]
Internet-Draft CCMP August 2011
1. usersRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-users-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>update</operation>
<ccmp:usersRequest>
<usersInfo>
<xcon:allowed-users-list>
<xcon:target method="dial out"
uri="xmpp:cicciolo@pippozzo.com"/>
<xcon:target method="refer"
uri="tel:+1-972-555-1234"/>
<xcon:target method="refer"
uri="sip:Carol@example.com"/>
</xcon:allowed-users-list>
</usersInfo>
</ccmp:usersRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
2. usersResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-users-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>retrieve</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>3</version>
<ccmp:usersResponse/>
</ccmpResponse>
</ccmp:ccmpResponse>
Barnes, et al. Expires February 4, 2012 [Page 64]
Internet-Draft CCMP August 2011
Figure 23: Updating the list of allowed users for the conference
'xcon:8977794@example.com'
6.6. Alice joins the conference
This section illustrates the sixth transaction in the overall flow.
Alice uses the CCMP to add herself to the newly created conference.
This is achieved through a "userRequest/create" message containing,
in the "userInfo" parameter, a <user> element compliant with the XCON
data model representation. Notice that such element includes
information about the user's Address of Records, as well as her
current end-point. The picture below shows the transaction. Notice
how the "confUserID" parameter is equal to the "entity" attribute of
the <userInfo> element, which indicates that the request issued by
the client is a first-party one.
Alice joins the conference by issuing a "userRequest/create" message
with her own id to the server:
CCMP Client CCMP Server
| |
| CCMP userRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - userInfo: AliceUserInfo |
|------------------------------------------------------>|
| |
| CCMP userResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - response-code: 200 |
| - version: 4 |
| - userInfo: (null) |
|<------------------------------------------------------|
| |
. .
. .
1. userRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
Barnes, et al. Expires February 4, 2012 [Page 65]
Internet-Draft CCMP August 2011
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<ccmp:userRequest>
<userInfo entity="xcon-userid:alice@example.com">
<info:associated-aors>
<info:entry>
<info:uri>
mailto:Alice83@example.com
</info:uri>
<info:display-text>email</info:display-text>
</info:entry>
</info:associated-aors>
<info:endpoint entity="sip:alice_789@example.com"/>
</userInfo>
</ccmp:userRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
2. userResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>4</version>
<ccmp:userResponse/>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 24: Alice joins the conference through the CCMP
Barnes, et al. Expires February 4, 2012 [Page 66]
Internet-Draft CCMP August 2011
6.7. Alice adds a new user to the conference
This section illustrates the seventh and last transaction in the
overall flow. Alice uses the CCMP to add a new conferencing system
user, Ciccio, to the conference. This "third-party" request is
realized through a "userRequest/create" message containing, in the
"userInfo" parameter, a <user> element compliant with the XCON data
model representation. Notice that such element includes information
about Ciccio's Address of Records, as well as his current end-point,
but has a fake "entity" attribute, "AUTO_GENERATE_1@example.com" as
discussed in Section 4.3, since the XCON-USERID is initially unknown
to Alice. Thus, the conference server is in charge of generating a
new XCON-USERID for the user Alice indicates (i.e, Ciccio), and
returning it in the "entity" attribute of the "userInfo" parameter
carried in the response, as well as adding the user to the
conference. The picture below shows the transaction.
Alice adds user "Ciccio" to the conference by issuing a third-party
"userRequest/create" message to the server:
CCMP Client CCMP Server
| |
| CCMP userRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - userInfo: dummyUserID, CiccioUserInfo |
|------------------------------------------------------>|
| |
| CCMP optionsResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - response-code: 200 |
| - version: 5 |
| - userInfo: userIDCiccio, |
| CiccioUserInfo |
| |
|<------------------------------------------------------|
| |
. .
. .
1. "third party" userRequest message from Alice:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
Barnes, et al. Expires February 4, 2012 [Page 67]
Internet-Draft CCMP August 2011
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<ccmp:userRequest>
<userInfo entity="xcon-userid:AUTO_GENERATE_1@example.com">
<info:associated-aors>
<info:entry>
<info:uri>
mailto:Ciccio@example.com
</info:uri>
<info:display-text>email</info:display-text>
</info:entry>
</info:associated-aors>
<info:endpoint entity="sip:Ciccio@example.com"/>
</userInfo>
</ccmp:userRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
2. "third party" userResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<response-code>200</response-code>
<version>5</version>
<ccmp:userResponse>
<userInfo entity="xcon-userid:Ciccio@example.com">
<info:associated-aors>
<info:entry>
<info:uri>
mailto:Ciccio@example.com
</info:uri>
<info:display-text>email</info:display-text>
Barnes, et al. Expires February 4, 2012 [Page 68]
Internet-Draft CCMP August 2011
</info:entry>
</info:associated-aors>
<info:endpoint entity="sip:Ciccio@example.com"/>
</userInfo>
</ccmp:userResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 25: Alice adds a new user to the conference through the CCMP
6.8. Alice asks for the CCMP server capabilities
This section illustrates how Alice can discover which standard CCMP
messages and what extensions are supported by the CCMP server she
interacts with through an optionsRequest/optionsResponse transaction.
To prepare the optionsRequest, Alice just puts her XCON-USERID in the
confUserID parameter. Looking at the <options> element in the
received optionsResponse, Alice infers the following server
capabilities as regards standard CCMP messages:
o the server doesn't support sidebarsByValRequest nor
sidebarByValRequest messages, since they do not appear in the
<standard-message-list>;
o the only implemented operation for the blueprintRequest message is
"retrieve", since no other <operation> entries are included in the
related <operations> field.
By analyzing the <extended-message-list>, Alice discovers the server
implements a bluePrint extension, referred to as "confSummaryRequest"
in this example. This extension allows Alice to recover via CCMP a
brief description of a specific conference; the XML elements involved
in this extended conference control transaction are available at the
URL indicated in the <schema-ref> element and the only operation
provided by this extension is "retrieve". To better understand how
Alice can exploit the "confSummaryRequest" extension via CCMP, see
Section 6.9.
The figure below shows the optionsRequest/optionsResponse message
exchange between Alice and the CCMP server.
Barnes, et al. Expires February 4, 2012 [Page 69]
Internet-Draft CCMP August 2011
CCMP Client CCMP Server
| |
| CCMP optionsRequest message |
| - confUserID: Alice |
|------------------------------------------------------>|
| |
| CCMP userResponse message |
| - confUserID: Alice |
| - response-code: 200 |
| - options (list of both |
| standard and extended |
| supported messages) |
|<------------------------------------------------------|
| |
. .
. .
1. optionsRequest (Alice asks for CCMP server capabilities)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-options-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
</ccmpRequest>
</ccmp:ccmpRequest>
2. optionsResponse (the server returns the list of its conference
control capabilities)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-options-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<response-code>200</response-code>
<response-string>success</response-string>
<ccmp:optionsResponse>
<options>
<standard-message-list>
<standard-message>
Barnes, et al. Expires February 4, 2012 [Page 70]
Internet-Draft CCMP August 2011
<name>blueprintsRequest</name>
</standard-message>
<standard-message>
<name>blueprintRequest</name>
<operations>
<operation>retrieve</operation>
</operations>
</standard-message>
<standard-message>
<name>confsRequest</name>
</standard-message>
<standard-message>
<name>confRequest</name>
</standard-message>
<standard-message>
<name>usersRequest</name>
</standard-message>
<standard-message>
<name>userRequest</name>
</standard-message>
<standard-message>
<name>sidebarsByRefRequest</name>
</standard-message>
<standard-message>
<name>sidebarByRefRequest</name>
</standard-message>
</standard-message-list>
<extended-message-list>
<extended-message>
<name>confSummaryRequest</name>
<operations>
<operation>retrieve</operation>
</operations>
<schema-def>
http://example.com/ccmp-extension-schema.xsd
</schema-def>
<description>
confSummaryRequest is intented
to allow the requestor to retrieve
a brief description
of the conference indicated in the
confObjID request parameter
</description>
</extended-message>
</extended-message-list>
</options>
</ccmp:optionsResponse>
</ccmpResponse>
Barnes, et al. Expires February 4, 2012 [Page 71]
Internet-Draft CCMP August 2011
</ccmp:ccmpResponse>
Figure 26: Alice asks for the server control capabilities
6.9. Alice exploits a CCMP server extension
In this section, a very simple example of CCMP extension support is
provided. Alice can recover information about this and other server-
supported extensions by issuing an optionsRequest (see Section 6.8).
The extension in question is named "confSummaryRequest" and allows a
CCMP client to obtain from the CCMP server synthetic information
about a specific conference. The conference summary is carried in
the form of an XML element as follows:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://example.com/ccmp-extension"
xmlns="http://example.com/ccmp-extension">
<xs:element name="confSummary" type="conf-summary-type"/>
<xs:complexType name="conf-summary-type">
<xs:sequence>
<xs:element name="title" type="xs:string"/>
<xs:element name="status" type="xs:string"/>
<xs:element name="public" type="xs:boolean"/>
<xs:element name="media" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
Figure 27: Example of XML Schema defining an extension parameter
(ccmp-extension-schema.xsd)
As it can be inferred from the schema file, the <confSummary> element
contains conference information related to:
o title
o status (active or registered)
o participation modality (if everyone is allowed to participate, the
boolean <public> element is set to "true")
Barnes, et al. Expires February 4, 2012 [Page 72]
Internet-Draft CCMP August 2011
o involved media
In order to retrieve a conference summary related to the conference
she participates in, Alice then sends to the CCMP server an
extendedRequest with a "confSummaryRequest" <extensionName>,
specifying the conference xcon-uri in the confObjID request
parameter, as depicted in the figure below.
CCMP Client CCMP Server
| |
| CCMP extendedRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: retrieve |
| - extensionName: confSummaryRequest |
|------------------------------------------------------>|
| |
| CCMP extendedResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: retrieve |
| - response-code: 200 |
| - extensionName: |
| confSummaryRequest |
| - confSummary |
|<------------------------------------------------------|
| |
. .
. .
1. extendedRequest (Alice makes use of the "confSummaryRequest")
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:example="http://example.com/ccmp-extension">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-extended-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>retrieve</operation>
<ccmp:extendedRequest>
Barnes, et al. Expires February 4, 2012 [Page 73]
Internet-Draft CCMP August 2011
<extensionName>confRequestSummary</extensionName>
</ccmp:extendedRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
2. extendedResponse (the server provides Alice with a brief description
of the desired conference)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:example="http://example.com/ccmp-extension">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-extended-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>retrieve</operation>
<response-code>200</response-code>
<response-string>success</response-string>
<ccmp:extendedResponse>
<extensionName>confSummaryRequest</extensionName>
<example:confSummary>
<title> Alice's conference </title>
<status> active </status>
<public> true </public>
<media> audio </media>
</example:confSummary>
</ccmp:extendedResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 28: Alice exploits the 'confSummaryRequest' extension
7. Locating a Conference Control Server
If a conference control client is not pre-configured to use a
specific conference control server for the requests, the client MUST
first discover the conference control server before it can send any
requests. The result of the discovery process, is the address of the
server supporting conferencing. In this document, the result is an
http: or https: URI, which identifies a conference server.
DNS is RECOMMENDED to be used to locate a conference server in the
case that the client is not pre-configured to use a specific
Barnes, et al. Expires February 4, 2012 [Page 74]
Internet-Draft CCMP August 2011
conference server. U-NAPTR resolution for conferencing takes a
domain name as input and produces a URI that identifies the
conferencing server. This process also requires an Application
Service tag and an Application Protocol tag, which differentiate
conferencing-related NAPTR records from other records for that
domain.
Section 12.4.1 defines an Application Service tag of "XCON", which is
used to identify the centralized conferencing (XCON) server for a
particular domain. The Application Protocol tag "CCMP", defined in
Section 12.4.2, is used to identify an XCON server that understands
the CCMP protocol.
The NAPTR records in the following example Figure 29 demonstrate the
use of the Application Service and Protocol tags. Iterative NAPTR
resolution is used to delegate responsibility for the conferencing
service from "zonea.example.com." and "zoneb.example.com." to
"outsource.example.com.".
zonea.example.com.
;; order pref flags
IN NAPTR 100 10 "" "XCON-CCMP" ( ; service
"" ; regex
outsource.example.com. ; replacement
)
zoneb.example.com.
;; order pref flags
IN NAPTR 100 10 "" "XCON-CCMP" ( ; service
"" ; regex
outsource.example.com. ; replacement
)
outsource.example.com.
;; order pref flags
IN NAPTR 100 10 "u" "XCON-CCMP" ( ; service
"!*.!https://confs.example.com/!" ; regex
. ; replacement
)
Figure 29: Sample XCON-CCMP Service NAPTR Records
Details for the "XCON" Application Service tag and the "CCMP"
Application Protocol tag are included in Section 12.4.
Barnes, et al. Expires February 4, 2012 [Page 75]
Internet-Draft CCMP August 2011
8. Managing Notifications
As per [RFC5239], the CCMP is one of the following four protocols
which have been formally identified within the XCON framework:
Conference Control Protocol: between Conference and Media Control
Client and Conference Server. Such protocol is the subject of the
present document.
Binary floor Control Protocol: between the Floor Control Client and
the Floor Control Server. Such protocol is the BFCP, specified in
[RFC4582].
Call Signaling Protocol: between the Call Signaling Client and the
Focus. Such protocol can be either SIP or any other call
signaling protocol (e.g. H.323, IAX, etc.) capable of negotiating
a conferencing session.
Notification Protocol: between the Notification Client and the XCON
Notification Service. This specification does not define a new
notification protocol. For clients that use SIP as the call
signaling protocol, the XCON event package
[I-D.ietf-xcon-event-package] MUST be used by the client for
notifications of changes in the conference data as described
below.
The CCMP protocol specified in this document is a pro-active one and
is used by a conferencing client to send requests to a conferencing
server in order to retrieve information about the conference objects
stored by the server and to potentially manipulate them. However, a
complete conferencing solution is not prohibited from providing
clients with a means for receiving asynchronous updates about the
status of the objects available at the server. The notification
protocol, while conceptually independent of all the mentioned
companion protocols, can nonetheless be chosen in a way that is
consistent with the overall protocol architecture characterizing a
specific deployment, as discussed in the following.
When the conference control client uses SIP [RFC3261] as the
signaling protocol to participate in the conference, SIP event
notification can be used. In such a case, the conference control
client MUST implement the Conference event package for XCON
[I-D.ietf-xcon-event-package]. This is the default mechanism for
conferencing clients as is SIP for signaling per the XCON Framework
[RFC5239].
In the case where the interface to the conference server is entirely
web based, there is a common mechanism for web-based systems that
Barnes, et al. Expires February 4, 2012 [Page 76]
Internet-Draft CCMP August 2011
could be used - a "call back". With this mechanism, the conference
client provides the conference server with an HTTP URL which is
invoked when a change occurs. This is a common implementation
mechanism for e-commerce. This works well in the scenarios whereby
the conferencing client is a web server that provides the graphical
HTML user interface and uses CCMP as the backend interface to the
conference server. And, this model can co-exist with the SIP event
notification model. PC-based clients behind NATs could provide a SIP
event URI, whereas web-based clients using CCMP in the backend would
probably find the HTTP call back approach much easier. The details
of this approach are out of scope for the CCMP per se, thus the
expectation is that a future specification will document this
solution.
9. HTTP Transport
This section describes the use of HTTP [RFC2616] and HTTP Over TLS
[RFC2818] as transport mechanisms for the CCMP protocol, which a
conforming conference Server and Conferencing client MUST support.
Although CCMP uses HTTP as a transport, it uses a strict subset of
HTTP features, and due to the restrictions of some features, a
conferencing server might not be a fully compliant HTTP server. It
is intended that a conference server can easily be built using an
HTTP server with extensibility mechanisms, and that a conferencing
client can trivially use existing HTTP libraries. This subset of
requirements helps implementors avoid ambiguity with the many options
the full HTTP protocol offers.
Support of HTTP authentication [RFC2617] and cookies [RFC6265] is
OPTIONAL for a conferencing client that conforms to this
specification. These mechanism are unnecessary because CCMP requests
carry their own authentication information (in the "subject" field;
see Section 5.1). A conferencing client SHOULD include support for
HTTP proxy authentication.
A CCMP request is carried in the body of an HTTP POST request. The
conferencing client MUST include a Host header in the request.
The MIME type of CCMP request and response bodies is "application/
ccmp+xml". The conference server and conferencing client MUST
provide this value in the HTTP Content-Type and Accept header fields.
If the conference server does not receive the appropriate Content-
Type and Accept header fields, the conference server SHOULD fail the
request, returning a 406 (not acceptable) response. CCMP responses
SHOULD include a Content-Length header.
Barnes, et al. Expires February 4, 2012 [Page 77]
Internet-Draft CCMP August 2011
Conferencing clients MUST NOT use the "Expect" header or the "Range"
header in CCMP requests. The conference server MAY return 501 (not
implemented) errors if either of these HTTP features are used. In
the case that the conference server receives a request from the
conferencing client containing a If-* (conditional) header, the
conference server SHOULD return a 412 (precondition failed) response.
The POST method is the only method REQUIRED for CCMP. If a
conference server chooses to support GET or HEAD, it SHOULD consider
the kind of application doing the GET. Since a conferencing client
only uses a POST method, the GET or HEAD MUST be either an escaped
URL (e.g., somebody found a URL in protocol traces or log files and
fed it into their browser) or somebody doing testing/ debugging. The
conference server could provide information in the CCMP response
indicating that the URL corresponds to a conference server and only
responds to CCMP POST requests or the conference server could instead
try to avoid any leak of information by returning a very generic HTTP
error message such as 405 (method not allowed).
The conference server populates the HTTP headers of responses so that
they are consistent with the contents of the message. In particular,
the "CacheControl" header SHOULD be set to disable caching of any
conference information by HTTP intermediaries. Otherwise, there is
the risk of stale information and/or the unauthorized disclosure of
the information. The HTTP status code MUST indicate a 2xx series
response for all CCMP Response and Error messages.
The conference server MAY redirect a CCMP request. A conference
server MUST NOT include CCMP responses in a 3xx response. A
conferencing client MUST handle redirects, by using the Location
header provided by the server in a 3xx response. When redirecting,
the conferencing client MUST observe the delay indicated by the
Retry-After header. The conferencing client MUST authenticate the
server that returns the redirect response before following the
redirect. A conferencing client SHOULD authenticate the conference
server indicated in a redirect.
The conference server SHOULD support persistent connections and
request pipelining. If pipelining is not supported, the conference
server MUST NOT allow persistent connections. The conference server
MUST support termination of a response by the closing of a
connection.
Implementations of CCMP that implement HTTP transport MUST implement
transport over TLS [RFC2818]. TLS provides message integrity and
confidentiality between the conference control client and the
conference control server. The conferencing client MUST implement
the server authentication method described in HTTPS [RFC2818]. The
Barnes, et al. Expires February 4, 2012 [Page 78]
Internet-Draft CCMP August 2011
device uses the URI obtained during conference server discovery to
authenticate the server. The details of this authentication method
are provided in section 3.1 of HTTPS [RFC2818]. When TLS is used,
the conferencing client SHOULD fail a request if server
authentication fails.
10. Security Considerations
As identified in the XCON framework [RFC5239], there are a wide
variety of potential attacks related to conferencing, due to the
natural involvement of multiple endpoints and the capability to
manipulate the data on the conference server using CCMP. Examples of
attacks include the following: an endpoint attempting to listen to
conferences in which it is not authorized to participate, an endpoint
attempting to disconnect or mute other users, and theft of service by
an endpoint in attempting to create conferences it is not allowed to
create.
The following summarizes the security considerations for CCMP:
1. The client MUST determine the proper conference server. The
conference server discovery is described in Section 7.
2. The client MUST connect to the proper conference server. The
mechanisms for addressing this security consideration are
described in Section 10.1.
3. The protocol MUST support a confidentiality and integrity
mechanism. As described in Section 9, implementations of CCMP
MUST implement the HTTP transport over TLS [RFC2818].
4. There are security issues associated with the authorization to
perform actions on the conferencing system to invoke specific
capabilities. A conference server SHOULD ensure that only
authorized entities can manipulate the conference data. The
mechanisms for addressing this security consideration are
described in Section 10.2.
5. The privacy and security of the identity of a user in the
conference MUST be assured. The mechanisms to ensure the
security and privacy of identity are discussed in Section 10.3.
6. A final issue is related to Denial of Service (DoS) attacks on
the conferencing server itself. The recommendations to minimize
the potential and impact of DoS attacks are discussed in
Section 10.4.
Barnes, et al. Expires February 4, 2012 [Page 79]
Internet-Draft CCMP August 2011
Of the considerations listed above, items 1 and 3 are addressed
within the referenced sections earlier in this document. The
remaining security considerations are addressed in detail in the
following sections.
10.1. Assuring that the Proper Conferencing Server has been contacted
Section 7 describes a mechanism using DNS by which a conference
client discovers a conference server. A primary concern is spoofed
DNS replies, thus the use of DNSSEC is RECOMMENDED to ensure that the
client receives a valid response from the DNS server in cases where
this is a concern.
When the CCMP transaction is conducted using TLS [RFC5246], the
conference server can authenticate its identity, either as a domain
name or as an IP address, to the conference client by presenting a
certificate containing that identifier as a subjectAltName (i.e., as
an iPAddress or dNSName, respectively). Any implementation of CCMP
MUST be capable of being transacted over TLS so that the client can
request the above authentication. Note that in order for the
presented certificate to be valid at the client, the client MUST be
able to validate the certificate following the procedures in
[RFC2818] in the case of HTTP as a transport. In particular, the
validation path of the certificate must end in one of the client's
trust anchors, even if that trust anchor is the conference server
certificate itself. If the client has external information as to the
expected identity or credentials of the proper conference server, the
authentication checks described above MAY be omitted.
10.2. User Authentication and Authorization
Many policy authorization decisions are based on the identity of the
user or the role that a user may have. The conferencing server MUST
implement mechanisms for authentication of users to validate their
identity. There are several ways that a user might authenticate its
identity to the system. For users joining a conference using one of
the call signaling protocols, the user authentication mechanisms for
the specific protocol can be used. For example, in the case of a
user joining the conference using SIP signaling, the user
authentication as defined in [RFC3261] MUST be used. For the case of
users joining the conference using the CCMP, the CCMP Request
messages provide a subject field which contains a username and
password, which can be used for authentication. Since the CCMP
messages are RECOMMENDED to be carried over TLS, this information can
be sent securely.
The XCON Framework [RFC5239] provides an overview of other
authorization mechanisms. In the cases where a user is authorized
Barnes, et al. Expires February 4, 2012 [Page 80]
Internet-Draft CCMP August 2011
via multiple mechanisms, it is RECOMMENDED that the conference server
associate the authorization of the CCMP interface with other
authorization mechanisms - e.g., PSTN users that join with a PIN and
control the conference using CCMP. When a conference server presents
the identity of authorized users, it MAY provide information about
the way the identity was proven or verified by the system. A
conference server can also allow a completely unauthenticated user
into the system - this information SHOULD also be communicated to
interested parties.
Once a user is authenticated and authorized through the various
mechanisms available on the conference server, the conference server
MUST allocate a conference user identifier (XCON-USERID) and SHOULD
associate the XCON-USERID with any signaling specific user
identifiers that were used for authentication and authorization.
This XCON-USERID can be provided to a specific user through the
conference notification interface and MUST be provided to users that
interact with the conferencing system using the CCMP (i.e., in the
appropriate CCMP response messages). The XCON-USERIDs for each user/
participant in the conference are contained in the "entity" attribute
in the "user" element in the conference object. The XCON-USERID is
REQUIRED for any subsequent operations by the user on the conference
object and is carried in the confUserID parameter in the CCMP
requests and responses.
Note that the policy management of an XCON-compliant conference
system is out of the scope of this document, as well as of the XCON
WG. However, the specification of a policy management framework is
realizable with the overall XCON architecture, in particular with
regards to a Role Based Access Control (RBAC) approach. In RBAC, the
following elements are identified: (i) Users; (ii) Roles; (iii)
Objects; (iv) Operations; (v) Permissions. For all of the above
elements a direct mapping exists onto the main XCON entities. As an
example, RBAC objects map onto XCON data model objects and RBAC
operations map onto CCMP operations.
Future documents can define an RBAC framework for XCON, by first
focusing on the definition of roles and then specifying the needed
permission policy sets and role policy sets (used to associate policy
permission sets with specific roles). With these policies in place,
access to a conference object compliant with the XCON data model can
be appropriately controlled. As far as assigning users to roles, the
Users in the RBAC model relate directly to the "users" element in the
conference object. The "users" element is comprised of "user"
elements representing a specific user in the conferencing system.
Each "user" element contains an "entity" attribute with the XCON-
USERID and a "role" element. Thus, each authorized user (as
represented by an XCON-USERID) can be associated with a "role"
Barnes, et al. Expires February 4, 2012 [Page 81]
Internet-Draft CCMP August 2011
element.
10.3. Security and Privacy of Identity
An overview of the required privacy and anonymity for users of a
conferencing system are provided in the XCON Framework [RFC5239].
The security of the identity in the form of the XCON-USERID is
provided in the CCMP protocol through the use of TLS.
The conference server SHOULD support the mechanism to ensure the
privacy of the XCON-USERID. The conference client indicates the
desired level of privacy by manipulation of the "provide-anonymity"
element defined in the XCON data model
([I-D.ietf-xcon-common-data-model]. The "provide-anonymity" element
controls the degree to which a user reveals their identity. The
following summarizes the values for the "provide-anonymity" element
that the client includes in their requests:
"hidden": Ensures that other participants are not aware that there
is an additional participant (i.e., the user issuing the request)
in the conference. This could be used in cases of users that are
authorized with a special role in a conference (e.g., a supervisor
in a call center environment).
"anonymous": Ensures that other participants are aware that there
is another participant (i.e., the user issuing the request),
however, the other participants are not provided information as to
the identity of the user.
"semi-private": Ensures that the user's identity is only to be
revealed to other participants or users that have a higher level
authorization (e.g., a conferencing system can be configured such
that a human administrator can see all users).
If the client desires privacy, the conference client SHOULD include
the "provide-anonymity" element in the "confInfo" parameter in a CCMP
confRequest message with an "update" or "create" operation or in the
"userInfo" parameter in a CCMP userRequest message with an "update"
or "create" operation. If the "provide-anonymity" element is not
included in the conference object, then other users can see the
participant's identity. Participants are made aware of other
participants that are "anonymous" or "semi-private" when they perform
subsequent operations on the conference object or retrieve the
conference object or when they receive subsequent notifications.
Note, that independent of the level of anonymity requested by the
user, the identity of the user is always known by the conferencing
system as that is required to perform the necessary authorization as
Barnes, et al. Expires February 4, 2012 [Page 82]
Internet-Draft CCMP August 2011
described in Section 10.2. The degree to which human administrators
can see the information can be controlled using policies (e.g., some
information in the data model can be hidden from human
administrators).
10.4. Mitigating DoS Attacks
[RFC4732] provides an overview of possible DoS attacks. In order to
minimize the potential for DoS attacks, it is RECOMMENDED that
conferencing systems require user authentication and authorization
for any client participating in a conference. This can be
accomplished through the use of the mechanisms described in
Section 10.2, as well as by using the security mechanisms associated
with the specific signaling (e.g., SIPS) and media protocols (e.g.,
SRTP). In addition, Section 4.4 describes the use of a timer
mechanism to alleviate the situation whereby CCMP messages pend
indefinitely, thus increasing the potential that pending requests
continue to increase when is a server is receiving more requests than
it can process.
11. XML Schema
This section gives the XML Schema Definition
[W3C.REC-xmlschema-1-20041028] [W3C.REC-xmlschema-2-20041028] of the
"application/ccmp+xml" format. This is presented as a formal
definition of the "application/ccmp+xml" format. A new XML
namespace, a new XML schema, and the MIME type for this schema are
registered with IANA as described in Section 12. Note that this XML
Schema Definition is not intended to be used with on-the-fly
validation of the presence XML document. Whitespaces are included in
the schema to conform to the line length restrictions of the RFC
format without having a negative impact on the readability of the
document. Any conforming processor should remove leading and
trailing white spaces.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema
targetNamespace="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:tns="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:dm="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
Barnes, et al. Expires February 4, 2012 [Page 83]
Internet-Draft CCMP August 2011
<xs:import namespace="urn:ietf:params:xml:ns:xcon-conference-info"
schemaLocation="DataModel.xsd"/>
<xs:import namespace="urn:ietf:params:xml:ns:conference-info"
schemaLocation="rfc4575.xsd"/>
<xs:element name="ccmpRequest" type="ccmp-request-type" />
<xs:element name="ccmpResponse" type="ccmp-response-type" />
<!-- CCMP request definition -->
<xs:complexType name="ccmp-request-type">
<xs:sequence>
<xs:element name="ccmpRequest"
type="ccmp-request-message-type" />
</xs:sequence>
</xs:complexType>
<!-- ccmp-request-message-type -->
<xs:complexType abstract="true"
name="ccmp-request-message-type">
<xs:sequence>
<xs:element name="subject" type="subject-type"
minOccurs="0" maxOccurs="1" />
<xs:element name="confUserID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" type="operationType"
minOccurs="0" maxOccurs="1" />
<xs:element name="conference-password" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- CCMP response definition -->
<xs:complexType name="ccmp-response-type">
<xs:sequence>
<xs:element name="ccmpResponse"
type="ccmp-response-message-type" />
</xs:sequence>
</xs:complexType>
<!-- ccmp-response-message-type -->
Barnes, et al. Expires February 4, 2012 [Page 84]
Internet-Draft CCMP August 2011
<xs:complexType abstract="true" name="ccmp-response-message-type">
<xs:sequence>
<xs:element name="confUserID" type="xs:string"
minOccurs="1" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" type="operationType"
minOccurs="0"
maxOccurs="1" />
<xs:element name="response-code"
type="response-codeType"
minOccurs="1" maxOccurs="1" />
<xs:element name="response-string" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="version" type="xs:positiveInteger"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- CCMP REQUESTS -->
<!-- blueprintsRequest -->
<xs:complexType name="ccmp-blueprints-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintsRequestType -->
<xs:element name="blueprintsRequest" type="blueprintsRequestType"/>
<xs:complexType name="blueprintsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
Barnes, et al. Expires February 4, 2012 [Page 85]
Internet-Draft CCMP August 2011
</xs:complexType>
<!-- blueprintRequest -->
<xs:complexType name="ccmp-blueprint-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintRequestType -->
<xs:element name="blueprintRequest" type="blueprintRequestType" />
<xs:complexType name="blueprintRequestType">
<xs:sequence>
<xs:element name="blueprintInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confsRequest -->
<xs:complexType name="ccmp-confs-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confsRequestType -->
<xs:element name="confsRequest" type="confsRequestType" />
<xs:complexType name="confsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string"
minOccurs="0"/>
Barnes, et al. Expires February 4, 2012 [Page 86]
Internet-Draft CCMP August 2011
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confRequest -->
<xs:complexType name="ccmp-conf-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confRequestType -->
<xs:element name="confRequest" type="confRequestType" />
<xs:complexType name="confRequestType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- usersRequest -->
<xs:complexType name="ccmp-users-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="usersRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- usersRequestType -->
<xs:element name="usersRequest" type="usersRequestType" />
Barnes, et al. Expires February 4, 2012 [Page 87]
Internet-Draft CCMP August 2011
<xs:complexType name="usersRequestType">
<xs:sequence>
<xs:element name="usersInfo" type="info:users-type"
minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- userRequest -->
<xs:complexType name="ccmp-user-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="userRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- userRequestType -->
<xs:element name="userRequest" type="userRequestType" />
<xs:complexType name="userRequestType">
<xs:sequence>
<xs:element name="userInfo" type="info:user-type"
minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByValRequest -->
<xs:complexType name="ccmp-sidebarsByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Barnes, et al. Expires February 4, 2012 [Page 88]
Internet-Draft CCMP August 2011
<!-- sidebarsByValRequestType -->
<xs:element name="sidebarsByValRequest"
type="sidebarsByValRequestType" />
<xs:complexType name="sidebarsByValRequestType">
<xs:sequence>
<xs:element name="xpathFilter"
type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByRefRequest -->
<xs:complexType name="ccmp-sidebarsByRef-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByRefRequestType -->
<xs:element name="sidebarsByRefRequest"
type="sidebarsByRefRequestType" />
<xs:complexType name="sidebarsByRefRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByValRequest -->
<xs:complexType name="ccmp-sidebarByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
Barnes, et al. Expires February 4, 2012 [Page 89]
Internet-Draft CCMP August 2011
<xs:element ref="sidebarByValRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByValRequestType -->
<xs:element name="sidebarByValRequest"
type="sidebarByValRequestType"/>
<xs:complexType name="sidebarByValRequestType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByRefRequest -->
<xs:complexType name="ccmp-sidebarByRef-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByRefRequestType -->
<xs:element name="sidebarByRefRequest"
type="sidebarByRefRequestType" />
<xs:complexType name="sidebarByRefRequestType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Barnes, et al. Expires February 4, 2012 [Page 90]
Internet-Draft CCMP August 2011
<!-- extendedRequest -->
<xs:complexType name="ccmp-extended-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="extendedRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- extendedRequestType -->
<xs:element name="extendedRequest" type="extendedRequestType"/>
<xs:complexType name="extendedRequestType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string" minOccurs="1"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- optionsRequest -->
<xs:complexType name="ccmp-options-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- CCMP RESPONSES -->
<!-- blueprintsResponse -->
<xs:complexType name="ccmp-blueprints-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintsResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Barnes, et al. Expires February 4, 2012 [Page 91]
Internet-Draft CCMP August 2011
<!-- blueprintsResponseType -->
<xs:element name="blueprintsResponse" type="blueprintsResponseType"/>
<xs:complexType name="blueprintsResponseType">
<xs:sequence>
<xs:element name="blueprintsInfo" type="info:uris-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- blueprintResponse -->
<xs:complexType name="ccmp-blueprint-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintResponseType -->
<xs:element name="blueprintResponse" type="blueprintResponseType"/>
<xs:complexType name="blueprintResponseType">
<xs:sequence>
<xs:element name="blueprintInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confsResponse -->
<xs:complexType name="ccmp-confs-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confsResponse" />
</xs:sequence>
Barnes, et al. Expires February 4, 2012 [Page 92]
Internet-Draft CCMP August 2011
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confsResponseType -->
<xs:element name="confsResponse" type="confsResponseType" />
<xs:complexType name="confsResponseType">
<xs:sequence>
<xs:element name="confsInfo" type="info:uris-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confResponse -->
<xs:complexType name="ccmp-conf-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confResponseType -->
<xs:element name="confResponse" type="confResponseType" />
<xs:complexType name="confResponseType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- usersResponse -->
<xs:complexType name="ccmp-users-response-message-type">
<xs:complexContent>
Barnes, et al. Expires February 4, 2012 [Page 93]
Internet-Draft CCMP August 2011
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="usersResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- usersResponseType -->
<xs:element name="usersResponse" type="usersResponseType" />
<xs:complexType name="usersResponseType">
<xs:sequence>
<xs:element name="usersInfo" type="info:users-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- userResponse -->
<xs:complexType name="ccmp-user-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="userResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- userResponseType -->
<xs:element name="userResponse" type="userResponseType" />
<xs:complexType name="userResponseType">
<xs:sequence>
<xs:element name="userInfo" type="info:user-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Barnes, et al. Expires February 4, 2012 [Page 94]
Internet-Draft CCMP August 2011
<!-- sidebarsByValResponse -->
<xs:complexType name="ccmp-sidebarsByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByValResponseType -->
<xs:element name="sidebarsByValResponse"
type="sidebarsByValResponseType" />
<xs:complexType name="sidebarsByValResponseType">
<xs:sequence>
<xs:element name="sidebarsByValInfo"
type="info:sidebars-by-val-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByRefResponse -->
<xs:complexType name="ccmp-sidebarsByRef-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByRefResponseType -->
<xs:element name="sidebarsByRefResponse"
type="sidebarsByRefResponseType" />
<xs:complexType name="sidebarsByRefResponseType">
<xs:sequence>
<xs:element name="sidebarsByRefInfo" type="info:uris-type"
minOccurs="0"/>
Barnes, et al. Expires February 4, 2012 [Page 95]
Internet-Draft CCMP August 2011
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByValResponse -->
<xs:complexType name="ccmp-sidebarByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByValResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByValResponseType -->
<xs:element name="sidebarByValResponse"
type="sidebarByValResponseType" />
<xs:complexType name="sidebarByValResponseType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByRefResponse -->
<xs:complexType name="ccmp-sidebarByRef-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByRefResponseType -->
<xs:element name="sidebarByRefResponse"
Barnes, et al. Expires February 4, 2012 [Page 96]
Internet-Draft CCMP August 2011
type="sidebarByRefResponseType" />
<xs:complexType name="sidebarByRefResponseType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- extendedResponse -->
<xs:complexType name="ccmp-extended-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="extendedResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- extendedResponseType -->
<xs:element name="extendedResponse" type="extendedResponseType"/>
<xs:complexType name="extendedResponseType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string" minOccurs="1"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- optionsResponse -->
<xs:complexType name="ccmp-options-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="optionsResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
Barnes, et al. Expires February 4, 2012 [Page 97]
Internet-Draft CCMP August 2011
</xs:complexType>
<!-- optionsResponseType -->
<xs:element name="optionsResponse"
type="optionsResponseType" />
<xs:complexType name="optionsResponseType">
<xs:sequence>
<xs:element name="options"
type="options-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- CCMP ELEMENT TYPES -->
<!-- response-codeType-->
<xs:simpleType name="response-codeType">
<xs:restriction base="xs:positiveInteger">
<xs:pattern value="[0-9][0-9][0-9]" />
</xs:restriction>
</xs:simpleType>
<!-- operationType -->
<xs:simpleType name="operationType">
<xs:restriction base="xs:token">
<xs:enumeration value="retrieve"/>
<xs:enumeration value="create"/>
<xs:enumeration value="update"/>
<xs:enumeration value="delete"/>
</xs:restriction>
</xs:simpleType>
<!-- subject-type -->
<xs:complexType name="subject-type">
<xs:sequence>
<xs:element name="username" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="password" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
Barnes, et al. Expires February 4, 2012 [Page 98]
Internet-Draft CCMP August 2011
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- options-type -->
<xs:complexType name="options-type">
<xs:sequence>
<xs:element name="standard-message-list"
type="standard-message-list-type"
minOccurs="1"/>
<xs:element name="extended-message-list"
type="extended-message-list-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-list-type -->
<xs:complexType name="standard-message-list-type">
<xs:sequence>
<xs:element name="standard-message"
type="standard-message-type"
minOccurs="1" maxOccurs="10"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-type -->
<xs:complexType name="standard-message-type">
<xs:sequence>
<xs:element name="name"
type="standard-message-name-type"
minOccurs="1"/>
<xs:element name="operations"
type="operations-type"
minOccurs="0"/>
<xs:element name="schema-def" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
Barnes, et al. Expires February 4, 2012 [Page 99]
Internet-Draft CCMP August 2011
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-name-type -->
<xs:simpleType name="standard-message-name-type">
<xs:restriction base="xs:token">
<xs:enumeration value="confsRequest"/>
<xs:enumeration value="confRequest"/>
<xs:enumeration value="blueprintsRequest"/>
<xs:enumeration value="blueprintRequest"/>
<xs:enumeration value="usersRequest"/>
<xs:enumeration value="userRequest"/>
<xs:enumeration value="sidebarsByValRequest"/>
<xs:enumeration value="sidebarByValRequest"/>
<xs:enumeration value="sidebarsByRefRequest"/>
<xs:enumeration value="sidebarByRefRequest"/>
</xs:restriction>
</xs:simpleType>
<!-- operations-type -->
<xs:complexType name="operations-type">
<xs:sequence>
<xs:element name="operation" type="operationType"
minOccurs="1" maxOccurs="4"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- extended-message-list-type -->
<xs:complexType name="extended-message-list-type">
<xs:sequence>
<xs:element name="extended-message"
type="extended-message-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- extended-message-type -->
<xs:complexType name="extended-message-type">
<xs:sequence>
<xs:element name="name" type="xs:string" />
Barnes, et al. Expires February 4, 2012 [Page 100]
Internet-Draft CCMP August 2011
<xs:element name="operations"
type="operations-type"
minOccurs="0"/>
<xs:element name="schema-def" type="xs:string" />
<xs:element name="description"
type="xs:string"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
</xs:schema>
Figure 30
12. IANA Considerations
This document registers a new XML namespace, a new XML schema, and
the MIME type for the schema. This document also registers the
"XCON" Application Service tag and the "CCMP" Application Protocol
tag. This document also defines registries for the CCMP operation
types and response codes.
12.1. URN Sub-Namespace Registration
This section registers a new XML namespace,
""urn:ietf:params:xml:ns:xcon-ccmp"".
URI: "urn:ietf:params:xml:ns:xcon-ccmp"
Registrant Contact: IETF, XCON working group, (xcon@ietf.org),
Mary Barnes (mary.ietf.barnes@gmail.com).
XML:
Barnes, et al. Expires February 4, 2012 [Page 101]
Internet-Draft CCMP August 2011
BEGIN
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>CCMP Messages</title>
</head>
<body>
<h1>Namespace for CCMP Messages</h1>
<h2>urn:ietf:params:xml:ns:xcon-ccmp</h2>
[[NOTE TO IANA/RFC-EDITOR: Please update RFC URL and replace XXXX
with the RFC number for this specification.]]
<p>See RFCXXXX.</p>
</body>
</html>
END
12.2. XML Schema Registration
This section registers an XML schema as per the guidelines in
[RFC3688].
URI: urn:ietf:params:xml:schema:xcon-ccmp
Registrant Contact: IETF, XCON working group, (xcon@ietf.org), Mary
Barnes (mary.ietf.barnes@gmail.com).
Schema: The XML for this schema can be found as the entirety of
Section 11 of this document.
12.3. MIME Media Type Registration for 'application/ccmp+xml'
This section registers the "application/ccmp+xml" MIME type.
To: ietf-types@iana.org
Subject: Registration of MIME media type application/ccmp+xml
MIME media type name: application
MIME subtype name: ccmp+xml
Required parameters: (none)
Barnes, et al. Expires February 4, 2012 [Page 102]
Internet-Draft CCMP August 2011
Optional parameters: charset
Same as the charset parameter of "application/xml" as specified in
RFC 3023 [RFC3023], Section 3.2.
Encoding considerations: Same as the encoding considerations of
"application/xml" as specified in RFC 3023 [RFC3023], Section 3.2.
Security considerations: This content type is designed to carry
protocol data related to conference control. Some of the data
could be considered private. This media type does not provide any
protection and thus other mechanisms such as those described in
Section 10 are required to protect the data. This media type does
not contain executable content.
Interoperability considerations: None.
Published specification: RFC XXXX [[NOTE TO IANA/RFC-EDITOR: Please
replace XXXX with the RFC number for this specification.]]
Applications which use this media type: Centralized Conferencing
control clients and servers.
Additional Information: Magic Number(s): (none)
File extension(s): .ccmp
Macintosh File Type Code(s): TEXT
Person & email address to contact for further information: Mary
Barnes <mary.ietf.barnes@gmail.com>
Intended usage: LIMITED USE
Author/Change controller: The IETF
Other information: This media type is a specialization of
application/xml [RFC3023], and many of the considerations
described there also apply to application/ccmp+xml.
12.4. DNS Registrations
Section 12.4.1 defines an Application Service tag of "XCON", which is
used to identify the centralized conferencing (XCON) server for a
particular domain. The Application Protocol tag "CCMP", defined in
Section 12.4.2, is used to identify an XCON server that understands
the CCMP protocol.
Barnes, et al. Expires February 4, 2012 [Page 103]
Internet-Draft CCMP August 2011
12.4.1. Registration of a Conference Control Server Application Service
Tag
This section registers a new S-NAPTR/U-NAPTR Application Service tag
for XCON, as mandated by [RFC3958].
Application Service Tag: XCON
Intended usage: Identifies a server that supports centralized
conferencing.
Defining publication: RFCXXXX
Contact information: The authors of this document
Author/Change controller: The IESG
12.4.2. Registration of a Conference Control Server Application
Protocol Tag for CCMP
This section registers a new S-NAPTR/U-NAPTR Application Protocol tag
for the CCMP protocol, as mandated by [RFC3958].
Application Service Tag: CCMP
Intended Usage: Identifies the Centralized Conferencing (XCON)
Manipulation Protocol.
Applicable Service Tag(s): XCON
Terminal NAPTR Record Type(s): U
Defining Publication: RFCXXXX
Contact Information: The authors of this document
Author/Change Controller: The IESG
12.5. CCMP Protocol Registry
This document requests that the IANA create a new registry for the
CCMP protocol: http://www.iana.org/assignments/ccmp-parameters. The
document creates initial sub-registries for CCMP operation types and
response codes."
Barnes, et al. Expires February 4, 2012 [Page 104]
Internet-Draft CCMP August 2011
12.5.1. CCMP Message Types
The following summarizes the requested registry for CCMP Messages:
Related Registry: CCMP Message Types Registry
Defining RFC: RFC XXXX [NOTE TO IANA/RFC-EDITOR: Please replace XXXX
with the RFC number for this specification.]
Registration/Assignment Procedures: Following the policies outlined
in [RFC5226], the IANA policy for assigning new values for the
CCMP message types for CCMP shall be Specification Required.
Registrant Contact: IETF, XCON working group, (xcon@ietf.org), Mary
Barnes (mary.ietf.barnes@gmail.com).
This specification establishes the Message sub-registry under
http://www.iana.org/assignments/ccmp-messages. The initial Message
table is populated using the CCMP messages described in Section 4.1
and defined in the XML schema in Section 11.
Message Description Reference
------- ----------- ---------
optionsRequest Used by a conference control client [RFCxxxx]
to query a conference server for
its capabilities, in terms of
supported messages.
optionsResponse Returns a list of CCMP messages [RFCxxxx]
supported by the specific
conference server.
blueprintsRequest Used by a conference control client [RFCxxxx]
to query a conferencing system for
its capabilities, in terms of
available conference blueprints.
blueprintsResponse The blueprintsResponse returns a [RFCxxxx]
list of blueprints supported
by the specific conference server.
confsRequest Used by a conference control client [RFCxxxx]
to query a conference server for
its scheduled/active conferences.
confsResponse Returns the list of the currently [RFCxxxx]
Barnes, et al. Expires February 4, 2012 [Page 105]
Internet-Draft CCMP August 2011
activated/scheduled conferences
at the server.
confRequest Used to create a conference object [RFCxxxx]
and/or to request an operation on
the conference object as a whole.
confResponse Indicates the result of the operation [RFCxxxx]
on the conference object as a whole.
userRequest Used to request an operation on the [RFCxxxx]
"user" element in the conference object.
userResponse Indicates the result of the requested [RFCxxxx]
operation on the "user" element in
the conference object.
usersRequest Used to manipulate the "users" element [RFCxxxx]
in the conference object, including
parameters such as the "allowed-users-list",
"join-handling", etc.
usersResponse Indicates the result of the request to [RFCxxxx]
manipulate the "users" element in the
conference object.
sidebarsByValRequest Used to retrieve the "sidebars-by-val" [RFCxxxx]
element of the target conference object.
sidebarsByValResponse Returns the list of the sidebar-by-val [RFCxxxx]
conferences within the target conference
object.
sidebarsByRefRequest Used to retrieve the "sidebars-by-ref" [RFCxxxx]
element of the target conference object.
sidebarsByRefResponse Returns the list of the sidebar-by-ref [RFCxxxx]
conferences associated with the target
conference object.
sidebarByValRequest Used to request an operation on a [RFCxxxx]
sideber-by-val conference.
sidebarByValResponse Indicates the result of the request to [RFCxxxx]
manipulate a sidebar-by-val conference.
sidebarByRefRequest Used to request an operation on a [RFCxxxx]
sideber-by-ref conference.
Barnes, et al. Expires February 4, 2012 [Page 106]
Internet-Draft CCMP August 2011
sidebarByRefResponse Indicates the result of the request to [RFCxxxx]
manipulate a sidebar-by-ref conference.
12.5.2. CCMP Response Codes
The following summarizes the requested registry for CCMP Response
codes:
Related Registry: CCMP Response Code Registry
Defining RFC: RFC XXXX [NOTE TO IANA/RFC-EDITOR: Please replace XXXX
with the RFC number for this specification.]
Registration/Assignment Procedures: Following the policies outlined
in [RFC5226], the IANA policy for assigning new values for the
Response codes for CCMP shall be Specification Required.
Registrant Contact: IETF, XCON working group, (xcon@ietf.org), Mary
Barnes (mary.ietf.barnes@gmail.com).
This specification establishes the Response-code sub-registry under
http://www.iana.org/assignments/ccmp-parameters. The initial
Response-code table is populated using the Response codes defined in
Section 5.4 as follows:
Default
Response
Number String Description Reference
------ ------------- ------------ ---------
200 Success The request was successfully [RFCxxxx]
processed.
400 Bad Request The request was badly formed in [RFCxxxx]
some fashion.
401 Unauthorized The user was not authorized for [RFCxxxx]
the specific operation on the
conference object.
403 Forbidden The specific operation is not [RFCxxxx]
valid for the target conference
object.
404 Object Not Found The specific conference object [RFCxxxx]
was not found.
Barnes, et al. Expires February 4, 2012 [Page 107]
Internet-Draft CCMP August 2011
409 Conflict A requested operation cannot be [RFCxxxx]
successfully completed by the
server. For example, the
modification of an object
cannot be applied because
the client version of the object
is obsolete and the requested
modifications collide with the
up-to-date state of the object
stored at the server.
420 User Not Found The user who is the target of the [RFCxxxx]
requested operation is unknown.
421 Invalid confUserID The "confUserID" of the sender [RFCxxxx]
in the request is invalid.
422 Invalid Conference A request to access/manipulate [RFCxxxx]
Password a password-protected conference
object contained an invalid
"conference-password" parameter.
423 Conference Password A request to access/manipulate [RFCxxxx]
Required a password-protected conference
object did not contain a
"conference-password" parameter.
424 Authentication The server wants to authenticate [RFCxxxx]
Required the request through the "subject"
parameter but the parameter is
not provided in the request.
425 Forbidden Delete The conferencing system cannot [RFCxxxx]
Parent system cannot delete the specific
conference object because it is a
parent for another conference object.
426 Forbidden Change The target conference object [RFCxxxx]
Protected cannot be changed (e.g., due to
policies, roles or privileges).
427 Invalid Domain Name The domain name in an [RFCxxxx]
AUTO_GENERATE_X
instance in the conference object
is not within the conference
server's domain of responsibility.
Barnes, et al. Expires February 4, 2012 [Page 108]
Internet-Draft CCMP August 2011
500 Server Internal The conference server experienced [RFCxxxx]
Error some sort of internal error.
501 Not Implemented The specific operation is not [RFCxxxx]
implemented on the conferencing
system.
510 Request Timeout The request could not be [RFCxxxx]
processed within a reasonable
time (as specified by the
conferencing system).
511 Resources Not The conference server cannot [RFCxxxx]
Available execute a command because of
resource issues, e.g. it cannot
create a conference because
the system has reached its limits
on the number of conferences.
13. Acknowledgments
The authors appreciate the feedback provided by Dave Morgan, Pierre
Tane, Lorenzo Miniero, Tobia Castaldi, Theo Zourzouvillys, Sean
Duddy, Oscar Novo, Richard Barnes, Simo Veikkolainen, Keith Drage,
Peter Reissner, Tony Lindstrom, Stephen Kent (secdir review), Brian
Carpenter (genart review) and Mykyta Yevstifeyev (IANA
considerations). Special thanks go to Roberta Presta for her
invaluable contribution to this document. Roberta has worked on the
specification of the CCMP protocol at the University of Napoli for
the preparation of her Master thesis. She has also implemented the
CCMP prototype used for the trials and from which the dumps provided
in Section 6 have been extracted.
14. References
14.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
[RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
Leach, P., Luotonen, A., and L. Stewart, "HTTP
Barnes, et al. Expires February 4, 2012 [Page 109]
Internet-Draft CCMP August 2011
Authentication: Basic and Digest Access Authentication",
RFC 2617, June 1999.
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
[RFC6265] Barth, A., "HTTP State Management Mechanism", RFC 6265,
April 2011.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004.
[RFC5239] Barnes, M., Boulton, C., and O. Levin, "A Framework for
Centralized Conferencing", RFC 5239, June 2008.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246, August 2008.
[I-D.ietf-xcon-common-data-model]
Novo, O., Camarillo, G., Morgan, D., and J. Urpalainen,
"Conference Information Data Model for Centralized
Conferencing (XCON)", draft-ietf-xcon-common-data-model-31
(work in progress), June 2011.
[W3C.REC-xmlschema-1-20041028]
Thompson, H., Mendelsohn, N., Maloney, M., and D. Beech,
"XML Schema Part 1: Structures Second Edition", World Wide
Web Consortium Recommendation REC-xmlschema-1-20041028,
October 2004,
<http://www.w3.org/TR/2004/REC-xmlschema-1-20041028>.
[W3C.REC-xmlschema-2-20041028]
Malhotra, A. and P. Biron, "XML Schema Part 2: Datatypes
Second Edition", World Wide Web Consortium
Recommendation REC-xmlschema-2-20041028, October 2004,
<http://www.w3.org/TR/2004/REC-xmlschema-2-20041028>.
14.2. Informative References
[REST] Fielding, "Architectural Styles and the Design of Network-
based Software Architectures", 2000.
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
Types", RFC 3023, January 2001.
[RFC3261] 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.
Barnes, et al. Expires February 4, 2012 [Page 110]
Internet-Draft CCMP August 2011
[RFC3958] Daigle, L. and A. Newton, "Domain-Based Application
Service Location Using SRV RRs and the Dynamic Delegation
Discovery Service (DDDS)", RFC 3958, January 2005.
[RFC4582] Camarillo, G., Ott, J., and K. Drage, "The Binary Floor
Control Protocol (BFCP)", RFC 4582, November 2006.
[RFC4732] Handley, M., Rescorla, E., and IAB, "Internet Denial-of-
Service Considerations", RFC 4732, December 2006.
[RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", BCP 26, RFC 5226,
May 2008.
[I-D.ietf-xcon-event-package]
Camarillo, G., Srinivasan, S., Even, R., and J.
Urpalainen, "Conference Event Package Data Format
Extension for Centralized Conferencing (XCON)",
draft-ietf-xcon-event-package-01 (work in progress),
September 2008.
[W3C.REC-soap12-part1-20030624]
Hadley, M., Gudgin, M., Mendelsohn, N., Moreau, J., and H.
Nielsen, "SOAP Version 1.2 Part 1: Messaging Framework",
World Wide Web Consortium FirstEdition REC-soap12-part1-
20030624, June 2003,
<http://www.w3.org/TR/2003/REC-soap12-part1-20030624>.
[W3C.REC-soap12-part2-20030624]
Mendelsohn, N., Hadley, M., Moreau, J., Gudgin, M., and H.
Nielsen, "SOAP Version 1.2 Part 2: Adjuncts", World Wide
Web Consortium FirstEdition REC-soap12-part2-20030624,
June 2003,
<http://www.w3.org/TR/2003/REC-soap12-part2-20030624>.
Appendix A. Appendix A: Evaluation of other protocol models and
transports considered for CCMP
This section provides some background as to the selection of HTTP as
the transport for the CCMP requests/responses. In addition to HTTP,
the operations on the objects can be implemented in at least two
different ways, namely as remote procedure calls - using SOAP as
described in Appendix A.1 and by defining resources following a
RESTful architecture Appendix A.2.
In both the SOAP and RESTFUL approaches, servers will have to
recreate their internal state representation of the object with each
Barnes, et al. Expires February 4, 2012 [Page 111]
Internet-Draft CCMP August 2011
update request, checking parameters and triggering function
invocations. In the SOAP approach, it would be possible to describe
a separate operation for each atomic element, but that would greatly
increase the complexity of the protocol. A coarser-grained approach
to the CCMP does require that the server process XML elements in
updates that have not changed and that there can be multiple changes
in one update. For CCMP, the resource (REST) model might appear more
attractive, since the conference operations fit the CRUD approach.
However, neither of these approaches were considered ideal. SOAP was
considered to bring additional overhead. It is quite awkward to
apply a RESTful approach since the CCMP requires a more complex
request/response protocol in order to maintain the data both in the
server and at the client. This doesn't map very elegantly to the
basic request/response model, whereby a response typically indicates
whether the request was successful or not, rather than providing
additional data to maintain the synchronization between the client
and server data. In addition, the CCMP clients may also receive the
data in Notifications. While the notification method or protocol
used by some conferencing clients can be independent of the CCMP, the
same data in the server is used for both the CCMP and Notifications -
this requires a server application above the transport layer (e.g.,
HTTP) for maintaining the data, which in the CCMP model is
transparent to the transport protocol.
Thus, the solution for the CCMP defined in this document is viewed as
a good compromise amongst the most notable past candidates and is
referred to as "HTTP single-verb transport plus CCMP body". With
this approach, CCMP is able to take advantage of existing HTTP
functionality. As with SOAP, the CCMP uses a "single HTTP verb" for
transport (i.e. a single transaction type for each request/response
pair); this allows decoupling CCMP messages from HTTP messages.
Similarly, as with any RESTful approach, CCMP messages are inserted
directly in the body of HTTP messages, thus avoiding any unnecessary
processing and communication burden associated with further
intermediaries. With this approach, no modification to the CCMP
messages/operations is required to use a different transport
protocol.
A.1. Using SOAP for the CCMP
A remote procedure call (RPC) mechanism for the CCMP could use SOAP
(Simple Object Access Protocol[W3C.REC-soap12-part1-20030624][W3C.REC
-soap12-part2-20030624]), where conferences and the other objects are
modeled as services with associated operations. Conferences and
other objects are selected by their own local identifiers, such as
email-like names for users. This approach has the advantage that it
can easily define atomic operations that have well-defined error
Barnes, et al. Expires February 4, 2012 [Page 112]
Internet-Draft CCMP August 2011
conditions.
All SOAP operations would use a single HTTP verb. While the RESTful
approach requires the use of a URI for each object, SOAP can use any
token.
A.2. A RESTful approach for the CCMP
Conference objects can also be modeled as resources identified by
URIs, with the basic CRUD operations mapped to the HTTP methods POST/
PUT for creating objects, GET for reading objects, PATCH/POST/PUT for
changing objects and DELETE for deleting them. Many of the objects,
such as conferences, already have natural URIs.
CCMP can be mapped into the CRUD (Create, Read, Update, Delete)
design pattern. The basic CRUD operations are used to manipulate
conference objects, which are XML documents containing the
information characterizing a specified conference instance, be it an
active conference or a conference blueprint used by the conference
server to create new conference instances through a simple clone
operation.
Following the CRUD approach, CCMP could use a general-purpose
protocol such as HTTP [RFC2616] to transfer domain-specific XML-
encoded data objects defined in the Conference Information Data Model
for Centralized Conferencing [I-D.ietf-xcon-common-data-model].
Following on the CRUD approach, CCMP could follow the well-known REST
(REpresentational State Transfer) architectural style [REST]. The
CCMP could map onto the REST philosophy, by specifying resource URIs,
resource formats, methods supported at each URI and status codes that
have to be returned when a certain method is invoked on a specific
URI. A REST-style approach must ensure sure that all operations can
be mapped to HTTP operations.
The following summarizes the specific HTTP method that could be used
for each of the CCMP Requests:
Retrieve: HTTP GET could be used on XCON-URIs, so that clients can
obtain data about conference objects in the form of XML data model
documents.
Create: HTTP PUT could be used to create a new object as identified
by the XCON-URI or XCON-USERID.
Change: Either HTTP PATCH or HTTP POST could be used to change the
conference object identified by the XCON-URI.
Barnes, et al. Expires February 4, 2012 [Page 113]
Internet-Draft CCMP August 2011
Delete: HTTP DELETE could be used to delete conference objects and
parameters within conference objects identified by the XCON-URI.
Authors' Addresses
Mary Barnes
Polycom
TX
USA
Email: mary.ietf.barnes@gmail.com
Chris Boulton
NS-Technologies
Email: chris@ns-technologies.com
Simon Pietro Romano
University of Napoli
Via Claudio 21
Napoli 80125
Italy
Email: spromano@unina.it
Henning Schulzrinne
Columbia University
Department of Computer Science
450 Computer Science Building
New York, NY 10027
Email: hgs+xcon@cs.columbia.edu
Barnes, et al. Expires February 4, 2012 [Page 114]
