Network Working GroupA. Brown
Internet-DraftG. Clemm
Intended status: InformationalIBM
Expires: July 26, 2010J. Reschke, Editor
greenbytes
January 22, 2010

Link RelationTypes for Simple Version Navigation I between Web Resources

Abstract

 I This specification defines Atom link relations for navigation between a resource and its versions.This specification defines a set of link relation types that may be used on Web resources for navigation between a resource and and other resources related to version control, such as past versions and working copies.

Status of this Memo

This Internet-Draft is submitted to IETF in full conformance with the provisions of BCP 78 and BCP 79.

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 July 26, 2010.

Copyright Notice

Copyright (c) 2010 IETF Trust and the persons identified as the document authors. All rights reserved.

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 BSD License.

Editorial Note (To be removed by RFC Editor before publication)

Please send comments to the Atom Syntax mailing list (<http://www.imc.org/atom-syntax/>).

Note that although discussion takes place on the Atompub working group's mailing list, this is not a working group document.

XML versions, latest edits and the issues list for this document are available from <http://greenbytes.de/tech/webdav/#draft-brown-versioning-link-relations>.


 I  edit   (type: edit, status: closed)
julian.reschke@greenbytes.de2009-11-19 Umbrella issue for editorial fixes/enhancements.
Associated changes in this document: 7.2, 7.2, B.
 I  terseness   (type: edit, status: closed)
lars.eggert@nokia.com2010-01-19 I'd be good to mention ATOM somewhere in the title. Also, both the abstract and the introduction are extremely terse, to the point where it's hard to understand what technologies/protocols this applies to.
2010-01-22Resolution: Done.
Associated changes in this document: <#rfc.change.terseness.1>, <#rfc.change.terseness.2>, 1.

1. Introduction

 I This specification defines link relations that may be used on a resource that exists in a system that supports versioning to navigate among the different resources available, such as past versions.This specification defines a set ot link relation types that may be used on Web resources that exist in a system that supports versioning to navigate among the different resources available, such as past versions and working copies.

These link relations are used in the AtomPub ([RFC5023]) bindings of the "Content Management Interoperability Services" (CMIS). See Section 3.4.3.1 of [CMIS] for further information.

2. Terminology

Versioned Resource

Version History

Predecessor, Successor

Working Copy

Checkout

Checkin

3. Link Relations

The following link relations are defined:

3.1. version-history

When included on a versioned resource, this link points to a resource containing the version history for this resource.

3.2. latest-version

When included on a versioned resource, this link points to a resource containing the latest (e.g., current) version.

The latest version is defined by the system. For linear versioning systems, this is probably the latest version by timestamp. For systems that support branching, there will be multiple latest versions, one for each branch in the version history.

Some systems may allow multiple of these link relations.

3.3. working-copy

When included on a versioned resource, this link points to a working copy for this resource.

Some systems may allow multiple of these link relations.

3.4. working-copy-of

When included on a working copy, this link points to the versioned resource from which this working copy was obtained.

3.5. predecessor-version

When included on a versioned resource, this link points to a resource containing the predecessor version in the version history.

Some systems may allow multiple of these link relations in the case of a multiple branches merging.

3.6. successor-version

When included on a versioned resource, this link points to a resource containing the successor version in the version history.

Some systems may allow multiple of these link relations in order to support branching.

4. IANA Considerations

The link relations below are to be registered by IANA per Section 7.1 of [RFC4287]:

5. Security Considerations

Automated agents should take care when these relations cross administrative domains (e.g., the URI has a different authority than the current document). Such agents should also take care to detect circular references.

Care should be applied when versioned resources are subject to differing access policies. In this case, exposing links may leak information even if the linked resource itself is properly secured. In particular, the syntax of the link URI/IRI could expose sensitive information (see Section 16.2 of [RFC3253] for a similar consideration in WebDAV Versioning). Note that this applies to exposing link metadata in general, not only to links related to versioning.

6. Acknowledgments

Thanks to the members of Content Management Interoperability Services (CMIS) Technical Committee (TC) at OASIS for the initial proposal, and to Jan Algermissen for feedback during IETF review.

7. References

7.1. Normative References

[RFC4287]
Nottingham, M. and R. Sayre, “The Atom Syndication Format”, RFC 4287, December 2005.

7.2. Informative References

[CMIS]
Brown, A., Gur-Esh, E., McVeigh, R., and F. Muller, “Content Management Interoperability Services (CMIS) Version 1.0”, OASIS CMIS v1.0 Committee Draft 04, September 2009, <http://docs.oasis-open.org/cmis/CMIS/v1.0/cd04/cmis-spec-v1.0.html>.
[CMIS]
Brown, A., Gur-Esh, E., McVeigh, R., and F. Muller, “Content Management Interoperability Services (CMIS) Version 1.0”, OASIS CMIS v1.0 Committee Draft 04, September 2009, <http://docs.oasis-open.org/cmis/CMIS/v1.0/cd04/cmis-spec-v1.0.html>.
Latest version available at <http://docs.oasis-open.org/cmis/CMIS/v1.0/cmis-spec-v1.0.html>
Nottingham, M., “Web Linking”, Internet-Draft draft-nottingham-http-link-header-06 (work in progress), July 2009.
Nottingham, M., “Web Linking”, Internet-Draft draft-nottingham-http-link-header-07 (work in progress), January 2010.
[JSR-283]
Day Software, Nuescheler, D., and P. Piegaze, “Content Repository API for Java(tm) Technology Specification”, Java Specification Request 283, August 2009, <http://www.day.com/specs/jcr/2.0/>.
[RFC3253]
Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J. Whitehead, “Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)”, RFC 3253, March 2002.
[RFC5023]
Gregorio, J. and B. de hOra, “The Atom Publishing Protocol”, RFC 5023, October 2007.

Appendix A. Relationship to Java Content Repository (JCR) and WebDAV

The link relations defined in Section 3 correspond to various properties used in WebDAV Versioning [RFC3253] and JCR [JSR-283]:

version-history

latest-version

working-copy

working-copy-of

predecessor-version

successor-version

Appendix B. Change Log (to be removed by RFC Editor before publication)

Authors' Addresses

Al Brown
IBM
3565 Harbor Blvd
Costa Mesa, California 92626
USA
EMail: albertcbrown@us.ibm.com
Geoffrey Clemm
IBM
20 Maguire Road
Lexington, MA 02421
USA
EMail: geoffrey.clemm@us.ibm.com
Julian F. Reschke (editor)
greenbytes GmbH
Hafenweg 16
Muenster, NW 48155
Germany
EMail: julian.reschke@greenbytes.de
URI: http://greenbytes.de/tech/webdav/