SIMPLE H. Schulzrinne
Internet-Draft Columbia U.
Expires: November 13, 2004 May 15, 2004
CIPID: Contact Information in Presence Information Data Format
draft-ietf-simple-cipid-02
Status of this Memo
By submitting this Internet-Draft, I certify that any applicable
patent or other IPR claims of which I am aware have been disclosed,
and any of which I become aware will be disclosed, in accordance with
RFC 3668.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that other
groups may also distribute working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at http://
www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html.
This Internet-Draft will expire on November 13, 2004.
Copyright Notice
Copyright (C) The Internet Society (2004). All Rights Reserved.
Abstract
The Presence Information Data Format (PIDF) defines a basic XML
format for presenting presence information for a presentity. The
Contact Information for Presence Information Data Format (CIPID) is
an extension that adds elements to PIDF that provide additional
contact information about a presentity and its contacts, including
references to address book entries and icons.
Schulzrinne Expires November 13, 2004 [Page 1]
Internet-Draft CIPID May 2004
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology and Conventions . . . . . . . . . . . . . . . . . 3
3. CIPID Elements . . . . . . . . . . . . . . . . . . . . . . . . 3
3.1 Card Element . . . . . . . . . . . . . . . . . . . . . . . 3
3.2 Homepage Element . . . . . . . . . . . . . . . . . . . . . 3
3.3 Icon Element . . . . . . . . . . . . . . . . . . . . . . . 4
3.4 Map Element . . . . . . . . . . . . . . . . . . . . . . . 4
3.5 Sound Element . . . . . . . . . . . . . . . . . . . . . . 4
4. Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
5. The XML Schema Definition . . . . . . . . . . . . . . . . . . 5
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
6.1 URN Sub-Namespace Registration for
'urn:ietf:params:xml:ns:pidf:cipid' . . . . . . . . . . . 6
6.2 Schema Registration for Schema
urn:ietf:params:xml:ns:pidf:cipid' . . . . . . . . . . . . 7
7. Security Considerations . . . . . . . . . . . . . . . . . . . 7
8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 7
8.1 Normative References . . . . . . . . . . . . . . . . . . . . 7
8.2 Informative References . . . . . . . . . . . . . . . . . . . 8
Author's Address . . . . . . . . . . . . . . . . . . . . . . . 8
A. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 8
Intellectual Property and Copyright Statements . . . . . . . . 9
Schulzrinne Expires November 13, 2004 [Page 2]
Internet-Draft CIPID May 2004
1. Introduction
In its function of facilitating communication, the usefulness of
presence information can be enhanced by providing basic information
about a presentity or contact. This specification describes a basic
set of information elements that allow a watcher to retrieve
additional information about a presentity or contact.
This specification defines extensions to the PIDF [5] XML [6]
document format.
We describe elements for providing a "business card", references to
the homepage, map, representative sound and an icon. All elements
can be used either for the whole presence document, extending
<presence>, or for an individual tuple (or both).
This additional presence information can be used in PIDF [5]
documents, together with RPID [7], future-status [8] and other PIDF
extensions.
The namespace URI for these elements defined by this specification is
a URN [2], using the namespace identifier 'ietf' defined by [3] and
extended by [4]:
urn:ietf:params:xml:ns:pidf:cipid
All elements described in this document are optional and can be used
within the PIDF <presence> element.
2. Terminology and Conventions
The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT,
RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted
as described in BCP 14, RFC 2119 [1].
3. CIPID Elements
3.1 Card Element
The <card> element includes a URI pointing to a business card, e.g.,
in LDIF [10] or vCard [9] format.
3.2 Homepage Element
The <homepage> element provides a URI pointing to general information
about the tuple or presentity, typically a web home page.
Schulzrinne Expires November 13, 2004 [Page 3]
Internet-Draft CIPID May 2004
3.3 Icon Element
The <icon> element provides a URI pointing to an image (icon)
representing the tuple or presentity. The watcher MAY use this
information to represent the tuple or presentity in a graphical user
interface. Presentities SHOULD provide images of sizes and aspect
ratios that are appropriate for rendering as an icon. Support for
JPEG, PNG and GIF formats is RECOMMENDED.
3.4 Map Element
The <map> element provides a URI pointing to a map related to the
tuple or presentity. The watcher MAY use this information to
represent the tuple or presentity in a graphical user interface. The
map may be either an image, an HTML client-side image map or a
geographical information system (GIS) document, e.g., encoded as GML.
Support for images formatted as PNG and GIF is RECOMMENDED.
3.5 Sound Element
The <sound> element provides a URI pointing to a sound related to the
tuple or presentity. The watcher MAY use the sound object, such as a
MIDI or MP3 file, referenced by the URL to inform the watcher that
the presentity has assumed the status OPEN. Implementors are advised
to create user interfaces that provide the watcher with the
opportunity to choose whether to play such sounds.
4. Example
An example, combining RPID and CIPID, is shown below:
<?xml version="1.0" encoding="UTF-8"?>
<presence xmlns="urn:ietf:params:xml:ns:pidf"
xmlns:es="urn:ietf:params:xml:ns:pidf:status:rpid-status"
xmlns:et="urn:ietf:params:xml:ns:pidf:rpid-tuple"
xmlns:ci="urn:ietf:params:xml:ns:pidf:cipid"
entity="pres:someone@example.com">
<tuple id="b8xk">
<status>
<basic>closed</basic>
</status>
</tuple>
<tuple id="c8dqui">
<status>
Schulzrinne Expires November 13, 2004 [Page 4]
Internet-Draft CIPID May 2004
<basic>open</basic>
</status>
<et:class>assistant</et:class>
<ci:homepage>http://example.com/~secretary</ci:homepage>
<ci:icon>http://example.com/~secretary/icon.gif</ci:icon>
<ci:card>http://example.com/~secretary/card.vcd</ci:card>
<et:relationship>assistant</et:relationship>
<et:contact-type>presentity</et:contact-type>
<contact>sip:secretary@example.com</contact>
<note>My secretary</note>
</tuple>
<ci:card>http://example.com/~someone/card.vcd</ci:card>
<ci:homepage>http://example.com/~someone</ci:homepage>
<ci:icon>http://example.com/~someone/icon.gif</ci:icon>
<ci:map>http://example.com/~someone/gml-map.xml</ci:map>
<ci:sound>http://example.com/~someone/whoosh.wav</ci:sound>
</presence>
5. The XML Schema Definition
The schema is shown below.
Schulzrinne Expires November 13, 2004 [Page 5]
Internet-Draft CIPID May 2004
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="urn:ietf:params:xml:ns:pidf:cipid"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<!-- This import brings in the XML language attribute xml:lang-->
<xs:import namespace="http://www.w3.org/XML/1998/namespace"
schemaLocation="http://www.w3.org/2001/xml.xsd"/>
<xs:annotation>
<xs:documentation xml:lang="en">
Describes CIPID extensions for PIDF.
</xs:documentation>
</xs:annotation>
<xs:element name="card" type="xs:anyURI"/>
<xs:element name="homepage" type="xs:anyURI"/>
<xs:element name="icon" type="xs:anyURI"/>
<xs:element name="map" type="xs:anyURI"/>
<xs:element name="sound" type="xs:anyURI"/>
</xs:schema>
Figure 1: CIPID schema
6. IANA Considerations
This document calls for IANA to register a new XML namespace URN and
schema per [4].
6.1 URN Sub-Namespace Registration for
'urn:ietf:params:xml:ns:pidf:cipid'
URI: urn:ietf:params:xml:ns:pidf:cipid
Description: This is the XML namespace for XML elements defined by
RFCXXXX to describe contact information presence information
extensions for the status element in the PIDF presence document
format in the application/pidf+xml content type.
Registrant Contact: IETF, SIMPLE working group, simple@ietf.org;
Henning Schulzrinne, hgs@cs.columbia.edu
XML:
BEGIN
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN"
"http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">
Schulzrinne Expires November 13, 2004 [Page 6]
Internet-Draft CIPID May 2004
<html xmlns="http://www.w3.org/1999/xhtml
<head>
<meta http-equiv="content-type"
content="text/html;charset=iso-8859-1"/>
<title>CIPID -- Contact Information in Presence Information
Data Format</title>
</head>
<body>
<h1>Namespace for contact information presence extension (status)</h1>
<h2>urn:ietf:params:xml:ns:pidf:cipid</h2>
<p>See <a href="URL of published RFC">RFCXXXX</a>.</p>
</body>
</html>
END
6.2 Schema Registration for Schema urn:ietf:params:xml:ns:pidf:cipid'
URI: please assign
Registrant Contact: IESG
XML: See Figure 1
7. Security Considerations
The security issues are similar to those for RPID [7]. Watchers need
to restrict which types of content pointed to by <icon> elements they
render.
Also, accessing these URIs may in turn provide hints that the watcher
is currently using the presence application. Thus, a presence
application may want to cache these objects for later use.
8. References
8.1 Normative References
[1] Bradner, S., "Key words for use in RFCs to Indicate Requirement
Levels", BCP 14, RFC 2119, March 1997.
[2] Moats, R., "URN Syntax", RFC 2141, May 1997.
[3] Moats, R., "A URN Namespace for IETF Documents", RFC 2648,
August 1999.
[4] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January
2004.
Schulzrinne Expires November 13, 2004 [Page 7]
Internet-Draft CIPID May 2004
[5] Sugano, H. and S. Fujimoto, "Presence Information Data Format
(PIDF)", draft-ietf-impp-cpim-pidf-08 (work in progress), May
2003.
[6] Yergeau, F., Bray, T., Paoli, J., Sperberg-McQueen, C. and E.
Maler, "Extensible Markup Language (XML) 1.0 (Third Edition)",
W3C REC REC-xml-20040204, February 2004.
8.2 Informative References
[7] Schulzrinne, H., Gurbani, V., Kyzivat, P. and J. Rosenberg,
"RPID: Rich Presence: Extensions to the Presence Information
Data Format (PIDF)", draft-ietf-simple-rpid-03 (work in
progress), March 2004.
[8] Schulzrinne, H., "Timed Presence Extensions to the Presence
Information Data Format(PIDF) to Indicate Presence Information
for Past and Future Time Intervals",
draft-ietf-simple-future-01 (work in progress), April 2004.
[9] Dawson, F. and T. Howes, "vCard MIME Directory Profile", RFC
2426, September 1998.
[10] Good, G., "The LDAP Data Interchange Format (LDIF) - Technical
Specification", RFC 2849, June 2000.
Author's Address
Henning Schulzrinne
Columbia University
Department of Computer Science
450 Computer Science Building
New York, NY 10027
US
Phone: +1 212 939 7042
EMail: hgs+simple@cs.columbia.edu
URI: http://www.cs.columbia.edu
Appendix A. Acknowledgments
This document is based on the discussions within the IETF SIMPLE
working group. Vijay Gurbani, Hisham Khartabil, Paul Kyzivat, Eva
Leppanen, Mikko Lonnfors, Jon Peterson and Jonathan Rosenberg have
provided helpful comments.
Schulzrinne Expires November 13, 2004 [Page 8]
Internet-Draft CIPID May 2004
Intellectual Property Statement
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the IETF's procedures with respect to rights in IETF Documents can
be found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
Disclaimer of Validity
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Copyright Statement
Copyright (C) The Internet Society (2004). This document is subject
to the rights, licenses and restrictions contained in BCP 78, and
except as set forth therein, the authors retain all their rights.
Acknowledgment
Funding for the RFC Editor function is currently provided by the
Internet Society.
Schulzrinne Expires November 13, 2004 [Page 9]
