WEBDAV Working GroupJ. Reschke, Editor
Internet-DraftS. Eissing
Intended status: Informationalgreenbytes
Expires: July 2005January 2005

Including additional properties in WebDAV PROPFIND/allprop requests

draft-reschke-webdav-allprop-include-06

Status of this Memo

This document is an Internet-Draft and is subject to all provisions of section 3 of RFC 3667. By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she 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 in July 2005.

Copyright Notice

Copyright © The Internet Society (2005). 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.

 I ↓ 

Distribution of this document is unlimited. Please send comments to the Distributed Authoring and Versioning (WebDAV) working group at w3c-dist-auth@w3.org, which may be joined by sending a message with subject "subscribe" to w3c-dist-auth-request@w3.org.

Discussions of the WEBDAV working group are archived at URL: http://lists.w3.org/Archives/Public/w3c-dist-auth/.

↑ I ↓ 

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

Distribution of this document is unlimited. Please send comments to the 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/>.

XML and HTML versions of this draft are available from <http://greenbytes.de/tech/webdav/#draft-reschke-webdav-allprop-include>.

 I  edit   (type: edit, status: open)
julian.reschke@greenbytes.de2005-01-01 Umbrella issue for editorial fixes/enhancements.
Associated changes in this document: <#rfc.change.edit.1>, <#rfc.change.edit.2>, 2, 8.2, 8.2, A.

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].

2. Introduction

Recent specifications extending the "Web Distributed Authoring Protocol" (WebDAV, [RFC2518]) like "Versioning Extensions to WebDAV" [RFC3253] and "WebDAV Access Control Protocol" ↑ I ↓[ACL][RFC3744] 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.

This document defines an extension element that could ultimately become part of the core WebDAV protocol. Being just an individual submission, it currently defines it in the proprietary namespace

  http://sapportals.com/xmlns/cm/webdav

instead of the "DAV:" namespace. It uses a prefix of "in:" for referring to elements in this namespace. However, WebDAV server and clients are free to use any prefix, provided that there is a namespace declaration that binds the prefix to the URI of the same namespace.

3. Extensions to PROPFIND/allprop

The "allprop" version of PROPFIND is extended to take an optional in:include element. 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.example.org
Depth: 1
Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<propfind xmlns="DAV:"
  xmlns:in="http://sapportals.com/xmlns/cm/webdav">
  <allprop/>
  <in:include>
    <checked-in/>
    <checked-out/>
  </in:include>
</propfind>

>>Response

HTTP/1.1 207 Multi-Status
Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<multistatus xmlns="DAV:">
  <response>
    <href>http://www.example.org/container/front.html</href>
    <propstat>
      <prop>
        <R:bigbox xmlns:R="http://www.example.org/boxschema/">
          <R:BoxType>Box type B</R:BoxType>
        </R:bigbox>
        <creationdate>1997-12-01T18:27:21-08:00</creationdate>
        <displayname>Example HTML resource</displayname>
        <getcontentlength>4525</getcontentlength>
        <getcontenttype>text/html</getcontenttype>
        <getetag>zzyzx</getetag>
        <getlastmodified
        >Monday, 12-Jan-98 09:25:56 GMT</getlastmodified>
        <resourcetype/>
        <supportedlock>
          <lockentry>
            <lockscope><exclusive/></lockscope>
            <locktype><write/></locktype>
          </lockentry>
          <lockentry>
            <lockscope><shared/></lockscope>
            <locktype><write/></locktype>
          </lockentry>
        </supportedlock>
        <checked-in>
          <href
          >http://www.example.org/vsn/container/front.html-1</href>
        </checked-in>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
    <propstat>
      <prop>
        <checked-out/>
      </prop>
      <status>HTTP/1.1 404 NOT FOUND</status>
    </propstat>
  </response>
</multistatus>

In this example, the server has recognized the extension element in:include and included the properties DAV:checked-in and DAV:checked-out (as defined in [RFC3253]).

3.2. Example for PROPFIND/allprop/include with non-extended server

>>Request

PROPFIND  /container/front.html HTTP/1.1
Host: www.example.org
Depth: 1
Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<propfind xmlns="DAV:"
  xmlns:in="http://sapportals.com/xmlns/cm/webdav">
  <allprop/>
  <in:include>
    <checked-in/>
    <checked-out/>
  </in:include>
</propfind>

>>Response

