Network Working Group | C. Daboo |
Internet-Draft | Apple, Inc. |
Intended status: Standards Track | A. Quillaud |
Expires: September 9, 2010 | Sun Microsystems |
March 8, 2010 |
This specification defines an extension to WebDAV that allows efficient synchronization of the contents of a WebDAV collection.¶
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 September 9, 2010.¶
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.¶
This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English.¶
Please send comments to the Distributed Authoring and Versioning (WebDAV) working group at <mailto:w3c-dist-auth@w3.org>, which may be joined by sending a message with subject "subscribe" to <mailto:w3c-dist-auth-request@w3.org>. Discussions of the WEBDAV working group are archived at <http://lists.w3.org/Archives/Public/w3c-dist-auth/>.¶
WebDAV [RFC4918] defines the concept of 'collections' which are hierarchical groupings of WebDAV resources on an HTTP [RFC2616] server. Collections can be of arbitrary size and depth (i.e., collections within collections). WebDAV clients that cache resource content need a way to synchronize that data with the server (i.e., detect what has changed and update their cache). This can currently be done using a WebDAV PROPFIND request on a collection to list all members of a collection along with their DAV:getetag property values, which allows the client to determine which resources were changed, added or deleted. However, this does not scale well to large collections as the XML response to the PROPFIND request will grow with the collection size.¶
This specification defines a new WebDAV report that results in the server returning to the client only information about those resources which have changed, are new or were deleted since a previous execution of the report on the collection.¶
Additionally, a new property is added to collection resources that is used to convey a "synchronization token" that is guaranteed to change when resources within the collection have changed.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].¶
This document uses XML DTD fragments ([W3C.REC-xml-20081126], Section 3.2) as a purely notational convention. WebDAV request and response bodies cannot be validated by a DTD due to the specific extensibility rules defined in Section 17 of [RFC4918] and due to the fact that all XML elements defined by this specification use the XML namespace name "DAV:". In particular: ¶
When an XML element type in the "DAV:" namespace is referenced in this document outside of the context of an XML fragment, the string "DAV:" will be prefixed to the element type.¶
One way to synchronize data between two entities is to use some form of synchronization token. The token defines the state of the data being synchronized at a particular point in time. It can then be used to determine what has changed since one point in time and another.¶
This specification defines a new WebDAV report that is used to enable client-server collection synchronization based on such a token.¶
In order to synchronize the contents of a collection between a server and client, the server provides the client with a synchronization token each time the synchronization report is executed. That token represents the state of the data being synchronized at that point in time. The client can then present that same token back to the server at some later time and the server will return only those items that are new, have changed or were deleted since that token was generated. The server also returns a new token representing the new state at the time the report was run.¶
Typically the first time a client connects to the server it will need to be informed of the entire state of the collection (i.e., a full list of all resources that are currently contained in the collection). That is done by the client sending an empty token value to the server. This indicates to the server that a full listing is required.¶
As an alternative, the client may choose to do its first synchronization using some other mechanism on the collection (e.g. some other form of batch resource information retrieval such as PROPFIND, SEARCH [RFC5323], or specialized REPORTs such as those defined in CalDAV [RFC4791] and CardDAV [I-D.ietf-vcarddav-carddav]) and ask for the DAV:sync-token property to be returned. This property (defined in Section 4) contains the same token that can be used later on to issue a DAV:sync-collection report.¶
In some cases a server may only wish to maintain a limited amount of history about changes to a collection. In that situation it will return an error to the client when the client presents a token that is "out of date". At that point the client has to fall back to synchronizing the entire collection by re-running the report request using an empty token value.¶
This specification defines the DAV:sync-collection report.¶
If this report is implemented by a WebDAV server, then the server MUST list the report in the "DAV:supported-report-set" property on any collection supporting synchronization.¶
To implement the behavior for this report a server needs to keep track of changes to any resources in a collection. This includes noting the addition of new resources, changes to existing resources and removal of resources. Only internal members of the collection (as defined in Section 3 of [RFC4918]) are to be considered. The server will track each change and provide a synchronization "token" to the client that describes the state of the server at a specific point in time. This "token" is returned as part of the response to the "sync-collection" report. Clients include the last token they got from the server in the next "sync-collection" report that they execute and the server provides the changes from the previous state, represented by the token, to the current state, represented by the new token returned.¶
The synchronization token itself is an "opaque" string - i.e., the actual string data has no specific meaning or syntax. A simple implementation of such a token would be a numeric counter that counts each change as it occurs and relates that change to the specific object that changed.¶
Marshalling: ¶
Preconditions: ¶
Postconditions: ¶
When the DAV:sync-collection request does not contain a sync-token, the server MUST return all internal members of the collection and it MUST NOT return any removed resource.¶
When the DAV:sync-collection request contains a valid sync-token, two types of resource state changes can be returned (changed or removed). This section defines what triggers each of these to be returned. It also clarifies the case where a resource may have undergone multiple changes in between two synchronizations.¶
A resource MUST be reported as changed if it has been mapped directly under the target collection since the request sync token was generated. This includes resources that have been mapped as the result of a COPY, MOVE or BIND ([I-D.ietf-webdav-bind]) operation. This also includes collection resources that have been created.¶
In the case where a mapping between a resource and the target collection was removed, then a new mapping with the same URI created, the new resource MUST be reported as changed while the old resource MUST NOT be reported as removed. For example, if a resource was deleted, then recreated using the same URI, it should be reported as a changed resource only.¶
A resource MUST be reported as changed if its entity tag value (defined in Section 3.11 of [RFC2616]) has changed since the request sync token was generated.¶
A resource MAY be reported as changed if the user issuing the request was granted access to this resource, due to access control changes.¶
Collection resources MUST NOT be returned as changed, except in the case stated above. Instead clients are expected to synchronize changes in child collection resources on an individual basis.¶
A resource MUST be reported as removed if its mapping under the target collection has been removed since the request sync token was generated, and it has not been re-mapped since it was removed. This includes resources that have been unmapped as the result of a MOVE or UNBIND ([I-D.ietf-webdav-bind]) operation. This also includes collection resources that have been removed.¶
If a resource was created (and possibly modified), then removed in between two synchronizations, it MUST be reported as removed.¶
A resource MAY be reported as removed if the user issuing the request no longer has access to this resource, due to access control changes.¶
A server MAY limit the number of resources in a response, for example, to limit the amount of work expended in processing a request, or as the result of an explicit limit set by the client. If the result set is truncated, the response MUST use status code 207, return a DAV:multistatus response body, and indicate a status of 507 (Insufficient Storage) for the request URI. That DAV:response element SHOULD include a DAV:error element with the DAV:number-of-matches-within-limits precondition, as defined in [RFC3744] (Section 9.2). DAV:response elements for all the changes being reported are also included.¶
When truncation occurs, the DAV:sync-token value returned in the response MUST represent the correct state for the partial set of changes returned. That allows the client to use the returned DAV:sync-token to fetch the next set of changes. In this way the client can effectively "page" through the entire set of changes in a consistent manner.¶
Clients MUST handle the 507 status on the request-URI in the response to the report.¶
For example, consider a server that records changes using a monotonically increasing integer to represent a "revision number" and uses that quantity as the DAV:sync-token value. Assume the last DAV:sync-token used by the client was "10", and since then 20 additional changes have occurred. If the client executes a DAV:sync-collection request with a DAV:sync-token of "10", without a limit the server would return 20 DAV:response elements and a DAV:sync-token with value "30". But if the server choose to limit responses to at most 10 changes, then it would return only 10 DAV:response elements and a DAV:sync-token with value "20", together with an addition DAV:response element for the request-URI with a status code of 507. Subsequently, the client can re-issue the request with the DAV:sync-token value returned from the server and fetch the remaining 10 changes.¶
A client can limit the number of results returned by the server through use of the DAV:limit element ([RFC5323], Section 5.17) in the request body. This is useful when clients have limited space or bandwidth for the results. If a server is unable to truncate the result at or below the requested number, then it MUST fail the request with a DAV:number-of-matches-within-limits post-condition error. When the results can be correctly limited by the server, the server MUST follow the rules above for indicating a result set truncation to the client.¶
In this example, the client is making its first synchronization request to the server, so the DAV:sync-token element in the request is empty. It also asks for the DAV:getetag property and for a proprietary property. The server responds with the items currently in the targeted collection. The current synchronization token is also returned.¶
>> Request <<
REPORT /home/cyrusdaboo/ HTTP/1.1 Host: webdav.example.com Depth: 1 Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:sync-collection xmlns:D="DAV:"> <D:sync-token/> <D:prop xmlns:R="urn:ns.example.com:boxschema"> <D:getetag/> <R:bigbox/> </D:prop> </D:sync-collection>
>> Response <<
HTTP/1.1 207 Multi-Status Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:multistatus xmlns:D="DAV:"> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/test.doc</D:href> <D:propstat> <D:prop> <D:getetag>"00001-abcd1"</D:getetag> <R:bigbox xmlns:R="urn:ns.example.com:boxschema"> <R:BoxType>Box type A</R:BoxType> </R:bigbox> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> </D:response> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/vcard.vcf</D:href> <D:propstat> <D:prop> <D:getetag>"00002-abcd1"</D:getetag> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> <D:propstat> <D:prop> <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/> </D:prop> <D:status>HTTP/1.1 404 Not Found</D:status> </D:propstat> </D:response> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/calendar.ics</D:href> <D:propstat> <D:prop> <D:getetag>"00003-abcd1"</D:getetag> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> <D:propstat> <D:prop> <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/> </D:prop> <D:status>HTTP/1.1 404 Not Found</D:status> </D:propstat> </D:response> <D:sync-token>1234</D:sync-token> </D:multistatus>
In this example, the client is making a synchronization request to the server and is using the DAV:sync-token element returned from the last report it ran on this collection. The server responds, listing the items that have been added, changed or removed. The (new) current synchronization token is also returned.¶
>> Request <<
REPORT /home/cyrusdaboo/ HTTP/1.1 Host: webdav.example.com Depth: 1 Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:sync-collection xmlns:D="DAV:"> <D:sync-token>1234</D:sync-token> <D:prop xmlns:R="urn:ns.example.com:boxschema"> <D:getetag/> <R:bigbox/> </D:prop> </D:sync-collection>
>> Response <<
HTTP/1.1 207 Multi-Status Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:multistatus xmlns:D="DAV:"> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/file.xml</D:href> <D:propstat> <D:prop> <D:getetag>"00004-abcd1"</D:getetag> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> <D:propstat> <D:prop> <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/> </D:prop> <D:status>HTTP/1.1 404 Not Found</D:status> </D:propstat> </D:response> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/vcard.vcf</D:href> <D:propstat> <D:prop> <D:getetag>"00002-abcd2"</D:getetag> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> <D:propstat> <D:prop> <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/> </D:prop> <D:status>HTTP/1.1 404 Not Found</D:status> </D:propstat> </D:response> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/test.doc</D:href> <D:status>HTTP/1.1 404 Not Found</D:status> </D:response> <D:sync-token>1238</D:sync-token> </D:multistatus>
In this example, the client is making its first synchronization request to the server, so the DAV:sync-token element in the request is empty. It also asks for the DAV:getetag property. The server responds with the items currently in the targeted collection, but truncated at two items. The synchronization token for the truncated result set is returned.¶
>> Request <<
REPORT /home/cyrusdaboo/ HTTP/1.1 Host: webdav.example.com Depth: 1 Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:sync-collection xmlns:D="DAV:"> <D:sync-token/> <D:prop> <D:getetag/> </D:prop> </D:sync-collection>
>> Response <<
HTTP/1.1 207 Multi-Status Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:multistatus xmlns:D="DAV:"> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/test.doc</D:href> <D:propstat> <D:prop> <D:getetag>"00001-abcd1"</D:getetag> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> </D:response> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/vcard.vcf</D:href> <D:propstat> <D:prop> <D:getetag>"00002-abcd1"</D:getetag> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> </D:response> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/</D:href> <D:status>HTTP/1.1 507 Insufficient Storage</D:status> </D:response> <D:sync-token>1233</D:sync-token> </D:multistatus>
In this example, the client is making its first synchronization request to the server, so the DAV:sync-token element in the request is empty. It requests a limit of 1 for the responses returned by the server. It also asks for the DAV:getetag property. The server responds with the items currently in the targeted collection, but truncated at one item. The synchronization token for the truncated result set is returned.¶
>> Request <<
REPORT /home/cyrusdaboo/ HTTP/1.1 Host: webdav.example.com Depth: 1 Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:sync-collection xmlns:D="DAV:"> <D:sync-token/> <D:limit> <D:nresults>1</D:nresults> </D:limit> <D:prop> <D:getetag/> </D:prop> </D:sync-collection>
>> Response <<
HTTP/1.1 207 Multi-Status Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:multistatus xmlns:D="DAV:"> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/test.doc</D:href> <D:propstat> <D:prop> <D:getetag>"00001-abcd1"</D:getetag> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> </D:response> <D:response> <D:href >http://webdav.example.com/home/cyrusdaboo/</D:href> <D:status>HTTP/1.1 507 Insufficient Storage</D:status> </D:response> <D:sync-token>1232</D:sync-token> </D:multistatus>
In this example, the client is making a synchronization request to the server with a valid DAV:sync-token element value. It requests a limit of 100 for the responses returned by the server. It also asks for the DAV:getetag property. The server is unable to limit the results to the maximum specified by the client, so it responds with a 507 status code and appropriate post-condition error code.¶
>> Request <<
REPORT /home/cyrusdaboo/ HTTP/1.1 Host: webdav.example.com Depth: 1 Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:sync-collection xmlns:D="DAV:"> <D:sync-token>1232</D:sync-token> <D:limit> <D:nresults>100</D:nresults> </D:limit> <D:prop> <D:getetag/> </D:prop> </D:sync-collection>
>> Response <<
HTTP/1.1 507 Insufficient Storage Content-Type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:error xmlns:D="DAV:"> <D:number-of-matches-within-limits/> </D:error>
<!ELEMENT sync-token #PCDATA>
<!ELEMENT sync-collection (sync-token, DAV:limit?, DAV:prop)> <!-- DAV:limit defined in RFC 5323, Section 5.17 --> <!-- DAV:prop defined in RFC 4918, Section 14.18 -->
<!ELEMENT sync-token CDATA>
<!ELEMENT multistatus (DAV:response*, DAV:responsedescription?, sync-token?) > <!-- DAV:multistatus originally defined in RFC 4918, Section 14.16 but overridden here to add the DAV:sync-token element --> <!-- DAV:response defined in RFC 4918, Section 14.24 --> <!-- DAV:responsedescription defined in RFC 4918, Section 14.25 -->
This extension does not introduce any new security concerns than those already described in HTTP and WebDAV.¶
This document does not require any actions on the part of IANA.¶
The following individuals contributed their ideas and support for writing this specification: Bernard Desruisseaux, Mike Douglass, Ciny Joy, Andrew McMillan, Julian Reschke, and Wilfredo Sanchez. We would like to thank the Calendaring and Scheduling Consortium for facilitating interoperability testing for early implementations of this specification.¶
Changes in -03: ¶
Changes in -02: ¶
Changes in -01: ¶