Network Working Group J. Reschke Internet-Draft S. Eissing Expires: April 6, 2002 greenbytes October 6, 2001 Including additional properties in WebDAV PROPFIND/allprop requests draft-reschke-webdav-allprop-include-00 Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. 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 April 6, 2002. Copyright Notice Copyright (C) The Internet Society (2001). All Rights Reserved. Abstract Recent specifications extending the Web Distributed Authoring Protocol (WebDAV) restrict the set of properties returned automatically upon a PROPFIND/allprop request. This specification defines a method to add specific properties to the set of properties returned upon PROPFIND/allprop. Distribution of this document is unlimited. Please send comments to the Distributed Authoring and Versioning (WebDAV) working group at w3c-dist-auth@w3.org[1], which may be joined by sending a message with subject "subscribe" to w3c-dist-auth-request@w3.org[2]. Reschke & Eissing Expires April 6, 2002 [Page 1] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 Discussions of the WEBDAV working group are archived at URL: http:// lists.w3.org/Archives/Public/w3c-dist-auth/. Table of Contents 1. Notational Conventions . . . . . . . . . . . . . . . . . . . . 3 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. Extensions to PROPFIND/allprop . . . . . . . . . . . . . . . . 5 3.1 Example for PROPFIND/allprop/include with extended server . . 5 3.2 Example for PROPFIND/allprop/include with non-extended server 7 4. Changes to WebDAV DTD . . . . . . . . . . . . . . . . . . . . 9 5. Compatibility Considerations . . . . . . . . . . . . . . . . . 10 6. Internationalization Considerations . . . . . . . . . . . . . 11 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 8. Copyright . . . . . . . . . . . . . . . . . . . . . . . . . . 13 9. Intellectual Property . . . . . . . . . . . . . . . . . . . . 14 References . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 15 Full Copyright Statement . . . . . . . . . . . . . . . . . . . 16 Reschke & Eissing Expires April 6, 2002 [Page 2] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 1. Notational Conventions 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]. Reschke & Eissing Expires April 6, 2002 [Page 3] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 2. Introduction Recent specifications extending the "Web Distributed Authoring Protocol" (WebDAV, [RFC2518]) like "Versioning Extensions to WebDAV" [deltaV] and "WebDAV Access Control Protocol" [ACL] restrict the set of properties returned automatically upon a PROPFIND/allprop request in order to avoid the expensive computation of properties that the client in many cases isn't interested in. However, this change from the behaviour defined in WebDAV can lead to situations where clients need to perform two requests to retrieve all properties they are interested in (one using PROPFIND/allprop, then PROPFIND/prop enumerating the new properties that weren't reported upon the first request). This specification defines a backward- compatible extension to add specific properties to the set of properties returned upon PROPFIND/allprop, thus saving at least one PROPFIND request. Reschke & Eissing Expires April 6, 2002 [Page 4] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 3. Extensions to PROPFIND/allprop The "allprop" version of PROPFIND is extended to take an optional element (with namespace-URI "DAV:"). When present, it contains a set of property names that shall be reported in addition to those properties that the server usually would return upon PROPFIND/allprop. 3.1 Example for PROPFIND/allprop/include with extended server >>Request PROPFIND /container/front.html HTTP/1.1 Host: www.foo.bar Depth: 1 Content-Type: text/xml Content-Length: xxxx >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxx http://www.foo.bar/container/front.html Box type B 1997-12-01T18:27:21-08:00 Example HTML resource 4525 text/html zzyzx Monday, 12-Jan-98 09:25:56 GMT Reschke & Eissing Expires April 6, 2002 [Page 5] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 http://www.foo.bar/versions/container/front.html-1 HTTP/1.1 200 OK HTTP/1.1 404 NOT FOUND In this example, the server has recognized the extension element and included the DAV: properties and (as defined in [deltaV]). Reschke & Eissing Expires April 6, 2002 [Page 6] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 3.2 Example for PROPFIND/allprop/include with non-extended server >>Request PROPFIND /container/front.html HTTP/1.1 Host: www.foo.bar Depth: 1 Content-Type: text/xml Content-Length: xxxx >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxx http://www.foo.bar/container/front.html Box type B 1997-12-01T18:27:21-08:00 Example HTML resource 4525 text/html zzyzx Monday, 12-Jan-98 09:25:56 GMT Reschke & Eissing Expires April 6, 2002 [Page 7] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 HTTP/1.1 200 OK In this case the element was simply ignored. The client can detect this situation by checking for the presence of the requested properties and will have to issue an additional PROPFIND/ prop request (to retrieve the missing properties). Reschke & Eissing Expires April 6, 2002 [Page 8] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 4. Changes to WebDAV DTD Note that the WebDAV DTD is informal only and cannot be used to validate request or response bodies (due to the inability to properly work with XML namespaces). Reschke & Eissing Expires April 6, 2002 [Page 9] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 5. Compatibility Considerations This specification introduces a new child element for the element, defined in Section 4. Old servers will ignore this element (see [RFC2518], chapter 14). Clients can detect this situation as outlined in Section 3.2. Clients not aware of this specification will not be affected at all, because they will never use the new element in PROPFIND requests. Reschke & Eissing Expires April 6, 2002 [Page 10] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 6. Internationalization Considerations This proposal builds on [RFC2518], and inherits its internationalizability. Reschke & Eissing Expires April 6, 2002 [Page 11] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 7. IANA Considerations This proposal does not introduce any new IANA considerations, since it does not specify any new namespaces (in the general sense), but merely uses existing ones. Reschke & Eissing Expires April 6, 2002 [Page 12] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 8. Copyright To be supplied by the RFC Editor. Reschke & Eissing Expires April 6, 2002 [Page 13] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 9. Intellectual Property To be supplied by the RFC Editor. Reschke & Eissing Expires April 6, 2002 [Page 14] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S. and D. Jensen, "HTTP Extensions for Distributed Authoring -- WEBDAV", RFC 2518, February 1999. [deltaV] Clemm, G., Amsden, J., Ellison, T., Kaler, C. and J. Whitehead, "Versioning Extensions to WebDAV", ID draft- ietf-deltav-versioning-18, September 2001, . [ACL] Clemm, G., Hopkins, A., Sedlar, E. and J. Whitehead, "WebDAV Access Control Protocol", ID draft-ietf-webdav- acl-06, June 2001, . [1] [2] Authors' Addresses Julian F. Reschke greenbytes GmbH Salzmannstrasse 152 Muenster, NW 48159 Germany EMail: julian.reschke@greenbytes.de Stefan Eissing greenbytes GmbH Salzmannstrasse 152 Muenster, NW 48159 Germany EMail: stefan.eissing@greenbytes.de Reschke & Eissing Expires April 6, 2002 [Page 15] Internet-Draft WebDAV PROPFIND/allprop/include October 2001 Full Copyright Statement Copyright (C) The Internet Society (2001). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS 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. Acknowledgement Funding for the RFC Editor function is currently provided by the Internet Society. Reschke & Eissing Expires April 6, 2002 [Page 16]