HTTP/1.1 207 Multi-Status
Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<multistatus xmlns="DAV:">
  <response>
    <href>http://www.example.org/container/front.html</href>
    <propstat>
      <prop>
        <R:bigbox xmlns:R="http://www.example.org/boxschema/">
          <R:BoxType>Box type B</R:BoxType>
        </R:bigbox>
        <creationdate>1997-12-01T18:27:21-08:00</creationdate>
        <displayname>Example HTML resource</displayname>
        <getcontentlength>4525</getcontentlength>
        <getcontenttype>text/html</getcontenttype>
        <getetag>zzyzx</getetag>
        <getlastmodified
        >Monday, 12-Jan-98 09:25:56 GMT</getlastmodified>
        <resourcetype/>
        <supportedlock>
          <lockentry>
            <lockscope><exclusive/></lockscope>
            <locktype><write/></locktype>
          </lockentry>
          <lockentry>
            <lockscope><shared/></lockscope>
            <locktype><write/></locktype>
           </lockentry>
         </supportedlock>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
  </response>
</multistatus>

In this case the in:include 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).

4. Changes to WebDAV DTD

<!ELEMENT propfind ((allprop, in:include+) | propname | prop) >
<!ELEMENT in:include ANY >

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).

5. Compatibility Considerations

This specification introduces a new child element for the DAV:propfind 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 in:include element in PROPFIND requests.

6. Internationalization Considerations

This proposal builds on [RFC2518], and inherits its internationalizability.

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.

8. References

Appendix A. Alternate syntax proposal from interim WebDAV working group meeting

This section briefly describes an alternate approach to the problem covered by this draft. It was discussed during the interim WebDAV working group meeting in January 2003 and was supported by all meeting attendees. It was also added to the latest draft for the revision of [RFC2518], ↑ I [ID-RFC2518bis][draft-ietf-webdav-rfc2518bis-06].

A.1. PROPFIND/prop extension to include dead properties

Additional PROPFIND marshalling: 

  • <!ELEMENT propfind (allprop | propname | (prop, dead-props?)) >
<!ELEMENT dead-props EMPTY >

The DAV:dead-props element can be added to PROPFIND requests that retrieve named properties using DAV:prop. When present, the server MUST include all dead properties defined on the resource.

A.2. Example

This example shows the alternate syntax applied to the example from Section 3.1.

>>Request

PROPFIND  /container/front.html HTTP/1.1
Host: www.example.org
Depth: 1
Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<propfind xmlns="DAV:">
  <prop>
    <checked-in />
    <checked-out />  
  </prop>
  <dead-props />
</propfind>

>>Response

HTTP/1.1 207 Multi-Status
Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx

<?xml version="1.0" encoding="utf-8" ?>
<multistatus xmlns="DAV:">
  <response>
    <href>http://www.example.org/container/front.html</href>
    <propstat>
      <prop>
        <R:bigbox xmlns:R="http://www.example.org/boxschema/">
          <R:BoxType>Box type B</R:BoxType>
        </R:bigbox>
        <checked-in>
          <href
          >http://www.example.org/vsn/container/front.html-1</href>
        </checked-in>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
    <propstat>
      <prop>
        <checked-out/>
      </prop>
      <status>HTTP/1.1 404 NOT FOUND</status>
    </propstat>
  </response>
</multistatus>

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

B.1. Since 'draft-reschke-webdav-allprop-include-00'

Moved <include> element out of "DAV:" namespace.
Updated reference to deltaV (now RFC3253).
Changed examples to explicitly use utf-8 encoding for HTTP content type and XML encoding.
Updated WebDAV ACL reference to draft 07.
Made sure figures fit in 72 columns.
Split references into "Normative" and "Informative".

B.2. Since 'draft-reschke-webdav-allprop-include-01'

Updated WebDAV ACL reference to draft 09.

B.3. Since 'draft-reschke-webdav-allprop-include-02'

Fixed XML errors in examples (wrong closing href tags).
Replaced domain names in examples according to RFC2606: "www.foo.bar" by "www.example.org".
Shortened checked-in URI to fit into 72 characters in example.

B.4. Since 'draft-reschke-webdav-allprop-include-03'

Added short description of alternate syntax discussed during interim WebDAV WG meeting (January 2003).

B.5. Since 'draft-reschke-webdav-allprop-include-04'

DTD fix for dead-props variant. Remove superfluous IP and copyright sections. Added reference to RFC2518bis. Updated reference to ACL draft.

B.6. Since 'draft-reschke-webdav-allprop-include-05'

Updated various references. Update abstract.

Authors' Addresses

Julian F. Reschke (editor)
greenbytes GmbH
Salzmannstrasse 152
Muenster, NW 48159
Germany
Phone: +49 251 2807760
Fax: +49 251 2807761
EMail: julian.reschke@greenbytes.de
URI: http://greenbytes.de/tech/webdav/
Stefan Eissing
greenbytes GmbH
Salzmannstrasse 152
Muenster, NW 48159
Germany
Phone: +49 251 2807760
Fax: +49 251 2807761
EMail: stefan.eissing@greenbytes.de
URI: http://greenbytes.de/tech/webdav/

Full Copyright Statement

Copyright © The Internet Society (2005).

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.

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.

Intellectual Property

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 procedures with respect to rights in RFC 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.