view Side-By-Side changes
WEBDAV Working Group Y.Y. Goland, Microsoft INTERNET DRAFT E.J. Whitehead, Jr., UC Irvine<draft-ietf-webdav-protocol-05><draft-ietf-webdav-protocol-06> A. Faizi, Netscape S.R. Carter, Novell D. Jensen, Novell ExpiresApril,July, 1998 January 18, 1998November 19, 1997Extensions for Distributed Authoring on the World Wide Web -- WEBDAV Status of this Memo This document is an Internet-Draft. 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 made obsolete 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". To learn the current status of any Internet-Draft, please check the "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe), munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or ftp.isi.edu (US West Coast). 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://www.w3.org/pub/WWW/Archives/Public/w3c-dist-auth>. Abstract This document specifies a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, namespace manipulation, and resource locking (collisionavoidance), and efficient transmission of resource changes.avoidance). Changes1.1.Changes sincedraft-ietf-webdav-protocol-04.txtdraft-ietf-webdav-protocol-06.txt [Editor's note: This section will not appear in the final form of this document. Its purpose is to provide a concise list of changes from the previous revision of the draft for use by reviewers.]Added this change section. INTERNET-DRAFT WebDAV November 19, 1997 Removed scoping for namespaces so the namespaceRationale forevery element is explicitly stated. Changedmany of thesyntax from <?XML:Namespace.../> to <?namespace...?>. Removed propfindresult,changes made in thiswas left over fromrevision of theold search format. Changed alldraft can be found in theDAV XML element names to lower case. Changedmailing list archives at: Goland et al. [Page 1] INTERNET-DRAFT WebDAV January 18, 1998 http://lists.w3.org/Archives/Public/w3c-dist-auth/1997OctDec/0160.ht ml. Where theproperty format200 OK status code was used touse Nameindicate a successful response without a response entity body, 204 No Content is now used. Because PEP uses 420 andNamespace rather than name421 status codes, andschema. Removed proploc attributesince PEP has been submitted as an Experimental RFC, the WebDAV 420 status code has been changed to 422, andremoved section on GETting, DELETEing,the WebDAV 421 status code has been changed to 423. The 423 Destination Locked status code has been changed to 423 Locked, andPUTing properties since we do not provide a mechanism for getting a URI for properties. Also removednow covers all cases where an operand was locked, preventing therequirement that properties be URI addressable.execution of the method. Removedquoted string choice from ownerthe Destroy header, since it isjust XML. Made all the HTTP error codes use the same format. Changed the name of the create elementnot needed inPROPPATCH to set, the new name seems to cause less confusion. Moved all headersthis draft, but will be needed in thedraftversioning draft. The Enforce-Live-Properties header was renamed toa single section. DeletedProperty-Behavior, to more closely represent thestate token sectionmeaning of thedraft and movedheader now that thestate token headers"omit" functionality is included. A keepalive field was added to the Property-Behavior headersection of the draft.to make it more meaningful. Removed thestate token header. Changed the write lock section to stateINDEX method, since the functionality of INDEX can now be performed by the PROPFIND method. PROPFIND provides more flexibility in specifying the type and amount of property information returned than does INDEX, which is important for returning information on a large number of resources. Clarified that performing aLock-Token request header, notMOVE as astate-token request header, isCOPY, then DELETE, performed atomically, only applies tobe submitted on request for write lockednon-collection resources.Created a "generic" XML element section for XML elementsClarified the semantics of errors thatget repeatedly re-used throughoutare encountered in infinite depth move and copy of a hierarchy of resources. For errors copying internal nodes of thespec. I moved LINK XML elementhierarchy tree (i.e., collections), the operation skips that subtree, and moves on tothis section. Made multistatusthe next subtree. If an error is encountered moving/copying a leaf of the tree, then skip that resource, andSchema discovery their own level one sections. Collected allmove on to theproperties together.next leaf. Removedall references tothepossibility of properties have their own URIs.PATCH method. Thisincludes removing the property identifier section. Separatedwill be resubmitted as thesectiondocument draft-ietf-webdav-patch-00. Added language that states that if a PROPPATCH is invoked onweb collectionsa null resource (e.g., a deleted resource), an empty resource is created, andnamespaces into two separate sections. Collected allthe PROPPATCH directives are performed on this newresponse codes together into their own section. INTERNET-DRAFT WebDAV November 19, 1997 Changed the XML multiresponse element name to multistatus.resource. Added astand alone section on levels of DAV compliance. I also went method by method, property by property,forward reference tospecify compliance requirements. Added an introduction.the source link definition (Section 13.11) in Section 4.4. Changed allthe "True" and "False"Values= to"T" and "F". Altered the first two paragraphs of the Property Names sectionValues:. Also changed all "values" tomake the relationship between a property's name"value". Goland et al. [Page 2] INTERNET-DRAFT WebDAV January 18, 1998 References to state tokens are now restricted to sections 9.7 andits schema9.8. The property-behavior header has been turned into the propertybehavior XML element because it contained alittle clearer.list of URIs which can thus have unbounded size. The lock-info header has been turned into the lockinfo XML element for the same reason. I have alsoadded some text inmade the samesection defining a property name as a namespace andchange of the Propfind header into the Propfind XML element.Added a second paragraph toWe can put the propertymodel for http resources - overview. This paragraph clarifies why XML was chosen. Added a 409 Conflict error to move to cover attemptsbehavior header into the body because neither COPY nor MOVE have bodies. However we can't put lock-token, if-state-match, etc. in the body because they may need tomovebe used with PUT. However I don't consider this acollectionbig deal because I sincerely doubt that there will be cases where lock-token or if-state-match will see large numbers of entries. Also changed omit to mean "copy properties withmembers. Changedbest effort but failure is acceptable." Added thecollection requirementexternal members property. Added language toread6.4 making it clear that any new resources created as thecollections SHOULD end with "/". Also added a SHOULD about returningchild of alocation header ifwrite locked collection is added to theclient submitslock. Made the lock-token response header from a single URLfor a collection without a trailing "/". Movedto multiple URLs. But all theowner header intoURLs MUST refer to thebody dueexact same lock. <?XML version="1.0"> changed tosize concerns. Replacedtheiscollection xml element with resourcetype. Movedcorrect form: <?xml version="1.0"?> Changed theDAV propertydelete rule for collections tothe DAV headerread that if a delete in a collection member fails then it isreturned with OPTIONS. Foldedthetree draft into this draft. Changedancestors, not theDELETE, COPY, and MOVE sectionsprogeny, who can not be deleted in order toinclude their effect on collections as taken frommaintain thetree draft. Created a Depth header sectionnamespace. Updated our reference to the XML spec. Added LOCK andput inUNLOCK to thegeneral ruleslist of methods covered by the write lock. This is necessary so thatwerea lock-token will have to be submitted inthe introductionorder to make changes, otherwise we defeat thetree draft. I also addedwhole purpose of requiring the102 response and response-status header. Removedlock-token. Changed theversioning section. Put alltitle of section 6.6 from Re-Issuing Write Locks to Refreshing Write Locks, made it illegal to make themethods into a single section. Replacedsame lock request twice (you know you are making thePROPFINDsame requestbody with a propfind header. Nowbecause you had to include theresponse can be cached just using vary. Nuked resinfo for INDEXlock-token to make it!) andcombinedinstead made it legal to submit a LOCK method withmultistatus which is now used for both INDEX and PROPFIND. Stripped down INDEX as agreed. Removed the problem definition and proposed solution sections. We can always cut and paste them together from the older version if we feel we need themno body butthis draft is supposed to bewith adry runlock-token header. I also added a refresh example. Put in a note that an empty request body for PROPFIND means to return all names and values of properties on the resources. Goland et al. [Page 3] INTERNET-DRAFT WebDAVNovember 19, 1997 last call and last call documents do notJanuary 18, 1998 I haveproblem definition/proposed solution sections. Killed theadded a section onschema discovery,XML processing errors. I know, I know, itis controversial and we aren't going toshouldn't beable to require it. We should specify itina different spec. Added a section on notational conventions used within the document. Movedtheterminology sectionstandard. I will move it to our compliance draft as soon as we prepare theend offirst version. Removed addlocks and replaced with thedocument to provide better flow fromdepth header and thehigh-level introductiondepth element. Changed all the as in namespace elements to all lower case. Moved all XML element declarations to thespecific introduction sections. Increasedsame section. Removed thenumeric value ofparent description. Updated the4xx status codes introduceddepth section to make it more generic, changed the wording for how COPY/MOVE are handled with write locks, require that ALL propfind responses include href, require that if a property is not found inthis specificationa propfind then a 404 Not Found must be returned, and made explicit that PROPFIND responses on resources with internal members are returned as a flat list with no significance toavoid conflictsits ordering. Removed reference to efficient update in the introduction since PATCH is now gone. Rewrote the write lock and null resource section to deal with thenew revisionquestion of theHTTP/1.1 specification, which introduces twostate of the resource when it is locked and null. Changed www.ietf.org to www.iana.org. Changed the response element and added the new4xx status codes. Wrote internationalization concernspropstat element. With the prohibition that an HREF can only appear once in a multistatus response we can guarantee linear processing costs. Added Intellectual Property section, as required by RFC 2026. Added IANA Considerations section. Added Authorization headers to LOCK and UNLOCK examples. Changed lock tokens in examples to use string format of UUID. Since the latest HTTP revision defines a 418 and 419 status code, the 418 status code has been changed to 422, 419 to 423, 422 to 424, and 423 to 425. Changed implementation of the get* (e.g., getcontentlength) properties to strength MUST. Changed definition of XMLversion numberelements and DAV properties to use XML element definitions, rather than BNF. Renumbered allexamples.sections Goland et al. [Page 4] INTERNET-DRAFT WebDAVNovember 19, 1997January 18, 1998 Contents STATUS OF THISMEMO...................................................1 ABSTRACT..............................................................1 CHANGES...............................................................1 1.1.MEMO..................................................1 ABSTRACT.............................................................1 CHANGES..............................................................1 Changes sincedraft-ietf-webdav-protocol-04.txt..................1 CONTENTS..............................................................5 2. INTRODUCTION.......................................................8 3.draft-ietf-webdav-protocol-06.txt......................1 CONTENTS.............................................................5 1 INTRODUCTION.......................................................9 2 DATA MODEL FOR RESOURCEPROPERTIES.................................9 3.1.PROPERTIES................................10 2.1 The Resource PropertyModel......................................9 3.2.Model....................................10 2.2 Existing MetadataProposals.....................................10 3.3.Proposals....................................10 2.3 Properties and HTTPHeaders.....................................10 3.4.Headers....................................11 2.4 PropertyValues.................................................10 3.5.Values................................................11 2.5 PropertyNames..................................................11 4.Names.................................................12 3 COLLECTIONS OF WEBRESOURCES......................................11 4.1.RESOURCES......................................12 3.1 CollectionResources............................................11 4.2.Resources...........................................12 3.2 Creation and Retrieval of CollectionResources..................12 4.3.Resources.................13 3.3 HTTP URL NamespaceModel........................................13 4.4.Model.......................................13 3.4 Source Resources and OutputResources...........................13 5. LOCKING...........................................................14 5.1.Resources..........................14 4 LOCKING...........................................................15 4.1 Exclusive Vs. SharedLocks......................................14 5.2.Locks.....................................15 4.2 RequiredSupport................................................15 5.3.Support...............................................16 4.3 LockTokens.....................................................16 5.4.Tokens....................................................16 4.4 opaquelocktoken Lock Token URIScheme...........................16 5.5.Scheme..........................17 4.5 Lock CapabilityDiscovery.......................................16 5.6.Discovery......................................17 4.6 Active LockDiscovery...........................................17 6.Discovery..........................................18 5 WRITELOCK........................................................17 6.1.LOCK........................................................18 5.1 Methods Restricted by WriteLocks...............................17 6.2.Locks..............................18 5.2 Write Locks andProperties......................................17 6.3.Properties.....................................18 5.3 Write Locks and NullResources..................................17 6.4.Resources.................................18 5.4 Write Locks andCollections.....................................18 6.5.Collections....................................19 5.5 Write Locks andCOPY/MOVE.......................................18 6.6. Re-issuingCOPY/MOVE......................................19 5.6 Refreshing WriteLocks..........................................18 6.7.Locks.........................................19 5.7 Write Locks and The Lock-Token RequestHeader...................18 7.Header..................20 5.7.1 Write Lock Token Example...................................20 6 NOTATIONALCONVENTIONS............................................19 8.CONVENTIONS............................................21 7 HTTP METHODS FOR DISTRIBUTEDAUTHORING............................19 8.1. PROPFIND........................................................19 8.2. PROPPATCH.......................................................23 8.3.AUTHORING............................21 7.1 PROPFIND.......................................................21 7.1.1 Example: Retrieving Named Properties.......................22 7.1.2 Example: Using allprop to Retrieve All Properties..........23 7.1.3 Example: Using propname to Retrieve all Property Names.....26 7.2 PROPPATCH......................................................28 7.2.1 Status Codes...............................................28 7.2.2 Example....................................................28 7.3 MKCOLMethod....................................................25 8.4. INDEX Method....................................................26 8.5. DELREF Method...................................................28 8.6.Method...................................................30 7.3.1 Request....................................................30 Goland et al. [Page 5] INTERNET-DRAFT WebDAV January 18, 1998 7.3.2 Response Codes.............................................30 7.3.3 Example....................................................31 7.4 ADDREFMethod...................................................28 8.7.Method..................................................31 7.4.1 The Request................................................31 7.4.2 Example....................................................31 7.5 DELREF Method..................................................32 7.5.1 The Request................................................32 7.5.2 Example....................................................32 7.6 GET, HEAD forCollections.......................................29 8.8.Collections......................................32 7.7 POST forCollections............................................29 8.9. DELETE..........................................................29 8.10. PUT............................................................31 INTERNET-DRAFT WebDAV November 19, 1997 8.11.Collections...........................................33 7.8 DELETE.........................................................33 7.8.1 DELETE for Non-Collection Resources........................33 7.8.2 DELETE for Collections.....................................33 7.9 PUT............................................................34 7.9.1 PUT for Non-Collection Resources...........................34 7.9.2 PUT for Collections........................................35 7.10 COPYMethod....................................................31 8.12. MOVEMethod....................................................358.13.7.10.1 COPY for HTTP/1.1 resources................................35 7.10.2 COPY for Properties........................................35 7.10.3 COPY for Collections.......................................36 7.10.4 Type Interactions..........................................37 7.10.5 Status Codes...............................................37 7.10.6 Overwrite Example..........................................38 7.10.7 No Overwrite Example.......................................38 7.10.8 Collection Example.........................................38 7.11 MOVE Method....................................................39 7.11.1 MOVE for Collections.......................................40 7.11.2 Status Codes...............................................40 7.11.3 Non-Collection Example.....................................41 7.11.4 Collection Example.........................................41 7.12 LOCKMethod....................................................38 8.14.Method....................................................42 7.12.1 Operation..................................................43 7.12.2 The Effect of Locks on Properties and Collections..........43 7.12.3 Locking Replicated Resources...............................43 7.12.4 Depth and Locking..........................................43 7.12.5 Interaction with other Methods.............................44 7.12.6 Lock Compatibility Table...................................44 7.12.7 Lock Response..............................................44 7.12.8 Status Codes...............................................44 7.12.9 Example - Simple Lock Request..............................45 7.12.10 Example - Refreshing a Write Lock.........................46 7.12.11 Example - Multi-Resource Lock Request.....................47 7.13 UNLOCKMethod..................................................42 8.15. PATCH Method...................................................43 9. DAV HEADERS.......................................................47 9.1.Method..................................................48 7.13.1 Example....................................................48 8 HTTP HEADERS FOR DISTRIBUTED AUTHORING............................49 Goland et al. [Page 6] INTERNET-DRAFT WebDAV January 18, 1998 8.1 Collection-MemberHeader........................................47 9.2.Header.......................................49 8.2 DAVHeader......................................................47 9.3.Header.....................................................49 8.3 DepthHeader....................................................47 9.4.Header...................................................49 8.4 DestinationHeader..............................................48 9.5. Destroy Header..................................................48 9.6. Enforce-Live-Properties Header..................................49 9.7. If-None-State-Match.............................................49 9.8. If-State-Match..................................................50 9.9. Lock-Info Request Header........................................50 9.10.Header.............................................50 8.5 If-None-State-Match............................................50 8.6 If-State-Match.................................................51 8.7 Lock-Token Request Header......................................519.11.8.8 Lock-Token ResponseHeader.....................................51 9.12.Header.....................................52 8.9 OverwriteHeader...............................................52 9.13. Propfind Request Header........................................52 9.14.Header...............................................53 8.10 Status-URI ResponseHeader.....................................52 9.15.Header.....................................53 8.11 TimeoutHeader.................................................52 10. RESPONSEHeader.................................................53 9 STATUS CODE EXTENSIONS TORFC 2068.............................54 10.1.HTTP/1.1................................54 9.1 102 Processing.................................................5410.2.9.2 207Multi-Status...............................................54 10.3. 418Multi-Status...............................................55 9.3 422 UnprocessableEntity.......................................54 10.4. 419Entity.......................................55 9.4 423 Insufficient Space onResource.............................54 10.5. 420Resource.............................55 9.5 424 MethodFailure.............................................54 11.Failure.............................................55 9.6 425 Locked.....................................................55 10 MULTI-STATUSRESPONSE............................................54 11.1. multistatusRESPONSE...........................................55 11 XMLElement........................................55 11.2. responseELEMENT DEFINITIONS.........................................55 11.1 activelock XMLElement...........................................55 11.3. statusElement.........................................56 11.1.1 depth XMLElement.............................................55 11.4. responsedescriptionElement..........................................56 11.1.2 locktoken XMLElement................................55 12. GENERIC DAVElement......................................56 11.1.3 timeout XML Element........................................56 11.2 collection XMLELEMENTS.........................................55 12.1.Element.........................................56 11.3 href XML Element...............................................5612.2.11.4 link XMLElement...............................................56 12.3.Element...............................................57 11.4.1 dst XML Element............................................57 11.4.2 src XML Element............................................57 11.5 lockentry XML Element..........................................57 11.6 lockinfo XML Element...........................................57 11.7 lockscope XML Element..........................................58 11.7.1 exclusive XML Element......................................58 11.7.2 shared XML Element.........................................58 11.8 locktype XML Element...........................................58 11.8.1 write XML Element..........................................58 11.9 multistatus XML Element........................................58 11.9.1 response XML Element.......................................59 11.9.2 responsedescription XML Element............................59 11.10 owner XML Element.............................................60 11.11 prop XMLelement...............................................57 13.element..............................................60 11.12 propertybehavior XML element..................................60 11.12.1 keepalive XML element.....................................60 11.12.2 omit XML element..........................................61 11.13 propertyupdate XML element....................................61 Goland et al. [Page 7] INTERNET-DRAFT WebDAV January 18, 1998 11.13.1 remove XML element........................................61 11.13.2 set XML element...........................................62 11.14 propfind XML Element..........................................62 11.14.1 allprop XML Element.......................................62 11.14.2 propname XML Element......................................62 12 DAVPROPERTIES...................................................57 13.1.PROPERTIES..................................................62 12.1 creationdateProperty..........................................57 13.2.Property..........................................63 12.2 displaynameProperty...........................................57 13.3. get-content-language Property..................................58 13.4. get-content-length Property....................................58 13.5. get-content-type Property......................................58 13.6. get-etag Property..............................................58 13.7. get-last-modified Property.....................................59 13.8. index-content-language Property................................59 INTERNET-DRAFT WebDAV November 19, 1997 13.9. index-content-length Property..................................59 13.10. index-content-type Property...................................59 13.11. index-etag Property...........................................59 13.12. index-last-modified Property..................................60 13.13.Property...........................................63 12.3 externalmembers Property.......................................63 12.4 getcontentlanguage Property....................................63 12.5 getcontentlength Property......................................64 12.6 getcontenttype Property........................................64 12.7 getetag Property...............................................64 12.8 getlastmodified Property.......................................64 12.9 lockdiscoveryProperty........................................60 13.14.Property.........................................65 12.9.1 Example....................................................65 12.10 resourcetypeProperty.........................................62 13.15. Source Link Property Type.....................................62 13.16.Property.........................................66 12.11 source Property...............................................66 12.11.1 Example...................................................67 12.12 supportedlockProperty........................................63 14.Property........................................67 12.12.1 Example...................................................68 13 DAV COMPLIANCELEVELS............................................64 14.1. Level 1........................................................64 14.2. Level 2........................................................64 15.CLASSES..........................................68 13.1 Class 1........................................................69 13.2 Class 2........................................................69 14 INTERNATIONALIZATIONSUPPORT.....................................65 16.CONSIDERATIONS.............................69 15 SECURITYCONSIDERATIONS..........................................66 17. TERMINOLOGY......................................................66 18. COPYRIGHT........................................................66 19. ACKNOWLEDGEMENTS.................................................67 20. REFERENCES.......................................................69 21.CONSIDERATIONS.........................................70 15.1 Authentication of Clients......................................71 15.2 Denial of Service..............................................71 15.3 Security through Obscurity.....................................72 15.4 Privacy Issues Connected to Locks..............................72 15.5 Privacy Issues Connected to Properties.........................72 15.6 Reduction of Security due to Source Link.......................72 16 IANA CONSIDERATIONS.............................................73 17 TERMINOLOGY.....................................................73 18 COPYRIGHT.......................................................74 19 INTELLECTUAL PROPERTY...........................................74 20 ACKNOWLEDGEMENTS................................................75 21 REFERENCES......................................................76 22 AUTHORS'ADDRESSES...............................................71ADDRESSES..............................................78 23 APPENDICES......................................................79 23.1 Appendix 1 - WebDAV Document Type Definition...................79 23.2 Appendix 2 - ISO 8601 Date and Time Profile....................80 23.3 Appendix 3 - Notes on Processing XML Elements..................81 23.3.1 XML Syntax Error Example...................................81 23.3.2 Unknown XML Element Example................................81 Goland et al. [Page 8] INTERNET-DRAFT WebDAVNovember 19, 1997 2.January 18, 1998 1 Introduction This document describes an extension to the HTTP/1.1 protocol that allows clients to perform remote web content authoring operations. This extension provides a coherent set of methods, headers, request entity body formats, and response entity body formats that provide operations for: Properties: The ability to create, remove, and query information about Web pages, such asits author,their authors, creationdate,dates, etc. Also, the ability to link pages of any media type to related pages. Collections: The ability to create sets of related documents, and to receive a listing of pages at a particular hierarchy level (like a directory listing in a file system). Locking: The ability to keep more than one person from working on a document at the same time. This prevents the "lost updateproblem"problem," in which modifications are lost as first one author, then another writestheirchanges without merging the other author's changes Namespace Operations: The ability to copy and move Web resourcesEfficient Update: The ability to send changes which are proportional to the size of the change rather than retransmitting the entire resource.Requirements and rationale for these operations are described in a companion document, "Requirements for a Distributed Authoring and Versioning Protocol for the World Wide Web" [Slein et al., 1997]. The sections below provide a detailed introduction to resource properties (Section3),2), collections of resources (Section4),3), and locking operations (Section5).4). These sections introduce the abstractions manipulated by the WebDAV-specific HTTP methods described in Section8,7, "HTTP Methods for Distributed Authoring". In HTTP/1.1, method parameter information was exclusively encoded in HTTP headers. Unlike HTTP/1.1, WebDAV, encodes method parameter information either in an Extensible Markup Language (XML) [Bray, Paoli, Sperberg-McQueen,1997]1998] request entity body, or in an HTTP header. The use of XML to encode method parameters was motivated by the ability to add extra XML elements to existing structures, providing extensibility, and by XML's ability to encode information in ISO 10646 character sets, providing internationalization support. As a rule of thumb, parameters are encoded in XML entity bodies when they have unbounded length, or when they may be shown to a human user and hence require encoding in an ISO 10646 character set. Otherwise, parameters are encoded withinanHTTPheader.headers. Section98 describes the new HTTP headers used with WebDAV methods.INTERNET-DRAFT WebDAV November 19, 1997In addition to encoding method parameters, XML is used in WebDAV to encode the responses from methods, providing the extensibility and internationalization advantages of XML for method output, as well as Goland et al. [Page 9] INTERNET-DRAFT WebDAV January 18, 1998 input. XML elements used in this specification are defined in Section12.11. While theresponsestatus codes provided by HTTP/1.1 are sufficient to describethe preponderance ofmost error conditions encountered by WebDAV methods, there are some errors that do not fall neatly into the existing categories. New status codes developed for the WebDAV methods are defined in Section10.9. Since some WebDAV methods may operate over many resources, themultiresponseMulti-Status status type has been introduced to return status information for multiple resources.Multiresponse statusMulti-Status response is described in Section11. The properties mechanism is employed by10. WebDAV employs the property mechanism to store information about the current state of the resource. For example, when a lock is taken out on a resource, a lock information property describes the current state of the lock. Section1312 defines the properties used within the WebDAV specification. Finishing off the specification are sections on what it means to be compliant with this specification (Section14),13), on internationalization support (Section15),14), and on security (Section16). 3.15). 2 Data Model for Resource Properties3.1.2.1 The Resource Property Model Properties are pieces of data that describe the state of a resource. Properties are data about data. Properties are used in distributed authoring environments to provide for efficient discovery and management of resources. For example, a 'subject' property might allow for the indexing of all resources by their subject, and an 'author' property might allow for the discovery of what authors have written which documents. The DAV property model consists of name/value pairs. The name of a property identifies the property's syntax and semantics, and provides an address by which to refer to that syntax and semantics. There are two categories of properties: "live" and"non-live"."dead". A live property has its syntax and semantics enforced by the server.This represents the twoLive properties include casesofwhere a) the value of a property is read- only, maintained by the server, and b) the value of the property is maintained by the client, but the server performs syntax checking on submitted values. Anon-livedead property has its syntax and semantics enforced by the client; the server merely records the value of the property verbatim.INTERNET-DRAFT WebDAV November 19, 1997 3.2.2.2 Existing Metadata Proposals Goland et al. [Page 10] INTERNET-DRAFT WebDAV January 18, 1998 Properties have long played an essential role in the maintenance of large document repositories, and many current proposals contain some notion of a property, or discuss web metadata more generally. These include PICS [Miller et al., 1996], PICS-NG,the Rel/Rev draft [Maloney, 1996], Web Collections,XML [Bray, Paoli, Sperberg-McQueen,1997],1998], Web Collections, and several proposals on representing relationships withinHTML, digital signature manifests (DCMF), and a position paper on Web metadata architecture [Berners-Lee, 1997].HTML. Work on PICS-NG and Web Collections has been subsumed by the Resource Definition Framework (RDF) metadata activity of the World Wide WebConsortium, whichConsortium. RDF consists of a network-based data model and an XML representation of that model. Some proposals come from a digital library perspective. These include the Dublin Core [Weibel et al., 1995] metadata set and the Warwick Framework [Lagoze, 1996], a container architecture for different metadata schemas. The literature includes many examples of metadata, including MARC [MARC, 1994], a bibliographic metadata format, and RFC 1807 [Lasher, Cohen, 1995], a technical report bibliographic format employed by the Dienst system. Additionally, the proceedings from the first IEEE Metadata conference describe many community-specific metadata sets. Participants of the 1996 Metadata II Workshop in Warwick, UK [Lagoze, 1996], notedthat,that "new metadata sets will develop as the networked infrastructure matures" and "different communities will propose, design, and be responsible for different types of metadata." These observations can be corroborated by noting that many community-specific sets of metadata already exist, and there is significant motivation for the development of new forms of metadata as many communities increasingly make their data available in digital form, requiring a metadata format to assist data location and cataloging.3.3.2.3 Properties and HTTP Headers Properties already exist, in a limited sense, in HTTP message headers. However, in distributed authoring environments a relatively large number of properties are needed to describe the state of a resource, and setting/returning them all through HTTP headers is inefficient. Thus a mechanism is needed which allows a principal to identify a set of properties in which the principal is interested and tothenset or retrieve just those properties.3.4.2.4 Property Values The value of a property is expressed as a well-formed XML document.INTERNET-DRAFT WebDAV November 19, 1997XML has been chosen because it is a flexible, self-describing, structured data format that supports rich schema definitions, and because of its support for multiple character sets. XML's self- describing nature allows any property's value to be extended by adding new elements. Older clients will not break when they encounter extensions because they will still have the data specified Goland et al. [Page 11] INTERNET-DRAFT WebDAV January 18, 1998 in the original schema and will ignore elements they do not understand. XML's support for multiple character sets allows any human-readablepropertiesproperty to be encoded and read in a character set familiar to the user.3.5.2.5 Property Names A property name is a universally unique identifier that is associated with a schema that provides information about the syntax and semantics of the property. Because a property's name is universally unique, clients can depend upon consistent behavior for a particular property across multiple resources, so long as that property is "live" on the resources in question. The XML namespace mechanism, which is based on URIs, is used to name properties because itprovides a mechanism to preventprevents namespace collisions and provides for varying degrees of administrative control. The property namespace is flat; that is, no hierarchy of properties is explicitly recognized. Thus, if a property A and a property A/B exist on a resource, there is no recognition of any relationship between the two properties. It is expected that a separate specification will eventually be produced which will address issues relating to hierarchical properties. Finally, it is not possible to define the same property twice on a single resource, as this would cause a collision in the resource's property namespace.4.3 Collections of Web Resources This section provides a description of a new type of Web resource, the collection, and discusses its interactions with the HTTPURLUniform Resource Locator (URL) namespace. The purpose of a collection resource is to model collection-like objects (e.g., filesystem directories) within a server's namespace. All DAV compliant resources MUST support the HTTP URL namespace model specified herein.4.1.3.1 Collection Resources A collection is a resource whose state consists of an unordered list of internal members, an unordered list of external members, and aINTERNET-DRAFT WebDAV November 19, 1997set of properties. An internal member resource MUST have a URI that is immediately relative to the base URI of thecollection, thatcollection. That is,a relativethe internal member's URIin which "../"isillegal, which MUST begin with "./" and which SHOULD contain a "/" at the end ofequal to the parent collection's URIif the internal member resourceplus an additional segment where segment isitself a collection.defined in Section 3.2.1 of RFC 2068 [Fielding et al., 1996]. Goland et al. [Page 12] INTERNET-DRAFT WebDAV January 18, 1998 An external member resourceMUST be an absolute URI thatis a resource that could not be an internalURI.member resource. Any given internal or externalURIMember MUST only belong to the collection once, i.e., it is illegal to have multiple instances of the same URI in a collection. Properties defined on collections behave exactly as do properties onnon-collectionnon- collection resources. There is a standing convention that when a collection is referred to by its name without a trailing slash, the trailing slash is automatically appended. Due to this, a resource MAY accept a URI without a trailing "/" to point to a collection. In this case it SHOULD return a location header in the response pointing to the URL ending with the "/". For example, if a clientperforms an INDEXinvokes a method on http://foo.bar/blah (no trailing slash), the resource http://foo.bar/blah/ (trailing slash) MAY respond as if the operation were invoked on it, and SHOULD return a location header with http://foo.bar/blah/ in it.4.2.In general clients SHOULD use the "/" form of collection names. 3.2 Creation and Retrieval of Collection Resources This document specifies the MKCOL method to create new collection resources, rather than using the existing HTTP/1.1 PUT or POST method, for the following reasons In HTTP/1.1, the PUT method is defined to store the request body at the location specified by the Request-URI. While a description format for a collection can readily be constructed for use with PUT, the implications of sending such a description to the server are undesirable. For example, if a description of a collection that omitted some existing resources were PUT to a server, this might be interpreted as a command to remove those members. This would extend PUT to perform DELETE functionality, which is undesirable since it changes the semantics of PUT, and makes it difficult to control DELETE functionality with an access control scheme based on methods. While the POST method is sufficiently open-ended that a_create"create acollection_collection" POST command could be constructed, this is undesirable because it would be difficult to separate access control for collection creation from other uses of POST.This document specifies the INDEX method for listing the contents of a collection, rather than relying on the existing HTTP/1.1 GET method. This is to avoid conflict with the de-facto standard practice of redirecting a GET request on a directory to its index.html resource. INTERNET-DRAFT WebDAV November 19, 1997The exact definition of the behavior of GET and PUT on collections is defined later in this document.4.3.3.3 HTTP URL Namespace Model The HTTP URL Namespace is a hierarchical namespace where the hierarchy is delimited with the "/" character. DAV compliant resources MUST maintain the consistency of the HTTP URL namespace. Any attempt to create a resource (excepting the root member of a namespace) that would not be the internal member of a collection Goland et al. [Page 13] INTERNET-DRAFT WebDAV January 18, 1998 MUST fail. For example, if the collection http://www.foo.bar.org/a/ exists, but http://www.foo.bar.org/a/b/does not exist, an attempt to create http://www.foo.bar.org/a/b/c must fail.4.4.3.4 Source Resources and Output Resources For many resources, the entity returned by a GET method exactly matches the persistent state of the resource, for example, a GIF file stored on a disk. For this simple case, the URL at which a resource is accessed is identical to the URL at which the source (the persistent state) of the resource is accessed. This is also the case for HTML source files that are not processed by the server prior to transmission. However, the server can sometimes process HTML resources before they are transmitted as a return entity body. For example, server-side- include directives within an HTML file instruct a server to replace the directive with another value, such as the current date. In this case, what is returned by GET (HTML plus date) differs from the persistent state of the resource (HTML plus directive). Typically there is no way to access the HTML resource containing the unprocessed directive. Sometimes the entity returned by GET is the output of a data- producing process that is described by one or more source resources (that may not even have a location in the URL namespace). A single data-producing process may dynamically generate the state of a potentially large number of output resources. An example of this is a CGI script that describes a "finger" gateway process that maps part of the namespace of a server into finger requests, such as http://www.foo.bar.org/finger_gateway/user@host. In the absence of distributed authoring capabilities, it is acceptable to have no mapping of source resource(s) to the URI namespace. In fact, preventing access to the source resource(s) has desirable security benefits. However, if remote editing of the source resource(s) is desired, the source resource(s) should be given a location in the URI namespace. This source location should not be one of the locations at which the generated output is retrievable, since in general it is impossible for the server to differentiate requests for source resources from requests forINTERNET-DRAFT WebDAV November 19, 1997process output resources. There is often a many-to-many relationship between source resources and output resources. On WebDAV compliant servers, for all output resources which have a single source resource (and that source resource has a URI), the URI of the source resource SHOULD be stored in a link on the output resource with typehttp://www.ietf.org/standards/dav/source.http://www.iana.org/standards/dav/source (see Section 12.11 for a description of the source link). Note that by storing the source URIs in links on the output resources, the burden of discovering the source is placed on the authoring client.5.Goland et al. [Page 14] INTERNET-DRAFT WebDAV January 18, 1998 4 Locking The ability to lock a resource provides a mechanism for serializing access to that resource. Using a lock, an authoring client can provide a reasonable guarantee that another principal will not modify a resource while it is being edited. In this way, a client can prevent the "lost update" problem. This specification allows locks to vary over two client-specified parameters, the number of principals involved (exclusive vs. shared) and the type of access to be granted.Furthermore, thisThis documentonly provides the definition ofdefines locking for only onelockaccess type,the write lock.write. However, the syntax is extensible, and permits the eventual specification of locking for other access types.5.1.4.1 Exclusive Vs. Shared Locks The most basic form of lock is an exclusive lock. This is a lock where the access right in question is only granted to a single principal. The need for this arbitration results from a desire to avoid having to constantly merge results. However, there are times when the goal of a lock is not to exclude others from exercising an access right but rather to provide a mechanism for principals to indicate that they intend to exercise their access right. Shared locks are provided for this case. A shared lock allows multiple principals to receive a lock. Hence any principal with appropriate access can get the lock. With shared locks there are two trust sets that affect a resource. The first trust set is created by access permissions. Principals who are trusted, for example, may have permission to write the resource. Those who are not, don't. Among those who have access permission to write the resource, the set of principals who have taken out a shared lock also must trust each other, creating a (typically) smaller trust set within the access permission write set. Starting with every possible principal on the Internet, in most situations the vast majority of these principals will not have writeINTERNET-DRAFT WebDAV November 19, 1997access to a given resource. Of the small number who do have write access, some principals may decide to guarantee their edits are free from overwrite conflicts by using exclusive write locks. Others may decide they trust their collaborators will not overwrite their work (the potential set of collaborators being the set of principals who have write permission) and use a shared lock, which informs their collaborators that a principalis potentiallymay be working on the resource. The WebDAV extensions to HTTP do not need to provide all of the communications paths necessary for principals to coordinate their activities. When using shared locks, principals may use any out of Goland et al. [Page 15] INTERNET-DRAFT WebDAV January 18, 1998 band communication channel to coordinate their work (e.g., face-to- face interaction, written notes, post-it notes on the screen, telephone conversation, Email, etc.) The intent of a shared lock is to let collaborators know who elseis potentiallymay be working on a resource. Shared locks are included because experience from web distributed authoring systems has indicated that exclusive write locks are often too rigid. An exclusive write lock is used to enforce a particular editing process: take out exclusive write lock, read the resource, perform edits, write the resource, release the lock. This editing process has the problem that locks are not always properly released, for example when a program crashes, or when a lock owner leaves without unlocking a resource. While both timeouts and administrative action can be used to remove an offending lock, neither mechanism may be available when needed; the timeout may be long or the administrator may not be available. Despite their potential problems, exclusive write locks are extremely useful, since often a guarantee of freedom from overwrite conflicts is what is needed. This specification provides both exclusive write locks and the less strict mechanism of shared locks.5.2.4.2 Required Support A WebDAV compliant server is not required to support locking in any form. If the server does support locking it MAY choose to support any combination of exclusive and shared locks for any access types. The reason for this flexibility is that locking policy strikes to the very heart of the resource management and versioning systems employed by various storage repositories. These repositories require control over what sort of locking will be made available. For example, some repositories only support shared write locks while others only provide support for exclusive write locks while yet others use no locking at all. As each system is sufficiently different to merit exclusion of certain locking features, this specification leaves locking as the sole axis of negotiation within WebDAV.INTERNET-DRAFT WebDAV November 19, 1997 5.3.4.3 Lock Tokens A lock token is a URI that identifies a particular lock. A lock token is returned by every successful LOCK operation in thelock- tokenLock- Token response header, and can also be discovered through lock discovery on a resource. Lock token URIs are required to be unique across all resources for all time. This uniqueness constraint allows lock tokens to be submitted across resources and servers without fear of confusion. This specification provides a lock token URI scheme called opaquelocktoken that meets the uniqueness requirements. However Goland et al. [Page 16] INTERNET-DRAFT WebDAV January 18, 1998 resources are free to return any URI scheme so long as it meets the uniqueness requirements.5.4.4.4 opaquelocktoken Lock Token URI Scheme The opaquelocktoken URI scheme is designed to be unique across all resources for all time. Due to this uniqueness quality, a client MAY submit an opaque lock token in a Lock-Token request header and anif-state[-not]-matchIf-[None]-State-Match header on a resource other than the one that returned it. All resources MUST recognize the opaquelocktoken scheme and, at minimum, recognize that the lock token was not generated by the resource. Note, however, that resources are not required to generate opaquelocktokens in LOCK method responses. In order to guarantee uniqueness across all resources for all time the opaquelocktoken requires the use of theGUID mechanism.Universally Unique Identifier (UUID, also known as a Globally Unique Identifier, or GUID) mechanism, as described in [Leach, Salz, 1998]. Opaquelocktoken generators, however, have a choice of how they create these tokens. They can either generate a newGUIDUUID for every lock token they create, which is potentially very expensive, or they can create a singleGUIDUUID and then add extension characters. If the second method is selected then the program generating the extensions MUST guarantee that the same extension will never be used twice with the associatedGUID. Opaque-Lock-TokenUUID. OpaqueLockToken-URI ="opaquelocktoken" ":" GUID"opaquelocktoken:" UUID [Extension]GUID =;AsThe UUID production is the string form of a UUID, as defined in [Leach, Salz,1997]1998]. Note that white space (LWS) is not allowed between elements of this production. Extension =*urlc ;urlcpath ; path is defined in[Berners-LeeSection 3.2.1 of RFC 2068 [Fielding et al.,1997] (draft-fielding-url-syntax-07.txt) 5.5.1996] 4.5 Lock Capability Discovery Since server lock support is optional, a client trying to lock a resource on a server can either try the lock and hope for the best, or perform some form of discovery to determine what lock capabilities the server supports. This is known as lock capability discovery. Lock capability discovery differs from discovery ofINTERNET-DRAFT WebDAV November 19, 1997supported access control types, since there may be access control types without corresponding lock types. A client can determine what lock types the server supports by retrieving the supportedlock property. Any DAV compliant resource that supports the LOCK method MUST support the supportedlock property.5.6.Goland et al. [Page 17] INTERNET-DRAFT WebDAV January 18, 1998 4.6 Active Lock Discovery If another principal locks a resource that a principal wishes to access, it is useful for the second principal to be able to find out who the first principal is. For this purpose the lockdiscovery property is provided. This property lists all outstanding locks, describes their type, and provides their lock token. Any DAV compliant resource that supports the LOCK method MUST support the lockdiscovery property.6.5 Write Lock This section describes the semantics specific to the write access type for locks. The write lock is a specific instance of a lock type, and is the only lock type described in this specification. A DAV compliant resource MAY support the write lock.6.1.5.1 Methods Restricted by Write Locks A write lock prevents a principal without the lock from successfully executing a PUT, POST,PATCH,PROPPATCH, LOCK, UNLOCK, MOVE, DELETE, MKCOL, ADDREF or DELREF on the locked resource. All other current methods, GET in particular, function independent of the lock. Note, however, that as new methods are created it will be necessary to specify how they interact with a write lock.6.2.5.2 Write Locks and Properties While those without a write lock may not alter a property on a resource it is still possible for the values of live properties to change, even while locked, due to the requirements of their schemas. Only dead properties and live properties defined to respect locks are guaranteed not to change while write locked.6.3.5.3 Write Locks and Null Resources It is possible to assert a write lock on a null resource in order to lock the name.Please note, however, that lockingA write locked null resource acts in all ways as a null resourceeffectively makesother than it MUST respond to a PROPFIND request and MUST support theresource non-null,lockdiscovery and supportedlock properties. Until a method such as PUT or MKCOL is executed, the resourcenow has lock related properties defined on it.stays in the null state with the exception of the behavior stated above. If the resource is unlocked without a PUT, MKCOL, or similar method having been executed, the resource is no longer required to support the PROPFIND method or the lockdiscovery and supportedlock properties. Goland et al. [Page 18] INTERNET-DRAFT WebDAVNovember 19, 1997 6.4.January 18, 1998 5.4 Write Locks and Collections A write lock on a collection prevents the addition or removal of members of thecollection.collection by non-lock owners. As a consequence, when a principal issues a request to create a new internal member of a write locked collection using PUT or POST, or to remove an existing internal member of a write locked collection using DELETE, this request MUST fail if the principal does not have a write lock on the collection. However, if a write lock request is issued to a collection containing internal member resources that are currently locked in a manner which conflicts with the write lock, the request MUST fail with a409 Conflict425 Locked status code.6.5. Write Locks and COPY/MOVE The owner ofIf awritelockMUST NOT executeowner causes aMOVE method onresource to be added as an internal member of a locked collection then the new resourcehe has locked.is automatically added to the lock. Thisspecification intentionally does not define what happens if a MOVE method requestismade onthe only mechanism that allows alockedresourceby the lock's owner. Ato be added to a write lock. Thus, for example, if the collection /a/b/ is write locked and the resource /c is moved to /a/b/c then /a/b/c will be added to the write lock. 5.5 Write Locks and COPY/MOVE A COPY method invocation MUST NOT duplicate any write locks active on the source.6.6. Re-issuing Write Locks If a principal already owns a write lock onHowever, as previously noted, if the COPY copies the resource into aresource, any future requests forcollection that is depth locked then thesame type of write lock, onresource will be added to thesame resource, whilelock. A MOVE does not move theprincipal's previouswrite lockis in effect, MUST result in a successful responsewith thesame lock token as provided for the currently existing lock. Two lock requestsresource. There aredefinedtwo exceptions tobe identicalthis rule. First, as noted in section 5.4, iftheir Lock-Info headers are identical. 6.7. Write Locks and The Lock-Token Request Header If a user agent is not required to have knowledge aboutthe MOVE makes the resource alock when requesting an operation onchild of a collection that is depth lockedresource,then thefollowing scenario might occur. Program A, run by User A, takes outresource will be under the same lock. Second, if awrite lock ondepth locked resource is moved to aresource. Program B, also run by User A, has no knowledgedestination that is within the scope of the same depth locktaken out(e.g., within the namespace tree covered byProgram A, yet performsthe lock), the moved resource is still aPUT tomember of thelocked resource.lock. Inthis scenario, the PUT succeeds because locks are associated withboth cases aprincipal, notLock-Token header MUST be submitted containing aprogram, and thus program B, because it is acting with principal A's credential, is allowed to performlock token for thePUT. However, had program B known aboutlock on thelock, it would not have overwrittensource, if locked, and on theresource, preferring instead to presentdestination. 5.6 Refreshing Write Locks A client MUST NOT submit the same write lock request twice. Note that adialog box describingclient is always aware it is resubmitting theconflict tosame lock request because it must include theuser. DueLock-Token header in order tothis scenario,make the request for amechanismresource that isneededalready locked. However, a client MAY submit a LOCK method with a Lock-Token header but without a body. This form of LOCK MAY only be used toprevent different programs from accidentally ignoring locks taken out by other programs"refresh" a lock. Currently, refreshing a lock only means that any timers associated with thesame authorization.lock are re-set. Goland et al. [Page 19] INTERNET-DRAFT WebDAVNovember 19, 1997 In order to prevent these collisions the lock token requestJanuary 18, 1998 A server MAY return a Timeout header with a lock refresh that isintroduced. Please refer todifferent than theLock Token Request Header section for details and requirements. 6.7.1. Write Lock Token Example COPY /~fielding/index.html HTTP/1.1 Host: www.ics.uci.edu Destination: http://www.ics.uci.edu/users/f/fielding/index.html Lock-Token: <opaquelocktoken:123AbcEfg1284h23h2> <opaquelocktoken:AAAASDFcalkjfdas12312> HTTP/1.1 200 OK In this example, bothTimeout header returned when thesource and destination are locked so twolocktokens must be submitted. If only onewas originally requested. Additionally clients MAY submit Timeout headers of arbitrary value with their lock refresh requests. Servers, as always, MAY ignore Timeout headers submitted by thetwo resources was locked, then only one token would haveclient. If an error is received in response tobe submitted. 7. Notational Conventions Since this document describesaset of extensions to the HTTP/1.1 protocol, the augmented BNF used herein to describe protocol elements is exactlyrefresh LOCK request thesame as described in Section 2.1 of RFC 2068, _Hypertext Transfer Protocol -- HTTP/1.1_ [Fielding et al., 1997]. Since this augmented BNF usesclient MUST assume that thebasic production rules provided in Section 2.2 of RFC 2068, these rules apply to this document as well. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", SHOULD NOT", "RECOMMENDED", "MAY",lock was not refreshed. 5.7 Write Locks and"OPTIONAL" in this document are to be interpreted as described in RFC 2119 [Bradner, 1997]. 8. HTTP Methods for Distributed Authoring 8.1. PROPFINDThePROPFIND method retrieves properties defined on the Request-URI, if itLock-Token Request Header If a user agent is not required to have knowledge about anon-collection resource, orlock when requesting an operation onthe Request-URI and potentially its member resources, if the resource isacollection. All DAV compliant resources MUST supportlocked resource, thePROPFIND method. A client MAY submit a Depth header withfollowing scenario might occur. Program A, run by User A, takes out aPROPFINDwrite lock on acollection with a valueresource. Program B, also run by User A, has no knowledge of"0", "1" or "infinity". DAV compliant servers MUST supportthe"0", "1" and "infinity" behaviors. By default, the PROPFIND method onlock taken out by Program A, yet performs acollection withoutPUT to the locked resource. In this scenario, the PUT succeeds because locks are associated with aDepth header MUST act as ifprincipal, not aDepth = infinity header was included. INTERNET-DRAFT WebDAV November 19, 1997 A client MUST submit a Propfind request header describing what informationprogram, and thus program B, because it isbeing requested. Itacting with principal A's credential, ispossibleallowed torequest particular property values, all property values, or a list of the names ofperform theresource's properties. The response is a text/xml message body that contains a multistatus XML element that describesPUT. However, had program B known about theresults oflock, it would not have overwritten theattemptsresource, preferring instead toretrieve the various properties. If a property was successfully retrieved then its value MUST be returned inpresent aprop XML element. Ifdialog box describing thescope of PROPFIND covers more thanconflict to the user. Due to this scenario, asingle resource, asmechanism isthe caseneeded to prevent different programs from accidentally ignoring locks taken out by other programs withDepth values of "1" and "infinity", each response XML element MUST contain an href XML element which identifiestheresource on whichsame authorization. In order to prevent these collisions thepropertiesLock-Token request header, defined inthe prop XML element are defined.Section 8.7, is introduced. 5.7.1 Write Lock Token Example >>Request COPY /~fielding/index.html HTTP/1.1 Host: www.ics.uci.edu Destination: http://www.ics.uci.edu/users/f/fielding/index.html Lock-Token: <opaquelocktoken:f81d4fae-7dec-11d0-a765-00a0c91e6bf6> Authorization: Digest username="fielding", realm="fielding@ics.uci.edu", nonce="...", uri="/~fielding/index.html", response="...", opaque="..." >>Response HTTP/1.1 204 No Content In this example, even though both thecase of allpropsource andpropname, if a principal does not havedestination are locked, only one lock token must be submitted, for therightlock on the destination. This is due toknow ifthe source resource not being modified during aparticular property exists, an error MUST NOT be returned. The results of this method SHOULD NOT be cached. 8.1.1. Example: Retrieving Named Properties PROPFIND /files/ HTTP/1.1 Host: www.foo.bar Depth: 0 Propfind: <http://www.foo.bar/boxschema/bigbox> <http://www.foo.bar/ boxschema/author> <http://www.foo.bar/boxschema/DingALing> <http://w ww.foo.bar/boxschema/Random> HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx <?XML version="1.0"> <?namespace href ="http://www.ietf.org/standards/dav/" AS = "D"?> <?namespace href = "http://www.foo.bar/boxschema" AS = R"?> <D:multistatus> <D:response> <D:prop> <R:bigbox> <R:BoxType>Box type A</R:BoxType> </R:bigbox> <R:author> <R:Name>J.J. Dingleheimerschmidt</R:Name> </R:author> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:response> <D:response> <D:prop><R:DingALing/><R:Random/></D:prop> <D:status>HTTP/1.1 403 Forbidden</D:status> <D:responsedescription> The user does not have access toCOPY, and hence unaffected by theDingALing property. </D:responsedescription> </D:response>write lock. The Goland et al. [Page 20] INTERNET-DRAFT WebDAVNovember 19, 1997 <D:responsedescription> There has been an access violation error. </D:responsedescription> </D:multistatus> In this example, PROPFIND is executed onJanuary 18, 1998 Authorization header provides thecollection http://www.foo.bar/files/. The specified depth is zero, henceDigest authentication credentials for thePROPFIND applies only toprincipal making thecollection itself,request (note that the nonce, response, and opaque fields have notto any of its members.been calculated for this example). ThePropfind header specifiessource and thename of four properties whose valuesdestination resources arebeing requested. In this caseboth located within the same authentication realm, therefore onlytwo properties were returned, sinceone set of Authorization credentials needs to be submitted. 6 Notational Conventions Since this document describes a set of extensions to theprincipal issuingHTTP/1.1 protocol, therequest did not have sufficient access rightsaugmented BNF used herein toseedescribe protocol elements is exactly thethird and fourth properties. 8.1.2. Example: Using allpropsame as described in Section 2.1 of [Fielding et al., 1997]. Since this augmented BNF uses the basic production rules provided in Section 2.2 of [Fielding et al., 1997], these rules apply toRetrieve All Properties PROPFIND /container/ HTTP/1.1 Host: www.foo.bar Depth: 1 Propfind: allprop HTTP/1.1 200 OK Content-Type: text/xml Content-Length: xxxxx <?XML version="1.0"> <?namespace href = "http://www.ietf.org/standards/dav/" As = "S"?> <?namespace href = "http://www.foo.bar/boxschema/" AS = R"?> <S:multistatus> <S:response> <S:href>http://www.foo.bar/container/</S:href> <S:prop> <R:bigbox> <R:BoxType>Box type A</R:BoxType> </R:bigbox> <R:author> <R:Name>Hadrian</R:Name> </R:author> </S:prop> <S:status>HTTP 1.1 200 OK</S:status> </S:response> <S:response> <S:href>http://www.foo.bar/container/index.html</S:href> <S:prop> <R:bigbox> <R:BoxType>Box type B</R:BoxType> </R:bigbox> </S:prop> <S:status>HTTP 1.1 200 OK</S:status> </S:response> </S:multistatus> INTERNET-DRAFT WebDAV November 19, 1997 Inthisexample,document as well. 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 RFC 2119 [Bradner, 1997]. 7 HTTP Methods for Distributed Authoring 7.1 PROPFINDwas invokedThe PROPFIND method retrieves properties defined on the Request-URI, if the resource does not have any internal members, or on the Request-URI and potentially its member resources, if the resource does have internal members. All DAV compliant resources MUST support the PROPFIND method. A client MAY submit a Depth header with a value of "0", "1", or "infinity" with a PROPFIND on a resourcehttp://www.foo.bar/container/with internal members. DAV compliant servers MUST support the "0", "1" and "infinity" behaviors. By default, the PROPFIND method without a Depth header MUST act as if a "Depth: infinity" header was included. A client MAY submit a propfind XML element in the body of1, meaningthe requestappliesmethod describing what information is being requested. It is possible tothe resource and its children, andrequest particular property values, all property values, or aPropfind headerlist of the names of"allprop", meaningthe resource's properties. A client MAY choose not to submit a requestshould returnbody. An empty request body MUST be treated as a request for thenamenames andvaluevalues of allproperties defined on each resource.properties. Theresource http://www.foo.bar/container/ has two properties defined on it, named http://www.foo.bar/boxschema/bigbox,response is a text/xml message body that contains a multistatus XML element that describes the results of the attempts to retrieve the various properties. If a property was successfully retrieved then its value MUST be returned in a prop XML element. Goland et al. [Page 21] INTERNET-DRAFT WebDAV January 18, 1998 If there is an error retrieving a property then a proper error result must be included. Requests to retrieve the value of a property which does not exist is an error andhttp://www.foo.bar/boxschema/author, whileMUST be noted with a response XML element which contains a 404 Not Found status value. Consequently, the multistatus XML element for a resourcehttp://www.foo.bar/container/index.html has onlywith members MUST include asingleresponse XML element for each member of the resource, to whatever depth was requested. Each response XML element MUST contain an href XML element that identifies the resourcedefinedonit, named http://www.foo.bar/boxschema/bigbox, another instancewhich the properties in the prop XML element are defined. Results for a PROPFIND on a resource with internal members are returned as a flat list whose order of entries is not significant. In the"bigbox"case of allprop and propname, if a principal does not have the right to know if a particular propertytype. 8.1.3.exists then a 404 Not Found MUST be returned. The results of this method SHOULD NOT be cached. 7.1.1 Example:Using propname to Retrieve all Property NamesRetrieving Named Properties >>Request PROPFIND/container//files/ HTTP/1.1 Host: www.foo.barPropfind: propnameDepth: 0 Content-type: text/xml Content-Length: xyz <?xml version="1.0"?> <?namespace href ="http://www.iana.org/standards/dav/" as="D"?> <D:propfind> <D:href>http://www.foo.bar/boxschema/bigbox</D:href> <D:href>http://www.foo.bar/boxschema/author</D:href> <D:href>http://www.foo.bar/boxschema/DingALing</D:href> <D:href>http://www.foo.bar/boxschema/Random</D:href> </D:propfind> >>Response HTTP/1.1200 OK207 Multi-Status Content-Type: text/xml Content-Length:xxxx <?XML version="1.0">xxxxx <?xml version="1.0"?> <?namespace href= "http://www.ietf.org/standards/dav/" As = "D"?>="http://www.iana.org/standards/dav/" as="D"?> <?namespacehref = "http://www.foo.bar/boxschema/" AS = "R"?>href="http://www.foo.bar/boxschema" as="R"?> <D:multistatus> <D:response><D:href>http://www.foo.bar/container/</D:href><D:href>http://www.foo.bar/files/</D:href> <D:propstat> <D:prop><R:bigbox/> <R:author/> </D:prop> <D:status>HTTP 1.1 200 OK</D:status> </D:response> <D:response> <D:href>http://www.foo.bar/container/index.html</D:href> <D:prop> <R:bigbox/>Goland et al. [Page 22] INTERNET-DRAFT WebDAV January 18, 1998 <R:bigbox> <R:BoxType>Box type A</R:BoxType> </R:bigbox> <R:author> <R:Name>J.J. Johnson</R:Name> </R:author> </D:prop><D:status>HTTP 1.1<D:status>HTTP/1.1 200 OK</D:status> </D:propstat> <D:propstat> <D:prop><R:DingALing/><R:Random/></D:prop> <D:status>HTTP/1.1 403 Forbidden</D:status> <D:responsedescription> The user does not have access to the DingALing property. </D:responsedescription> </D:propstat> </D:response> <D:responsedescription> There has been an access violation error. </D:responsedescription> </D:multistatus> In this example, PROPFIND isinvokedexecuted on the collectionresource http://www.foo.bar/container/, with a Propfind header sethttp://www.foo.bar/files/. The specified depth is zero, hence the PROPFIND applies only to"propname", meaningthenamecollection itself, and not to any ofall properties should be returned. Since no depth header is present, it assumesitsdefault value of "infinity", meaningmembers. The propfind XML element specifies the name ofthefour propertiesonwhose values are being requested. In this case only two properties were returned, since thecollectionprincipal issuing the request did not have sufficient access rights to see the third andall its progeny should be returned.fourth properties. 7.1.2 Example: Using allprop to Retrieve All Properties >>Request PROPFIND /container/ HTTP/1.1 Host: www.foo.bar Depth: 1 Content-Type: text/xml Content-Length: xxxxx <?xml version="1.0"?> <?namespace href ="http://www.iana.org/standards/dav/" as="D"?> <D:propfind> <D:allprop/> </D:propfind> >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx Goland et al. [Page 23] INTERNET-DRAFT WebDAVNovember 19, 1997 Consistent with the previous example,January 18, 1998 <?xml version="1.0"?> <?namespace href="http://www.iana.org/standards/dav/" as="S"?> <?namespace href="http://www.foo.bar/boxschema/" as="R"?> <S:multistatus> <S:response> <S:href>http://www.foo.bar/container/</S:href> <S:propstat> <S:prop> <R:bigbox> <R:BoxType>Box type A</R:BoxType> </R:bigbox> <R:author> <R:Name>Hadrian</R:Name> </R:author> <S:creationdate> 1997-12-01T17:42:21-08:00 </S:creationdate> <S:displayname> Example collection </S:displayname> <S:externalmembers> <S:href>http://www.acme.com/front/</S:href> </S:externalmembers> <S:resourcetype><S:collection/></S:resourcetype> <S:supportedlock> <S:lockentry> <S:exclusive/><S:write/> </S:lockentry> <S:lockentry> <S:shared/><S:write/> </S:lockentry> </S:supportedlock> </S:prop> <S:status>HTTP 1.1 200 OK</S:status> </S:propstat> </S:response> <S:response> <S:href>http://www.foo.bar/container/front.html</S:href> <S:propstat> <S:prop> <R:bigbox> <R:BoxType>Box type B</R:BoxType> </R:bigbox> <S:creationdate> 1997-12-01T18:27:21-08:00 </S:creationdate> <S:displayname> Example HTML resourcehttp://www.foo.bar/container/ has two properties defined</S:displayname> <S:getcontentlength> 4525 </S:getcontentlength> Goland et al. [Page 24] INTERNET-DRAFT WebDAV January 18, 1998 <S:getcontenttype> text/html </S:getcontenttype> <S:getetag> zzyzx </S:getetag> <S:getlastmodified> Monday, 12-Jan-98 09:25:56 GMT </S:getlastmodified> <S:resourcetype/> <S:supportedlock> <S:lockentry> <S:exclusive/><S:write/> </S:lockentry> <S:lockentry> <S:shared/><S:write/> </S:lockentry> </S:supportedlock> </S:prop> <S:status>HTTP 1.1 200 OK</S:status> </S:propstat> </S:response> </S:multistatus> In this example, PROPFIND was invoked onit, http://www.foo.bar/boxschema/bigbox, and http://www.foo.bar/boxschema/author. Thethe resourcehttp://www.foo.bar/container/index.html,http://www.foo.bar/container/ with amemberDepth header ofthe "container" collection, has only one property defined on it, http://www.foo.bar/boxschema/bigbox. 8.2. PROPPATCH The PROPPATCH method processes instructions specified in1, meaning the requestbodyapplies toset and/or remove properties defined onthe resourceidentified by Request-URI. All DAV compliant resources MUST support the PROPPATCH methodandMUST process instructions that are specified using the propertyupdate, set,its children, andremove XML elements of the DAV schema. Execution of the directives in this method is, of course, subject to access control constraints. DAV compliant resources MUST support the setting of arbitrary dead properties. The request message body ofaPROPPATCH method MUST contain at least one propertyupdatepropfind XMLelement. Instruction processing MUST occur inelement containing theorder instructions are received (i.e., from top to bottom), and MUST be performed atomically. 8.2.1. propertyupdateallprop XMLelement Name: propertyupdate Namespace: http://www.ietf.org/standards/dav/ Purpose: To contain aelement, meaning the requestto altershould return the name and value of all properties defined onaeach resource.Parent: None Values= 1*(set | remove) Description: This XML element is a container for the information required to modify theThe resource http://www.foo.bar/container/ has seven properties defined onthe resource. This XML elementit, named http://www.foo.bar/boxschema/bigbox, http://www.foo.bar/boxschema/author, http://www.iana.org/standards/dav/creationdate, http://www.iana.org/standards/dav/displayname, http://www.iana.org/standards/dav/externalmembers, http://www.iana.org/standards/dav/resourcetype, and http://www.iana.org/standards/dav/supportedlock. The last five properties are WebDAV-specific, defined in Section 12. Since GET ismulti-valued. 8.2.2. set XML element Name: set Namespace: http://www.ietf.org/standards/dav/ Purpose: To setnot supported on this resource, theDAVget-* propertiesspecified inside the set XML element. Parent: propertyupdate Values= prop Description: This XML element MUST contain only a prop XML element.(e.g., get- content-length) are not defined on this resource. Theelements contained by prop specify the name and value ofDAV-specific properties assert thatare set"container" was created onthe Request-URI. IfDecember 1, 1997, at 5:42:21PM, in aproperty already exists then its value is replaced. INTERNET-DRAFT WebDAV November 19, 1997 8.2.3. remove XML element Name: remove Namespace: http://www.ietf.org/standards/dav/ Purpose: To remove the DAV properties specified inside the remove XML element. Parent: propertyupdate Values= prop Description: Remove specifies that the properties specified in prop should be removed. Specifying the removaltime zone 8 hours west of GMT (creationdate), has a name of "Example collection" (displayname), a single external member resource, http://www.acme.com/front/ (externalmembers), a collection resource type (resourcetype), and supports exclusive write and shared write locks (supportedlock). The resource http://www.foo.bar/container/front.html has nine properties defined on it, named http://www.foo.bar/boxschema/bigbox (another instance of the "bigbox" property type), Goland et al. [Page 25] INTERNET-DRAFT WebDAV January 18, 1998 http://www.iana.org/standards/dav/creationdate, http://www.iana.org/standards/dav/displayname, http://www.iana.org/standards/dav/getcontentlength, http://www.iana.org/standards/dav/getcontenttype, http://www.iana.org/standards/dav/getetag, http://www.iana.org/standards/dav/getlastmodified, http://www.iana.org/standards/dav/resourcetype, and http://www.iana.org/standards/dav/supportedlock. The DAV-specific properties assert thatdoes not exist is not an error. All the elements"front.html" was created on December 1, 1997, at 6:27:21PM, inprop MUST be empty, as only the namesa time zone 8 hours west ofproperties to be removed are required. 8.2.4. Response Codes 200 OK - The command succeeded. As there can beGMT (creationdate), has amixturename ofsets and removes in"Example HTML resource" (displayname), abody,content length of 4525 (getcontentlength), a201 Create seems inappropriate. 403 Forbidden - The client, for reasons the server chooses not to specify, cannot alter oneMIME type ofthe properties. 405 Conflict - The client"text/html" (getcontenttype), an entity tag of "zzyzx" (getetag), was last modified on Monday, January 12, 1998, at 09:25:56 GMT (getlastmodified), hasprovided a value whose semantics arean undefined resource type, meaning that it is notappropriate for the property. This includes trying to set read- only properties. 413 Request Entity Too Long - Ifaparticular property is too longcollection (resourcetype), and supports both exclusive write and shared write locks (supportedlock). 7.1.3 Example: Using propname tobe recorded then a composite XML error will be returned indicating the offending property. 8.2.5. Example PROPPATCH /bar.htmlRetrieve all Property Names >>Request PROPFIND /container/ HTTP/1.1 Host:www.foo.comwww.foo.bar Content-Type: text/xml Content-Length:xxxx <?XML version="1.0">xxxxx <?xml version="1.0"?> <?namespace href= "http://www.ietf.org/standards/dav/" AS = "D"?>="http://www.iana.org/standards/dav/" as="D"?> <D:propfind> <D:propname/> </D:propfind> >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxx <?xml version="1.0"?> <?namespacehref = "http://www.w3.com/standards/z39.50/" AS = "Z"?> <D:propertyupdate> <D:set> <D:prop> <Z:authors> <Z:Author>Jim Whitehead</Z:Author> <Z:Author>Roy Fielding</Z:Author> </Z:authors> </D:prop> </D:set> <D:remove> <D:prop><Z:Copyright-Owner/></D:prop> </D:remove> </D:propertyupdate> INTERNET-DRAFT WebDAV November 19, 1997 HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx <?XML version="1.0"> <?namespace href="http://www.ietf.org/standards/dav/" AS = "D"?>href="http://www.iana.org/standards/dav/" as="D"?> <?namespacehref="http://www.w3.com/standards/z39.50/" AS = "Z"?>href="http://www.foo.bar/boxschema/" as="R"?> <D:multistatus> <D:response><D:prop><Z:Authors/></D:prop> <D:status>HTTP/1.1 420 Method Failure</D:status><D:href>http://www.foo.bar/container/</D:href> <D:propstat> <D:prop> <R:bigbox/> <R:author/> <D:creationdate/> <D:displayname/> <D:externalmembers/> Goland et al. [Page 26] INTERNET-DRAFT WebDAV January 18, 1998 <D:resourcetype/> <D:supportedlock/> </D:prop> <D:status>HTTP 1.1 200 OK</D:status> </D:propstat> </D:response> <D:response><D:prop><Z:Copyright-Owner/></D:prop> <D:status>HTTP/1.1 409 Conflict</D:status><D:href>http://www.foo.bar/container/front.html</D:href> <D:propstat> <D:prop> <R:bigbox/> <D:creationdate/> <D:displayname/> <D:get-content-length/> <D:get-content-type/> <D:get-etag/> <D:get-last-modified/> <D:resourcetype/> <D:supportedlock/> </D:prop> <D:status>HTTP 1.1 200 OK</D:status> </D:propstat> </D:response><D:responsedescription> Copyright Owner can not be deleted or altered.</D:responsedescription></D:multistatus> In this example, PROPFIND is invoked on theclient requestscollection resource http://www.foo.bar/container/, with a propfind XML element containing theserver to setpropname XML element, meaning the name of all properties should be returned. Since no depth header is present, it assumes its default value of "infinity", meaning thehttp://www.w3.com/standards/z39.50/Authors property, and to removename of theproperty http://www.w3.com/standards/z39.50/Copyright- Owner. Sinceproperties on theCopyright-Owner property could notcollection and all its progeny should beremoved, no property modifications occur. The Method Failure response code for the Authors property indicates this action would have succeeded if it were not for the conflictreturned. Consistent withremovingtheCopyright-Owner property. 8.3. MKCOL Methodprevious example, resource http://www.foo.bar/container/ has seven properties defined on it, http://www.foo.bar/boxschema/bigbox, and http://www.foo.bar/boxschema/author, http://www.iana.org/standards/dav/creationdate, http://www.iana.org/standards/dav/displayname, http://www.iana.org/standards/dav/externalmembers, http://www.iana.org/standards/dav/resourcetype, and http://www.iana.org/standards/dav/supportedlock. TheMKCOLresource http://www.foo.bar/container/index.html, a member of the "container" collection, has nine properties defined on it, http://www.foo.bar/boxschema/bigbox, http://www.iana.org/standards/dav/creationdate, http://www.iana.org/standards/dav/displayname, http://www.iana.org/standards/dav/get-content-length, http://www.iana.org/standards/dav/get-content-type, http://www.iana.org/standards/dav/get-etag, http://www.iana.org/standards/dav/get-last-modified, Goland et al. [Page 27] INTERNET-DRAFT WebDAV January 18, 1998 http://www.iana.org/standards/dav/resourcetype, and http://www.iana.org/standards/dav/supportedlock. 7.2 PROPPATCH The PROPPATCH methodis usedprocesses instructions specified in the request body tocreate a new collection.set and/or remove properties defined on the resource identified by Request-URI. All DAV compliant resources MUST support theMKCOL method. 8.3.1. Request MKCOL creates a new collection resource at the locationPROPPATCH method and MUST process instructions that are specifiedby the Request-URI. Ifusing theRequest-URI exists, then MKCOL must fail. During MKCOL processing, a server MUST makepropertyupdate, set, and remove XML elements of theRequest-URI a memberDAV schema. Execution ofits parent collection. If no such ancestor exists,the directives in this methodMUST fail. Whenis, of course, subject to access control constraints. DAV compliant resources SHOULD support theMKCOL operation createssetting of arbitrary dead properties. The request message body of anew collection resource, all ancestorsPROPPATCH method MUSTalready exist, orcontain at least one propertyupdate XML element. Instruction processing MUST occur in themethodorder instructions are received (i.e., from top to bottom). Instructions MUSTfail with a 409 Conflict status code. For example,either all be executed or none executed. Thus ifa request to create collection /a/b/c/d/ is made,any error occurs during processing all executed instructions MUST be undone andneither /a/b/ nor /a/b/c/ exists,a proper error result returned. Instruction processing details can be found in therequest MUST fail. When MKCOLdefinition of the set and remove instructions in Section 11.13. If PROPPATCH is invokedwithouton arequest body, the newly created collection has no members. INTERNET-DRAFT WebDAV November 19, 1997 A MKCOL request message MAY containnull resource (e.g., amessage body.deleted resource), an empty resource is created, and the PROPPATCH directives are performed on this new resource. 7.2.1 Status Codes 200 OK - Thebehaviorcommand succeeded. As there can be a mixture of sets and removes in aMKCOL request whenbody, a 201 Created seems inappropriate. 403 Forbidden - The client, for reasons thebody is present is limitedserver chooses not tocreating collections, membersspecify, cannot alter one ofa collection, bodies of members and properties onthecollections or members. If the server receivesproperties. 409 Conflict - The client has provided aMKCOL request entity type it doesvalue whose semantics are notsupport or understand it MUST respond with a 415 Unsupported Media Type status code. The exact behavior of MKCOLappropriate forvarious request media typesthe property. This includes trying to set read- only properties. 413 Request Entity Too Long - If a particular property isundefined in this document, and willtoo long to bespecified in separate documents. 8.3.2. Response Codes Responses fromrecorded then aMKCOL request arecomposite XML error will be returned indicating the offending property. 7.2.2 Example >>Request PROPPATCH /bar.html HTTP/1.1 Host: www.foo.com Goland et al. [Page 28] INTERNET-DRAFT WebDAV January 18, 1998 Content-Type: text/xml Content-Length: xxxx <?xml version="1.0"?> <?namespace href="http://www.iana.org/standards/dav/" as="D"?> <?namespace href="http://www.w3.com/standards/z39.50/" as="Z"?> <D:propertyupdate> <D:set> <D:prop> <Z:authors> <Z:Author>Jim Whitehead</Z:Author> <Z:Author>Roy Fielding</Z:Author> </Z:authors> </D:prop> </D:set> <D:remove> <D:prop><Z:Copyright-Owner/></D:prop> </D:remove> </D:propertyupdate> >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx <?xml version="1.0"?> <?namespace href="http://www.iana.org/standards/dav/" as="D"?> <?namespace href="http://www.w3.com/standards/z39.50/" as="Z"?> <D:multistatus> <D:response> <D:href>http://www.foo.com/bar</D:href> <D:propstat> <D:prop><Z:Authors/></D:prop> <D:status>HTTP/1.1 424 Method Failure</D:status> </D:propstat> <D:propstat> <D:prop><Z:Copyright-Owner/></D:prop> <D:status>HTTP/1.1 409 Conflict</D:status> </D:propstat> <D:responsedescription> Copyright Owner can notcacheable, since MKCOL has non-idempotent semantics. 201 Created - The collectionbe deleted orstructured resource was created in its entirety. 403 Forbidden - This indicates at least one of two conditions: 1) Thealtered.</D:responsedescription> <D:response> </D:multistatus> In this example, the client requests the serverdoes not allowto set thecreationvalue ofcollections atthegiven location in its namespace,http://www.w3.com/standards/z39.50/Authors property, and2) The parent collection ofto remove theRequest-URI exists but cannot accept members. 405 Method Not Allowed - MKCOL can onlyproperty http://www.w3.com/standards/z39.50/Copyright- Owner. Since the Copyright-Owner property could not beexecuted on a deleted/non-existent resource. 409 Conflict - A collection cannot be made at the Request-URI until one or more intermediate collections have been created. 415 Unsupported Media Type-removed, no property modifications occur. Theserver does not support the request type ofMethod Failure status code for thebody. 419 Insufficient Space on Resource - The resource does notAuthors property indicates this action would havesufficient space to record the state of the resource aftersucceeded if Goland et al. [Page 29] INTERNET-DRAFT WebDAV January 18, 1998 it were not for theexecution of this method. 8.3.3. Example This example creates a collection called /webdisc/xfiles/ onconflict with removing theserver www.server.org.Copyright-Owner property. 7.3 MKCOL/webdisc/xfiles/ HTTP/1.1 Host: www.server.org HTTP/1.1 201 Created 8.4. INDEXMethod TheINDEXMKCOL method is used toenumerate the members ofcreate aresource.new collection. All DAV compliant resources MUST support theINDEX method if they have members. INTERNET-DRAFT WebDAV November 19, 1997 8.4.1. TheMKCOL method. 7.3.1 RequestForMKCOL creates acollection, INDEXnew collection resource at the location specified by the Request-URI. If the resource identified by the Request-URI is non-null then the MKCOL must fail. During MKCOL processing, a server MUSTreturnmake the Request-URI alistmember of itsmembers. All WebDAV compliant resourcesparent collection. If no such ancestor exists, the method MUSTsupportfail. When thetext/xml response entity described below. The INDEX result forMKCOL operation creates a new collectionMAY also return a list ofresource, all ancestors MUST already exist, or themembers of child collections, to any depth. Collections that respond to an INDEXmethodwith a text/xml entityMUSTcontainfail with asingle multistatus XML element which contains409 Conflict status code. For example, if aresponse XML element for each member. A resource that supports INDEX MUST returnrequest to create collection /a/b/c/d/ is made, and neither /a/b/ nor /a/b/c/ exists, theresourcetype property for each member. Note thatrequest MUST fail. When MKCOL is invoked without a request body, theprop XML elementnewly created collection has no members. A MKCOL request message MAY containadditional properties. 8.4.2. Example INDEX /user/yarong/dav_drafts/ HTTP/1.1 Host: www.microsoft.com HTTP/1.1 200 OK Content-Type: text/xml Content-Length: xxx Last-Modified: Thu, 11 Sep 1997 23:45:12 GMT ETag: _fooyyybar_ <?XML version="1.0"> <?namespace href = _http://www.ietf.org/standards/dav/_ as = _D_?> <D:multistatus> <D:response> <D:href>http://www.microsoft.com/user/yarong/dav_drafts/ </D:href> <D:prop> <D:resourcetype> <D:collection/> </D:resourcetype> </D:prop> <D:status>HTTP 1.1 200 OK</D:status> </D:response> <D:response> <D:href> http://www.microsoft.com/user/yarong/dav_drafts/base </D:href> <D:prop> <D:resourcetype/> </D:prop> <D:status>HTTP 1.1 200 OK</D:status> </D:response> </D:multistatus> INTERNET-DRAFT WebDAV November 19, 1997 8.5. ADDREF Methoda message body. TheADDREF methodbehavior of a MKCOL request when the body isusedpresent is limited toadd externalcreating collections, memberstoof aresource. All DAV compliant collection resources MUST support the ADDREF method. All other DAV compliant resources MAY support the ADDREF method as appropriate. 8.5.1. The Request The ADDREF method adds the URI specified in the Collection-Member header as an external member to the collection specified bycollection, bodies of members and properties on theRequest-URI. The value incollections or members. If theCollection-Member headerserver receives a MKCOL request entity type it does not support or understand it MUSTbe an absolute URI meeting the requirementsrespond with a 415 Unsupported Media Type status code. The exact behavior ofan external member URI. ItMKCOL for various request media types isnot an error if the URIundefined in this document, and will be specified inthe Collection-Member header already exists as an external member of the collection. However, after processing the ADDREF there MUST be onlyseparate documents. 7.3.2 Response Codes Responses from a MKCOL request are not cacheable, since MKCOL has non-idempotent semantics. 201 Created - The collection or structured resource was created in its entirety. 403 Forbidden - This indicates at least oneinstanceof two conditions: 1) The server does not allow theURI in the collection. Ifcreation of collections at theURI specifiedgiven location in its namespace, and 2) The parent collection of theCollection-Member header alreadyRequest-URI existsas an internal member ofbut cannot accept members. 405 Method Not Allowed - MKCOL can only be executed on a deleted/non-existent resource. 409 Conflict - A collection cannot be made at thecollection,Request-URI until one or more intermediate collections have been created. Goland et al. [Page 30] INTERNET-DRAFT WebDAV January 18, 1998 415 Unsupported Media Type- The server does not support theADDREF method MUST fail with a 412 Precondition Failed status code. 8.5.2. Example ADDREF /~ejw/dav/ HTTP/1.1 Host: www.ics.uci.edu Collection-Member: http://www.ietf.org/standards/dav/ HTTP/1.1 200 OK This example addsrequest type of theURI http://www.ietf.org/standards/dav/ as an external memberbody. 423 Insufficient Space on Resource - The resource does not have sufficient space to record the state of the resource after the execution of this method. 7.3.3 Example This example creates a collectionhttp://www.ics.uci.edu/~ejw/dav/. 8.6. DELREFcalled /webdisc/xfiles/ on the server www.server.org. >>Request MKCOL /webdisc/xfiles/ HTTP/1.1 Host: www.server.org >>Response HTTP/1.1 201 Created 7.4 ADDREF Method TheDELREFADDREF method is used toremoveadd external membersfromto a resource. All DAV compliant collection resources MUST support theDELREFADDREF method. All other DAV compliant resourcesMUST support the DELREF method only if theyMAY support the ADDREFmethod. 8.6.1.method as appropriate. 7.4.1 The Request TheDELREFADDREF methodremovesadds the URI specified in the Collection-Member headerfromas an external member to the collection specified by the Request-URI.DELREFing a URI which is not a member of the collectionIt is not anerror. DELREFingerror if the URI specified in the Collection-Member header already exists as an external member of the collection. However, after processing the ADDREF there MUST be only one instance of the URI in the collection. If the URI specified in the Collection-Member header already exists as an internal member of the collection, the ADDREF method MUST fail with a 412 Precondition Failed status code. More than one Collection-Member request header MUST NOT be used with the ADDREF method. 7.4.2 Example >>Request ADDREF /~ejw/dav/ HTTP/1.1 Host: www.ics.uci.edu Goland et al. [Page 31] INTERNET-DRAFT WebDAVNovember 19, 1997 8.6.2.January 18, 1998 Collection-Member: http://www.iana.org/standards/dav/ >>Response HTTP/1.1 204 No Content This example adds the URI http://www.iana.org/standards/dav/ as an external member resource of the collection http://www.ics.uci.edu/~ejw/dav/. 7.5 DELREF Method The DELREF method is used to remove external members from a resource. All DAV compliant collection resources MUST support the DELREF method. All other DAV compliant resources MUST support the DELREF method only if they support the ADDREF method. 7.5.1 The Request The DELREF method removes the URI specified in the Collection-Member header from the collection specified by the Request-URI. DELREFing a URI which is not a member of the collection is not an error. DELREFing an internal member MUST fail with a 412 Precondition Failed status code. More than one Collection-Member request header MUST NOT be used with the DELREF method. 7.5.2 Example >>Request DELREF /~ejw/dav/ HTTP/1.1 Host: www.ics.udi.edu Collection-Member:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ >>Response HTTP/1.1200 OK204 No Content This example removes the URIhttp://www.ietf.org/standards/dav/,http://www.iana.org/standards/dav/, an external member resource, from the collection http://www.ics.uci.edu/~ejw/dav/.8.7.7.6 GET, HEAD for Collections Goland et al. [Page 32] INTERNET-DRAFT WebDAV January 18, 1998 The semantics of GET are unchanged when applied to a collection, since GET is defined as,_retrieve"retrieve whatever information (in the form of an entity) is identified by theRequest-URI_Request-URI" [Fielding et al., 1997]. GET when applied to a collection MAY return the contents of an_index.html_"index.html" resource, a human-readable view of the contents of the collection, or something elsealtogether, and hencealtogether. Hence it is possible that the result of a GET on a collection will bear no correlation to the state of the collection. Similarly, since the definition of HEAD is a GET without a response message body, the semantics of HEAD are unmodified when applied to collection resources.8.8.7.7 POST for Collections Since by definition the actual function performed by POST is determined by the server and often depends on the particular resource, the behavior of POST when applied to collections cannot be meaningfully modified because it is largely undefined. Thus the semantics of POST are unmodified when applied to a collection.8.9.7.8 DELETE8.9.1.7.8.1 DELETEMethodfor Non-Collection Resources If the DELETE method is issued to a non-collection resource which is an internal member of a collection, then during DELETE processing a server MUST remove the Request-URI from its parent collection. A server MAY remove the URI of a deleted resource from any collections of which the resource is an external member.8.9.2.7.8.2 DELETE for CollectionsINTERNET-DRAFT WebDAV November 19, 1997The DELETE method on a collection MUST act as if a Depth =Infinityinfinity header was used on it. A client MUST NOT submit a Depth header on a DELETE on a collection with any value butInfinity.infinity. DELETE instructs that the collection specified in the request-URI, the records of its external member resources, and all its internal member resources, are to be deleted. If any member cannot be deleted then all of the member'sprogenyancestors MUST NOT be deleted, so as to maintain the namespace. Any headers included with DELETE MUST be applied in processing every resource to be deleted.In this case, a header of special interest is the Destroy header, which specifies the method to be used to delete all resources in the scope of the DELETE.When the DELETE method has completed processing it MUST return a consistent namespace. Goland et al. [Page 33] INTERNET-DRAFT WebDAV January 18, 1998 The response SHOULD be a Multi-Status response that describes the result of the DELETE on each affected resource.8.9.2.1.7.8.2.1 Example >>Request DELETE /container/ HTTP/1.1 Host: www.foo.barDestroy: NoUndelete>>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx<?XML version="1.0"><?xml version="1.0"?> <?namespacehref = "http://www.ietf.org/standards/dav/" As = "d"?>href="http://www.iana.org/standards/dav/" as="d"?> <d:multistatus> <d:response> <d:href>http://www.foo.bar/container/resource1</d:href> <d:href>http://www.foo.bar/container/resource2</d:href> <d:status>HTTP/1.1 200 OK</d:status> </d:response> <d:response> <d:href>http://www.foo.bar/container/</d:href> <d:status>HTTP/1.1420424 Method Failure</d:status> </d:response> <d:response> <d:href>http://www.foo.bar/container/resource3</d:href> <d:status>HTTP/1.1412 Precondition Failed</d:status>425 Locked</d:status> </d:response> </d:multistatus>INTERNET-DRAFT WebDAV November 19, 1997In this example the attempt to delete http://www.foo.bar/container/resource3 failed becausethe serverit is locked, and no lock token wasunable to guarantee that resource3 would not be able to be undeleted.submitted with the request. Consequently, the attempt to delete http://www.foo.bar/container/ also failed, but resource1 and resource2 were deleted. Even though a Depth header has not been included, a depth of infinity is assumed because the method is on a collection. As this example illustrates, DELETE processing need not be atomic.8.10.7.9 PUT8.10.1.7.9.1 PUT for Non-Collection Resources A PUT performed on an existing resource replaces the GET response entity of the resource. Properties defined on the resource MAY be recomputed during PUTprocessing.processing but are not otherwise effected. For example, if a server recognizes the content type of the request Goland et al. [Page 34] INTERNET-DRAFT WebDAV January 18, 1998 body, it may be able to automatically extract information that could be profitably exposed as properties. A PUT that would result in the creation of a resource without an appropriately scoped parent collection MUST fail with a405 Method Not Allowed. 8.10.2.409 Conflict. 7.9.2 PUT for Collections As defined in the HTTP/1.1 specification [Fielding et al., 1997], the "PUT method requests that the enclosed entity be stored under the supplied Request-URI." Since submission of an entity representing a collection would implicitly encode creation and deletion of resources, this specification intentionally does not define a transmission format for creating a collection using PUT. Instead, the MKCOL method is defined to create collections. If a PUT is invoked on a collection resource it MUST fail. When the PUT operation creates a new non-collection resource all ancestors MUST already exist. If all ancestors do not exist, the method MUST fail with a 409 Conflict status code. For example, if resource /a/b/c/d.html is to be created and /a/b/c/ does not exist, then the request must fail.8.11.7.10 COPY Method The COPY method creates a duplicate of thespecified resource. All DAV compliant resourcessource resource, given by the Request-URI, in the destination resource, given by the Destination header. The Destination header MUSTsupportbe present. The exact behavior of the COPYmethod.method depends on the type of the source resource. Support for the COPY method does not guarantee the ability to copy a resource. For example, separate programs may control resources on the same server. As a result, it may not even be possible to copy a resource to a location that appears to be on the same server.INTERNET-DRAFT WebDAV November 19, 1997 8.11.1. The Request The COPY method creates a duplicate of the source resource, given by the Request-URI, in the destination resource, given by the Destination header. The Destination header MUST be present. The exact behavior of the COPY method depends on the type of the source resource. 8.11.1.1.7.10.1 COPY for HTTP/1.1 resources When the source resource is not a collection the body of the destination resource MUST be octet-for-octet identical to the body of the source resource.AlterationsSubsequent alterations to the destination resourcedowill not modify the source resource.AlterationsSubsequent alterations to the source resourcedowill not modify the destination resource. Thus, all copies are performed_by-value_."by-value". All properties on the source resource MUST be duplicated on the destination resource, subject to modifyingheaders,headers and XML elements, following the definition for copying properties.8.11.1.2.7.10.2 COPY for Properties Goland et al. [Page 35] INTERNET-DRAFT WebDAV January 18, 1998 The following section defines how properties on a resource are handled during a COPY operation. Live properties SHOULD be duplicated as identically behaving live properties at the destination resource.Since they are live properties, the server determines the syntax and semantics of these properties. Properties named by the Enforce-Live-Properties header MUST be live on the destination resource, or the method MUST fail.If a propertyis not named by Enforce-Live-Properties andcannot be copied live, then its value MUST be duplicated, octet-for-octet, in an identically named, dead property on the destination resource. The propertybehavior XML element can specify that properties are copied on best effort, that all live properties MUST be successfully copied or the method MUST fail, or that a specified list of live properties MUST be successfully copied or the method must fail. The propertybehavior XML element is defined in Section 11.12. If a property on the source already exists on the destination resource and the Overwrite header is set to "T" then the property at the destination MUST be overwritten with the property from the source. If the Overwrite header is "F" and the previous situation exists, then the COPY MUST fail with a409 Conflict. 8.11.1.3.412 Precondition Failed. 7.10.3 COPY for Collections The COPY method on a collection without a Depth header MUST act as if a Depth= infinityheader with value "infinity" was included. A client MAY submit a Depth header on a COPY on a collection with a value of "0" or "infinity". DAV compliant servers MUST support the "0" and "infinity" behaviors. A COPY of depth infinity instructs that the collection specified in theRequest-URI,Request-URI and the records of its external memberresources, and INTERNET-DRAFT WebDAV November 19, 1997 all its internal member resources, areresources is to be copied toathe location specified in the Destination header, and all its internal member resources are to be copied to a location relative to it, recursively through all levels of theDestination header.collection hierarchy. A COPY of depth "0" only instructs that the collection, the properties, and the records of its external members, not its internal members, are to be copied. Any headers included with a COPY are to be applied in processing every resource to be copied. The exception to this rule is the Destination header. This header only specifies the destination for the Request-URI. When applied to members of the collection specified in the request-URI the value of Destination is to be modified to reflect the current location in the hierarchy. So, if the request-URI is "a" and the destination is "b" then when a/c/d is processed it MUST use a destination of b/c/d. When the COPY method has completed processing it MUST have created a consistent namespace at the destination.ThusHowever, ifit is not possible to COPY a collection with internal members, thean error Goland et al. [Page 36] INTERNET-DRAFT WebDAV January 18, 1998 occurs while copying an internal member collection, all membersmay still be copied but aof this collectionwill haveMUST NOT be copied. In this case, after detecting the error, the COPY operation SHOULD try to finish as much of the original copy operation as possible. So, for example, if an infinite depth copy operation is performed on collection /a/, which contains collections /a/b/ and /a/c/, and an error occurs copying /a/b/, an attempt should still becreated atmade to copy /a/c/. Similarly, after encountering an error copying a non-collection resource as part of an infinite depth copy, thedestinationserver SHOULD try tocontain them.finish as much of the original copy operation as possible. The response is a Multi-Statusresponsestatus code with an entity body that describes the result of the COPY on each affected resource. The href XML element in the responseis given forrefers to the resource that was to be copied, not the resource that was created as a result of the copy. In other words, each entry indicates whether the copy on the resource specified in the href XML element succeeded or failed and why. The exception to this rule is for errors that occurred on the destination. For example, if the destination was locked the response would indicate the destination URL and a421 Destination425 Locked error.8.11.1.4.7.10.4 Type Interactions If the destination resource identifies a collection and the Overwrite header is_T_,"T", prior to performing the copy the server MUST perform a DELETE operation on the collection.8.11.2. Response7.10.5 Status Codes200 OK - The source resource was successfully copied to a pre- existing destination resource.201 Created - The source resource was successfully copied. The copy operation resulted in the creation of a new resource. 204 No Content - The source resource was successfully copied to a pre-existing destination resource. Since there is no entity body in the response, 204 No Content is used instead of 200 OK. 412 Precondition Failed - This status code MUST be returned if the server was unable to maintain the liveness of the properties listedINTERNET-DRAFT WebDAV November 19, 1997in theEnforce-Live-Properties header,propertybehavior XML element, or if the Overwrite header is "F", and the state of the destination resource is non-null.419423 Insufficient Space on Resource - The destination resource does not have sufficient space to record the state of the resource after the execution of this method.421 Destination425 Locked_- The destination resource was locked and either a valid Lock-Token header was not submitted, or theLock- TokenLock-Token header identifies a lock held by another principal.500 Server ErrorGoland et al. [Page 37] INTERNET-DRAFT WebDAV January 18, 1998 502 Bad Gateway -The resource was in such a state that it could not be copied.This may occurifwhen theDestination header specifies a resource thatdestination isoutside the namespaceon another server and theresource is abledestination server refuses tointeract with. 8.11.3.accept the resource. 7.10.6 Overwrite Example This example shows resource http://www.ics.uci.edu/~fielding/index.html being copied to the location http://www.ics.uci.edu/users/f/fielding/index.html. Thecontents of204 No Content status code indicates thedestinationexisting resourcewere overwritten, if non-null.at the destination was overwritten. >>Request COPY /~fielding/index.html HTTP/1.1 Host: www.ics.uci.edu Destination: http://www.ics.uci.edu/users/f/fielding/index.html >>Response HTTP/1.1200 OK 8.11.4.204 No Content 7.10.7 No Overwrite Example The following example shows the same copy operation being performed, except with the Overwrite header set to_F._"F." A response of 412 Precondition Failed is returned because the destination resource has a non-null state. >>Request COPY /~fielding/index.html HTTP/1.1 Host: www.ics.uci.edu Destination: http://www.ics.uci.edu/users/f/fielding/index.html Overwrite:_F_F >>Response HTTP/1.1 412 Precondition Failed8.11.5.7.10.8 Collection Example >>Request COPY /container/ HTTP/1.1 Host: www.foo.bar Destination: http://www.foo.bar/othercontainer/Enforce-Live-Properties: *Depth:Infinityinfinity Content-Type: text/xml Content-Length: xxxxx <?xml version="1.0"?> <?namespace href="http://www.iana.org/standards/dav/" as="d"?> Goland et al. [Page 38] INTERNET-DRAFT WebDAVNovember 19, 1997January 18, 1998 <d:propertybehavior> <d:keepalive>*</d:keepalive> </d:propertybehavior> >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx<?XML version="1.0"><?xml version="1.0"?> <?namespacehref = "http://www.ietf.org/standards/dav/" As = "d"?>href="http://www.iana.org/standards/dav/" as="d"?> <d:multistatus> <d:response> <d:href>http://www.foo.bar/othercontainer/resource1</d:href> <d:href>http://www.foo.bar/othercontainer/resource2</d:href> <d:href>http://www.foo.bar/othercontainer/</d:href><d:href>http://www.foo.bar/othercontainer/R2/D2</d:href><d:status>HTTP/1.1 201 Created</d:status> </d:response> <d:response> <d:href>http://www.foo.bar/othercontainer/R2/</d:href> <d:href>http://www.foo.bar/othercontainer/R2/D2</d:href> <d:status>HTTP/1.1 412 Precondition Failed</d:status> </d:response> </d:multistatus> The Depth header is unnecessary as the default behavior of COPY on a collection is to act as if a "Depth:Infinity"infinity" header had been submitted. In this example most of the resources, along with the collection, were copied successfully. However the collection R2 failed, most likely due to a problem withenforcing live properties.maintaining the liveness of properties (this is specified by the propertybehavior XML element). Since an error occurred copying R2, R2's member D2 wassuccessfullynot copied.As a result a collection was created at www.foo.bar/othercontainer/R2 to contain D2. 8.12.7.11 MOVE Method ThemoveMOVE operation on a non-collection resource is the logical equivalent of a copy (COPY) followed by a delete, where the actions are performed atomically. All DAV compliant resources MUST support the MOVE method. However, support for the MOVE method does not guarantee the ability to move a resource to a particular destination. For example, separate programs may actually control different sets of resources on the same server. Therefore, it may not even be possible to move a resource within a namespace that appears to belong to the same server.8.12.1. The RequestGoland et al. [Page 39] INTERNET-DRAFT WebDAV January 18, 1998 If a resource exists at the destination, the destination resource will be DELETEd as a side effect of the MOVE operation, subject to the restrictions of the Overwrite header.8.12.2.7.11.1 MOVE for Collections A MOVE of depth infinity instructs that the collection specified in the Request-URI, including the records of its external member resources, is to be moved to the location specified in the Destination header, and all its internalINTERNET-DRAFT WebDAV November 19, 1997memberresources,resources are to be moved toa locationlocations relative to it, recursively through all levels of theDestination header.collection hierarchy. The MOVE method on a collection MUST act as if a Depth "infinity" header was used on it. A client MUST NOT submit a Depth header on a MOVE on a collection with any value but "infinity". Any headers included with MOVE are to be applied in processing every resource to be moved. The exception to this rule is the Destination header. The behavior of this header is the same as given for COPY on collections. When the MOVE method has completed processing it MUST have created a consistent namespace on both the source anddestination, creatingdestination. However, if an error occurs while moving an internal member collection, all members of the failed collection MUST NOT be moved. In this case, after detecting the error, the move operation SHOULD try to finish as much of the original move as possible. So, for example, if an infinite depth move is performed on collection /a/, which contains collectionsat/a/b/ and /a/c/, and an error occurs moving /a/b/, an attempt should still be made to try moving /a/c/. Similarly, after encountering an error moving a non-collection resource as part of an infinite depth move, thesource or destinationserver SHOULD try to finish as much of the original move operation asnecessary.possible. As specified in the definition of MOVE, a MOVE of a collection over another collection causes the destination collection and all its members to be deleted. The response is a Multi-Status response that describes the result of the MOVE on eacheffectedaffected resource. The href XML element in the responseis given forrefers to the resource that was to be moved, not the resource that was created as a result of the move. In other words, each entry indicates whether the move on the resource specified in the href succeeded or failed and why. The exception to this rule is for errors that occurred on the destination. For example, if the destination was locked the response would indicate the destination URL and a421 Destination425 Locked error.8.12.3. Response7.11.2 Status Codes200 OK - The move operation was successful. 409 Conflict _Goland et al. [Page 40] INTERNET-DRAFT WebDAV January 18, 1998 201 Created - TheMOVEsource resource wasattempted onsuccessfully moved, and acollection with members. Whilenew resource was created at theCOPY part of thisdestination. 204 No Content - The move operationcould succeedwas successful, and theDELETE could not. Thereforeresource at theMOVE MUST fail.destination was overwritten. 412 Precondition Failed - This status code MUST be returned if the server was unable to maintain the liveness of the properties listed in theEnforce-Live-Properties header,propertybehavior XML element, or if the Overwrite header is "F", and the state of the destination resource is non-null.421 Destination425 Locked - The source or the destination resource was locked and either a valid Lock-Token header was not submitted, or the Lock- Token header identifies a lock held by another principal. 502 Bad Gateway - This may occur when the destination iso non another server and the destination server refuses to accept theresource INTERNET-DRAFT WebDAV November 19, 1997 8.12.4. Overwriteresource. 7.11.3 Non-Collection Example This example shows resource http://www.ics.uci.edu/~fielding/index.html being moved to the location http://www.ics.uci.edu/users/f/fielding/index.html. The contents of the destination resourcewere overwritten,would have been overwritten if the destination resource had been non-null. In this case, since there was nothing at the destination resource, the response code is 201 Created. >>Request MOVE /~fielding/index.html HTTP/1.1 Host: www.ics.uci.edu Destination: http://www.ics.uci.edu/users/f/fielding/index.html >>Response HTTP/1.1200 OK 8.12.5.201 Created Location: http://www.ics.uci.edu/users/f/fielding/index.html 7.11.4 Collection Example >>Request MOVE /container/ HTTP/1.1 Host: www.foo.bar Destination: http://www.foo.bar/othercontainer/Enforce-Live-Properties: *Overwrite:FalseF Lock-Token:<OpaqueLockToken:xxxx> <OpaqueLockToken:xxxx><opaquelocktoken:fe184f2e-6eec-41d0-c765-01adc56e6bb4>, <opaquelocktoken:e454f3f3-acdc-452a-56c7-00a5c91e4b77> Goland et al. [Page 41] INTERNET-DRAFT WebDAV January 18, 1998 Content-Type: text/xml Content-Length: xyz Authorization: Digest username="rohit", realm="rohit@www.foo.bar", nonce="...", uri="/container/", response="...", opaque="..." <?xml version="1.0"?> <?namespace href="http://www.iana.org/standards/dav/" as="d"?> <d:propertybehavior> <d:keepalive>*</d:keepalive> </d:propertybehavior> >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length:xxxxx <?XML version="1.0">zzz <?xml version="1.0"?> <?namespacehref = "http://www.ietf.org/standards/dav/" As = "D"?>href="http://www.iana.org/standards/dav/" as="d"?> <d:multistatus> <d:response> <d:href>http://www.foo.bar/container/resource1</d:href> <d:href>http://www.foo.bar/container/resource2</d:href> <d:href>http://www.foo.bar/container/</d:href><d:href>http://www.foo.bar/container/C2/R2</d:href><d:status>HTTP/1.1201 Created</d:status>204 No Content</d:status> </d:response> <d:response><d:href>http://www.foo.bar/container/C2</d:href><d:href>http://www.foo.bar/container/C2/R2</d:href> <d:status>HTTP/1.1420424 Method Failure</d:status> <d:response><d:href>http://www.foo.bar/othercontainer/C2</d:href><d:href>http://www.foo.bar/othercontainer/C2/</d:href> <d:status>HTTP/1.1409 Conflict</d:status>425 Locked</d:status> </d:response> </d:multistatus> In this example the client has submitted a number of lock tokens with the request. A lock token will need to be submitted for every resource, both source and destination, anywhere in the scope of theINTERNET-DRAFT WebDAV November 19, 1997method, that is locked. In this case the proper lock token was not submitted for the destinationhttp://www.foo.bar/othercontainer/C2.http://www.foo.bar/othercontainer/C2/. This means that the resourcecontiner/c2/container/C2/ could not bemoved, although its child container/C2/R2 could bemoved.8.13.As the attempt to move /container/C2/ failed then the resource /container/C2/R2 MUST also fail since it is a child of /container/C2/. 7.12 LOCK Method The following sections describe the LOCK method, which is used to take out a lock of any access type. These sections on the LOCK Goland et al. [Page 42] INTERNET-DRAFT WebDAV January 18, 1998 method describe only those semantics that are specific to the LOCK method and are independent of the access type of the lock being requested.Once the general LOCK method has been described, subsequent sections describe the semantics of the "write" access type, and the write lock. 8.13.1.7.12.1 Operation A LOCK method invocation creates the lock specified by theLock-Info headerlockinfo XML element on the Request-URI. Lock method requests SHOULD have a XML request body which contains anOwnerowner XML element for this lock request, unless this is a refresh request. The LOCK request MAY have a Timeout header. A successful response to a lock invocation MUST include Lock-Token and Timeout headers. Clients MUST assume that locks may arbitrarily disappear at any time, regardless of the value given in the Timeout header. The Timeout header only indicates the behavior of the server if "extraordinary" circumstances do not occur. For example, an administrator may remove a lock at any time or the system may crash in such a way that it loses the record of the lock's existence. The response MUST also contain the value of the lockdiscovery property in a prop XML element.8.13.2.7.12.2 The Effect of Locks on Properties and CollectionsBy default theThe scope of a lock is the entire state of the resource, including its body and associated properties. As a result, a lock on a resource also locks the resource'sproperties, and a lock on a property may lock a property's resource or may restrict the ability to lock the property's resource. Only a single lock token MUST be used when a lock extends to cover both a resource and itsproperties.Note that certain lock types MAY override this behavior.For collections, a lock also affects the ability to add or remove members. The nature of the effect depends upon the type of access control involved.8.13.3.7.12.3 Locking Replicated Resources Some servers automatically replicate resources across multiple URLs. In such a circumstance the server MAY only accept a lock on one ofINTERNET-DRAFT WebDAV November 19, 1997the URLs if the server can guarantee that the lock will be honored across all the URLs.8.13.4.7.12.4 Depth and LockingMultiple ResourcesTheLOCK method supports locking multiple resources simultaneously by allowing for the listing of several URIs inDepth header MAY be used with the LOCKrequest. These URIs, in addition to the Request-URI, are then tomethod. Values other than 0 or infinity MUST NOT belocked as a resultused with the Depth header. A Depth header of value 0 means to just lock theLOCK method's invocation. When multiple resources areresource specified by theLOCK method only succeeds if all specified resources are successfully locked. The Lock-Tree option ofrequest-URI. If thelock request specifies thatDepth header is set to infinity then the resourceandspecified in the request-URI along with all its internalchildren (including internal collections, and their internal members) are to be locked. This is another mechanism by which a request for a lock on multiple resources can be specified. Currently existing locks can not be extended to cover more or less resources, and any request to expand or contractmembers, all thenumber of resources in a lock MUST fail with a 409 Conflict status code. So, for example, if resource A is exclusively write locked and thenway down thesame principal askshierarchy, are toexclusively write lock resources A, B, and C, the request will fail as A is already locked and the lock can notbeextended.locked. A successful result will return a single lock token which represents all the resources that have been locked. If an UNLOCK is executed on this token, all Goland et al. [Page 43] INTERNET-DRAFT WebDAV January 18, 1998 associated resources are unlocked. If the lock cannot be granted to all resources, a 409 Conflict status code MUST be returned with a response entity body containing a multistatus XML element describing which resource(s) prevented the lock from being granted.8.13.5.Hence, partial success is not an option. Either the entire hierarchy is locked or no resources are locked. 7.12.5 Interaction with other Methods The interaction of a LOCK with various methods is dependent upon the lock type. However, independent of lock type, a successful DELETE of a resource MUST cause all of its locks to be removed.8.13.6.7.12.6 Lock Compatibility Table The table below describes the behavior that occurs when a lock request is made on a resource. Current lock state/ Shared Lock Exclusive Lock request Lock None True True Shared Lock True False Exclusive Lock False False*INTERNET-DRAFT WebDAV November 19, 1997Legend: True = lock MAY be granted. False = lock MUST NOT be granted. *=if the principal requesting the lock is the owner of the lock, the lockMAYMUST be regranted. The current lock state of a resource is given in the leftmost column, and lock requests are listed in the first row. The intersection of a row and column gives the result of a lock request. For example, if a shared lock is held on a resource, and an exclusive lock is requested, the table entry is_false_,"false", indicating the lock must not be granted. If an exclusive or shared lock is re-requested by the principal who owns the lock, the lock MUST be regranted. If the lock is regranted, the same lock token that was previously issued MUST be returned.8.13.7. Owner XML Element Name: owner Namespace: http://www.ietf.org/standards/dav/ Purpose: Provide information about the principal taking out7.12.7 Lock Response A successful lock response MUST contain alock. Parent: Any Values: XML Elements Descripton: The Owner XML element provides information sufficient for either directly contactingLock-Token response header, aprincipal (such as a telephone number or Email URI), or for discovering the principal (such as the URL of a homepage) who owns a lock. 8.13.8. Lock Response A successful lock response MUST contain a Lock-Token response header, a Timeout header andTimeout header and a prop XML element in the response body which contains the value of the lockdiscovery property.8.13.9. Response7.12.8 Status Codes409 Conflict - The resource is locked, so the method has been rejected.Goland et al. [Page 44] INTERNET-DRAFT WebDAV January 18, 1998 412 Precondition Failed - The included Lock-Token was not enforceable on this resource or the server could not satisfy the request in theLock-Info header. 8.13.10.lockinfo XML element. 425 Locked - The resource is locked, so the method has been rejected. 7.12.9 Example - Simple Lock Request >>Request LOCK /workspace/webdav/proposal.doc HTTP/1.1 Host: webdav.sb.aol.comLock-Info: LockType=Write LockScope=ExclusiveTimeout:Infinite;Infinite, Second-4100000000 Content-Type: text/xmlINTERNET-DRAFT WebDAV November 19, 1997Content-Length: xyz<?XML version="1.0">Authorization: Digest username="ejw", realm="ejw@webdav.sb.aol.com", nonce="...", uri="/workspace/webdav/proposal.doc", response="...", opaque="..." <?xml version="1.0"?> <?namespacehref="http://www.ietf.org/standards/dav/" AS = "D"?>href="http://www.iana.org/standards/dav/" as="D"?> <D:lockinfo> <D:locktype><D:write/></D:locktype> <D:lockscope><D:exclusive/></D:lockscope> <D:owner> <D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href> </D:owner> </D:lockinfo> >>Response HTTP/1.1 200 OK Lock-Token:opaquelocktoken:xyz122393481230912asdfa09s8df09s7df<opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4> Timeout: Second-604800 Content-Type: text/xml Content-Length: xxxxx<?XML version="1.0"><?xml version="1.0"?> <?namespace href="http://www.ietf.org/standards/dav/" AS = "D"?>="http://www.iana.org/standards/dav/" as="D"?> <D:prop> <D:lockdiscovery> <D:activelock><D:locktype>write</D:locktype> <D:lockscope>exclusive</D:lockscope> <D:addlocks/><D:locktype><D:write/></D:locktype> <D:lockscope><D:exclusive/></D:lockscope> <D:owner><D:href> http://www.ics.uci.edu/~ejw/contact.html </D:href><D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href> </D:owner> <D:timeout>Second-604800</D:timeout> <D:locktoken> Goland et al. [Page 45] INTERNET-DRAFT WebDAV January 18, 1998 <D:href>opaquelocktoken:xyz122393481230912asdfa09s8df09s7dfopaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4 </D:href> </D:locktoken> </D:activelock> </D:lockdiscovery> </D:prop> This example shows the successful creation of an exclusive write lock on resource http://webdav.sb.aol.com/workspace/webdav/proposal.doc. The resource http://www.ics.uci.edu/~ejw/contact.html contains contact information for the owner of the lock. The server has an activity- based timeout policy in place on this resource, which causes the lock to automatically be removed after 1 week (604800 seconds). The response has a Lock-Token header that gives the lock token URL that uniquely identifies the lock created by this lock request.8.13.11.Note that the nonce, response, and opaque fields have not been calculated in the Authorization request header. 7.12.10 Example -Multi-ResourceRefreshing a Write LockRequest>>Request LOCK /workspace/webdav/proposal.doc HTTP/1.1 Host: webdav.sb.aol.com Timeout: Infinite, Second-4100000000 Lock-Token: <opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4> Authorization: Digest username="ejw", realm="ejw@webdav.sb.aol.com", nonce="...", uri="/workspace/webdav/proposal.doc", response="...", opaque="..." >>Response HTTP/1.1 200 OK Lock-Token: <opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4> Timeout: Second-604800 Content-Type: text/xml Content-Length: xxxxx <?xml version="1.0"?> <?namespace href ="http://www.iana.org/standards/dav/" as="D"?> <D:prop> <D:lockdiscovery> <D:activelock> <D:locktype><D:write/></D:locktype> <D:lockscope><D:exclusive/></D:lockscope> <D:owner> <D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href> </D:owner> <D:timeout>Second-604800</D:timeout> Goland et al. [Page 46] INTERNET-DRAFT WebDAVNovember 19, 1997 Lock-Info: LockType=Write LockScope=Exclusive Addlocks=<http://webdav.sb.aol.com/workspace/><http://foo.bar/blah>January 18, 1998 <D:locktoken> <D:href> opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4 </D:href> </D:locktoken> </D:activelock> </D:lockdiscovery> </D:prop> This request would refresh the lock, resetting any time outs. Notice that the client asked for an infinite time out but the server choose to ignore the request. In this example, the nonce, response, and opaque fields have not been calculated in the Authorization request header. 7.12.11 Example - Multi-Resource Lock Request >>Request LOCK /webdav/ HTTP/1.1 Host: webdav.sb.aol.com Timeout: Infinite, Second-4100000000<?XML version="1.0">Depth: infinity Authorization: Digest username="ejw", realm="ejw@webdav.sb.aol.com", nonce="...", uri="/workspace/webdav/proposal.doc", response="...", opaque="..." <?xml version="1.0"?> <?namespacehref="http://www.ietf.org/standards/dav/" AS = "D"?> <D:href>http://www.ics.uci.edu/~ejw/contact.html<D:href>href="http://www.iana.org/standards/dav/" as="D"?> <D:lockinfo> <D:locktype><D:write/></D:locktype> <D:lockscope><D:exclusive/></D:lockscope> <D:owner> <D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href> </D:owner> </D:lockinfo> >>Response HTTP/1.1409 Conflict207 Multistatus Content-Type: text/xml Content-Length: xxxxx<?XML version="1.0"><?xml version="1.0"?> <?namespacehref = "http://www.ietf.org/standards/dav/" As = "D"?>href="http://www.iana.org/standards/dav/" as="D"?> <D:multistatus> <D:response><D:href> http://webdav.sb.aol.com/workspace/webdav/proposal.doc </D:href> <D:href> http://webdav.sb.aol.com/workspace/webdav/ </D:href><D:href>http://webdav.sb.aol.com/webdav/proposal.doc</D:href> <D:href>http://webdav.sb.aol.com/webdav/</D:href> <D:status>HTTP/1.1202 Accepted</D:status>424 Method Failure</D:status> </D:response> Goland et al. [Page 47] INTERNET-DRAFT WebDAV January 18, 1998 <D:response><D:href>http://foo.bar/blah</D:href><D:href>http://webdav.sb.aol.com/webdav/secret</D:href> <D:status>HTTP/1.1 403 Forbidden</D:status> </D:response> </D:multistatus> This example shows a request for an exclusive write lock onthree resources, http://webdav.sb.aol.com/workspace/webdav/proposal.doc, http://webdav.sb.aol.com/workspace/,a collection andhttp://foo.bar/blah.all its children. In this request, the client has specified that it desires an infinite length lock, if available, otherwise a timeout of 4.1 billion seconds, if available. TheOwner header field specifiesrequest entity body contains theweb address forcontact information for the principal taking out thelock. This lock request has failed, because the server rejected the lock request for http://foo.bar/blah.lock, in this case a web page URL. The409 Conflict status code424 Method Failure indicates thatthe servera lock wasunablenot taken out on these resources due tosatisfyan error elsewhere. Note that this does not mean that a lock would have succeeded on these resources had therequest because thereother error not occurred. It only means that another error has occurred and so the entire method has been aborted. The error is aconflict between403 Forbidden response on thestateresource http://webdav.sb.aol.com/webdav/secret. Because this resource could not be locked, none of the resourcesand the operation named in the request. Within the multistatus, the 202 Accepted status code indicates that the lock method was accepted bywere locked. In this example, theresources,nonce, response, andwouldopaque fields have not beencompleted if all resources namedcalculated in the Authorization requestwere able to be locked. The 403 Forbidden status code indicates that the server does not allow lock requests on this resource. 8.14.header. 7.13 UNLOCK MethodINTERNET-DRAFT WebDAV November 19, 1997The UNLOCK method removes the lock identified by the lock token in the Lock-Token header from the Request-URI, and all other resources included in the lock. Any DAV compliant resource which supports the LOCK method MUST support the UNLOCK method.8.14.1.7.13.1 Example >>Request UNLOCK /workspace/webdav/info.doc HTTP/1.1 Host: webdav.sb.aol.comLock-Token:opaquelocktoken:123AbcEfg1284h23h2Lock-Token:<opaquelocktoken:a515cfa4-5da4-22e1-f5b5-00a0451e6bf7> Authorization: Digest username="ejw", realm="ejw@webdav.sb.aol.com", nonce="...", uri="/workspace/webdav/proposal.doc", response="...", opaque="..." >>Response HTTP/1.1200 OK204 No Content Goland et al. [Page 48] INTERNET-DRAFT WebDAV January 18, 1998 In this example, the lock identified by the lock token"opaquelocktoken:123AbcEfg1284h23h2""opaquelocktoken:a515cfa4-5da4-22e1-f5b5-00a0451e6bf7" is successfully removed from the resource http://webdav.sb.aol.com/workspace/webdav/info.doc. If this lock included more than just one resource, the lockwasis removed fromthoseall resourcesas well. 8.15. PATCH Methodincluded in the lock. ThePATCH method204 status code is usedto modify partsinstead ofthe200 OK because there is no response entityreturnedbody. In this example, the nonce, response, and opaque fields have not been calculated in theresponseAuthorization request header. 8 HTTP Headers for Distributed Authoring 8.1 Collection-Member Header CollectionMember = "Collection-Member" ":" absoluteURI ; absoluteURI is defined in section 3.2.1 of [Fielding et al., 1997] The Collection-Member header specifies the URI of an external resource to be added/deleted to/from aGET method.collection. 8.2 DAV Header DAV = "DAV" ":" ["1"] [",2"] ["," 1#extend] This header indicates that the resource supports the DAV schema and protocol as specified. All DAV compliant resourcesMAY supportMUST return thePATCH method. 8.15.1. The RequestDAV header on all OPTIONS responses. Therequest entity of the PATCH method containsvalue is a list ofdifferences between the resource identified by the Request-URI and the desired content ofall compliance classes that the resourceafter the PATCH actionsupports. Note that above a comma has already beenapplied. The list of differences is in a format defined by the media type of the entity (e.g., "application/diff") and must include sufficient information to allow the serveradded toconvert the original version ofthe 2. This is because a resource can not be level 2 compliant unless it is also level 1 compliant. Please refer tothe desired version. Processing performed by PATCHSection 13 for more details. In general, however, support for one compliance class does not entail support for any other. 8.3 Depth Header Depth = "Depth" ":" ("0" | "1" | "infinity") The Depth header isatomic. Hence all changes MUST be successfully executed or the method fails. PATCH MUST fail ifused with methods executed ona non-existent resource; i.e., PATCH does not create a resource as a side effect. Ifresources which could potentially have internal members to indicate whether therequest appears (at least initially)method is to beacceptable, the server MUST transmit an interim 100 response message after receivingapplied only to theempty line terminatingresource (Depth = 0), to therequest headersresource andcontinue processing the request. Sinceits immediate children, (Depth = 1), or thesemantics of PATCH are non- idempotent, responses to this method are not cacheable. While server support for PATCHresource and all its progeny (Depth = infinity). The Depth header isoptional,only supported if aserver does support PATCH, it MUST support at least the text/xml diff format defined INTERNET-DRAFT WebDAV November 19, 1997 below. Supportmethod's definition explicitly provides forthe VTML difference format [VTML] is recommended, but not required. 8.15.2. text/xml elements for PATCH The resourceupdate XML element contains a set of XML sub-entities that describe modification operations.such support. Thename and meaning of these XML elementsfollowing rules aregiven below. Processing of these directives MUST be performed intheorder encountered withindefault behavior for any method that supports theXML document.Depth header. Adirective operates on the resource as modifiedmethod MAY override these defaults byall previous directives (executeddefining different behavior insequential order). The lengthits definition. Goland et al. [Page 49] INTERNET-DRAFT WebDAV January 18, 1998 Methods which support the Depth header MAY choose not to support all of theresourceheader's values and MAYbe extended or reduced bydefine, on aPATCH. The changes specifiedcase by case basis, theresourceupdate XML element MUST be executed atomically. 8.15.2.1. resourceupdate XML Element Name: resourceupdate Namespace: http://www.ietf.org/standards/dav/patch/ Purpose: Contains an ordered setbehavior ofchanges to a non-collection, non-property resource. Parent: None Value= *(insert | delete | replace) 8.15.2.2. insert XML Element Name: insert Namespace: http://www.ietf.org/standards/dav/patch/ Purpose: Insert the XML element's contents starting at the specified octet. Parent: resourceupdate Value: The insert XML element MUST contain an octet-range XML attribute that specifies an octet position withinthebody ofmethod if aresource. A value of _end_ specifies the end of the resource. The body of the insert XML element contains the octets to be inserted. Please note that in order to protect the white space contained in this XML element the following attribute/value MUST be included inDepth header is not present. For example, theelement: XML-SPACEMOVE method only supports Depth ="PRESERVE". This attributeinfinity and if a Depth header isdefinednot present will act as if a Depth = infinity header had been applied. Clients MUST NOT rely upon methods executing on members of their hierarchies in any particular order or on theXML specification [Bray, Sperberg-McQueen, 1997]. 8.15.2.3. delete XML Element Name: delete Namespace: http://www.ietf.org/standards/dav/patch/ Purpose: Removes the specified rangeexecution being atomic. Note that methods MAY provide guarantees on ordering and atomicity. Upon execution, a method with a Depth header will perform as much ofoctets. Parent: resourceupdate Value: The delete XML element MUST containits assigned task as possible and then return a response specifying what it was able to accomplish and what it failed to do. So, for example, anoctet-range XML attribute. INTERNET-DRAFT WebDAV November 19, 1997 Discussion: The octets that are deleted are removed, which meansattempt to COPY a hierarchy may result in some of theresource is collapsedmembers being copied and some not. Any headers on a method with a Depth header MUST be applied to all resources in thelengthscope of the method. For example, an If-Match header will have its value applied against every resourceis decremented byin thesize ofmethod's scope and will cause theoctet range. It is not appropriatemethod toreplace deleted octets with zeroed-out octets, since zero is a valid octet value. 8.15.2.4. replace XML Element Name: replace Namespace: http://www.ietf.org/standards/dav/patch/ Purpose: Replaces the specified range of octets with the contents offail if theXML element.header fails to match. If a resource, source or destination, within thenumberscope ofoctets intheXML elementmethod isdifferent fromlocked in such a way as to prevent thenumbersuccessful execution ofoctets specified,theupdatemethod, then the lock token for that resource MUST berejected. Parent: resourceupdate Value: The replace XML element MUST contain an octet-range XML attribute.submitted with the request in the Lock-Token request header. ThecontentsDepth header only specifies the behavior of theentity aremethod with regards to internal children. If a resource does not have internal children then thereplacement octets.Depth header is ignored. Pleasenotenote, however, thatin orderit is always an error toprotectsubmit a value for thewhite space contained in this XML elementDepth header that is not allowed by thefollowing attribute/value MUST be included inmethod's definition. Thus submitting a "Depth: 1" on a COPY, even if theelement: XML-SPACE = "PRESERVE" . This attribute is definedresource does not have internal members, MUST result inthe XML specification [Bray, Sperberg-McQueen, 1997]. 8.15.2.5. octet-range Attribute Name: octet-range Namespace: http://www.ietf.org/standards/dav/patch/ Purpose: Specifiesarange400 Bad Request. The method should fail not because the resource doesn't have internal members, but because ofoctets thattheenclosing property affects. Parent: insert | delete | replace Value: number [_-_ (number | _end_)] Number = 1*Digit Description: Octet numbering begins with 0. Ifillegal value in theoctet containsheader. 8.4 Destination Header Destination = "Destination" ":" URI The Destination header specifies asingle number then the operationdestination resource for methods such as COPY and MOVE, which take two URIs as parameters. 8.5 If-None-State-Match If-None-State-Match = "If-None-State-Match" ":" 1#Coded-URL Goland et al. [Page 50] INTERNET-DRAFT WebDAV January 18, 1998 Coded-URL = "<" URI ">" The If-None-State-Match header is intended tobegin at that octet andhave similar functionality tocontinue for a length specified by the operation. InthecaseIf-None-Match header defined in section 14.26 of [Fielding et al., 1997]. However the If-None-State-Match header is intended for use with any URI which represents state information about adelete, this would meanresource, referred todeleteas asingle octet. In the casestate token. A typical example is a lock token. If any ofan insert this would mean to begintheinsertion at the specified octet and to continue forstate tokens identifies thelengthcurrent state of theincluded value, extendingresource, theresourceserver MUST NOT perform the requested method. Instead, ifnecessary. Inthecase of replace,request method was GET, HEAD, or PROPFIND, thereplace begins at the specified octet and overwrites all that follow toserver SHOULD respond with a 304 Not Modified response, including thelengthcache-related entity-header fields (particularly ETag) of theincluded value. 8.15.3. Response Codes 200 OK - The request entity body was processed without error, resulting in an update to thecurrent state of the resource.409 Conflict - IfFor all other request methods, theupdate information inserver MUST respond with a status of 412 Precondition Failed. If none of therequest message body does not make sense givenstate tokens identifies the current state of theresource (e.g., an instruction to delete a non-existent line), this status code MAY be returned. INTERNET-DRAFT WebDAV November 19, 1997 415 Unsupported Media Type - Theresource, the serverdoes not supportMAY perform thecontent typerequested method. If any of theupdate instructions intokens is not recognized, therequest message body. 418 Unprocessable Entity - The entity body submittedmethod MUST fail with a 412 Precondition Failed. Note that thePATCH was not understood by"AND" and "OR" keywords specified with theresource. 419 Insufficient Space on Resource - The resource doesIf-State- Match header are intentionally not defined for If-None-State-Match, because this functionality is not required. 8.6 If-State-Match If-State-Match = "If-State-Match" ":" ("AND" | "OR") 1#Coded-URL The If-State-Match header is intended to havesufficient spacesimilar functionality torecordthestateIf-Match header defined in section 14.25 of [Fielding et al., 1997]. However theresource after the execution of this method. 8.15.4. HTML file modification Example The followingIf-State-Match header is intended for use with any URI which represents state information about a resource. A typical exampleshowsis amodification oflock token. If thetitleAND keyword is used andcontentsall of theHTML resource http://www.example.org/hello.html. Before: <HTML> <HEAD> <TITLE>Hello world HTML page</TITLE> </HEAD> <BODY> <P>Hello, world!</P> </BODY> </HTML> PATCH Request: Response: PATCH hello.html HTTP/1.1 Host: www.example.org Content-Type: text/xml Content-Length: xxx HTTP/1.1 100 Continue <?XML version="1.0"> <?namespace href = _http://www.ietf.org/standards/dav/patch/_ AS = _D_?> <D:resourceupdate> <D:replace XML-SPACE = "PRESERVE"> <D:octet-range>14</D:octet-range>&003CTITLE&003ENew Title&003C/TITLE&003E</D:replace> <D:delete><D:octet-range>38-50</D:octet-range></D:delete> <D:insert XML-SPACE = "PRESERVE"><D:octet-range>86</D:octet- range>&003CP&003ENew paragraph&003C/P&003E</D:insert> </D:resourceupdate> HTTP/1.1 200 OK After: <HTML> INTERNET-DRAFT WebDAV November 19, 1997 <HEAD> <TITLE>New Title</TITLE> </HEAD> <BODY> <P>Hello, world!</P> <P>New paragraph</P> </BODY> </HTML> 9. HTTP Headers for Distributed Authoring 9.1. Collection-Member Header CollectionMember = "Collection-Member" ":" URI ; URIstate tokens identify the state of the resource, then the server MAY perform the requested method. If the OR keyword isdefined in section 3.2.1used and any of[Fielding et al., 1997] The Collection-Member header specifiestheURIstate tokens identifies the current state ofan external resource to be added/deleted to/from a collection. 9.2. DAV Header DAV = "DAV" ":" ("1" | "2" | extend) This header indicates thattheresource supportsresource, then theDAV schema and protocol toserver MAY perform thelevel indicated. All DAV compliant resourcesrequested method. If the keyword requirement for the keyword used is not met, the server MUST NOT perform the requested method, and MUST return a 412 Precondition Failed response. If any of theDAV header on all OPTIONS responses. 9.3. Depthtokens is not recognized, the method MUST fail with a 412 Precondition Failed. 8.7 Lock-Token Request HeaderDepthGoland et al. [Page 51] INTERNET-DRAFT WebDAV January 18, 1998 Lock-Token ="Depth""Lock-Token" ":"("0" | "1" | "infinity")1#Coded-URL TheDepth headerLock-Token request header, containing a lock token owned by the requesting principal, is usedwith methods executed on collectionsby the principal to indicatewhetherthat themethodprincipal isto be applied only toaware of thecollection (Depth = 0), toexistence of thecollection and its immediate children, (Depth = 1), orlock specified by the lock token. If thecollection and all its progeny (Depth = infinity). Note that Depth = 1 and Depth = infinity behavior only applies to internal member resources, and not to external member resources. The Depth header is only supported if a method's definition explicitly provides for such support. Thefollowingrulesconditions arethe default behavior for any method that supports the depth header. Amet: 1) The methodMAY override these defaultsis restricted bydefining different behavior in its definition. Methods which support the depth header MAY choose not to support all of the header's values and MAY define, onacase by case basis,lock type that requires thebehaviorsubmission ofthea lock token, such as a write lock, 2) The user-agent has authenticated itself as a given principal, 3) The user-agent is submitting a method request to a resource on which the principal owns acollection ifwrite lock, Then: 1) The method request MUST include adepthLock-Token headeris not present. For example,with theMOVElock token, or, 2) The methodonly supports Depth = infinity and ifMUST fail with adepth header is not present will act409 Conflict status code. If multiple resources are involved with a method, such as the MOVE method, then the lock tokens, ifa Depth = infinity header had been applied. INTERNET-DRAFT WebDAV November 19, 1997 Clientsany, for all affected resources, MUSTNOT rely upon methods executing on members of their hierarchiesbe included inany particular order ortheexecution being atomic. Note that methods MAY provide guaranteesLock-Token request header. For example, Program A, used by user A, takes out a write lock onordering and atomicity. Upon execution,amethod withresource. Program A then makes adepth header will perform as muchnumber ofits assigned task as possible and then return a response specifying what it was able to accomplish and what it failed to do. So, for example, an attempt to COPY a hierarchy may result in some of the members being copied and some not. Any headersPUT requests on the locked resource. All the requests contain amethod with a depthLock-Token request headerMUST be appliedthat includes the write lock token. Program B, also run by User A, then proceeds to perform a PUT toall resources inthescopelocked resource. However, program B was not aware of themethod. For example, an if-match header will have its value applied against every resource inexistence of themethod's scopelock andwill causeso does not include the appropriate Lock-Token request header. The method is rejected even though principal A is authorized tofailperform the PUT. Program B can, if it so chooses, now perform lock discovery and obtain the lock token. Note that programs A and B can perform GETs without using the Lock-Token headerfailsbecause the ability tomatch. Ifperform aresource, source or destination, within the scope of the methodGET islocked in suchnot affected by a write lock. Having away as to prevent the successful execution of the method, then thelock tokenfor that resource MUSTprovides no special access rights. Anyone can find out anyone else's lock token by performing lock discovery. Locks are to besubmitted withenforced based upon whatever authentication mechanism is used by therequest inserver, not based on the secrecy of the token values. 8.8 Lock-Tokenrequest header. 9.4. DestinationResponse HeaderDestinationLock-Token ="Destination""Lock-Token" ":"URI The Destination header specifies1#Coded-URL If adestinationresourcefor methods such as COPY and MOVE, which take two URIs as parameters. 9.5. Destroy Header DestroyHeader = "Destroy" ":" #Choices Choices = "VersionDestroy" | "NoUndelete" | "Undelete" | extend Extend = RFC-Reg | Coded-URL RFC-Req = Token ; Thisis successfully locked then atoken value (defined in section 2.2 of [Fielding et al., 1997]) that has been published as an RFC. Coded-URL = "<" URI ">" When deleting a resource the client often wishes to specify exactly what sort of delete shouldLock-Token header will beperformed. The Destroy header, used with the Mandatory header, allows the client to specifyreturned containing theend result it desires. The Destroy header is specified as follows: The Undeletelock tokenrequests that, if possible, the resource should be left in a state suchthatit can be undeleted. The server is not required to honor this request.represents the lock. Goland et al. [Page 52] INTERNET-DRAFT WebDAVNovember 19, 1997 The NoUndelete token requests that the resourceJanuary 18, 1998 If multiple lock-tokens are returned then they MUSTNOT be left in a state such that it can be undeleted. The VersionDestroy token includes the functionality of the NoUndelete token and extends itall refer toinclude havingtheserver removesame lock. As the lock tokens allversioning referencesrefer to theresource that it has control over. 9.6. Enforce-Live-Propertiessame lock a client need only record one of them. 8.9 Overwrite HeaderEnforceLivePropertiesOverwrite ="Enforce-Live-Properties_ _:" (_*_ | "Omit""Overwrite" ":" ("T" |1*(Property-Name)) Property-Name = Coded-URL"F") TheEnforce-Live-PropertiesOverwrite header specifiesproperties that MUST be _live_ after they are copied (moved) towhether the server should overwrite the state of a non-null destination resourceofduring acopy (or move). If theCOPY or MOVE. A value_*_ is given forof "F" states that theheader, then it designates all live properties onserver MUST NOT perform thesource resource. If the value is "Omit" thenCOPY or MOVE operation if theserver MUST NOT duplicate onstate of the destination resourceany properties that are defined onis non-null. By default, thesource resource. Ifvalue of Overwrite is "T" and a client MAY omit this header from a request when its value isnot included then"T". While theserver is expectedOverwrite header appears toact as defined byduplicate thedefault property handling behaviorfunctionality of theassociated method. 9.7. If-None-State-Match If-None-State-Match = "If-None-State-Match" ":" 1#Coded-URL The If-None-State-MatchIf-Match: * headeris intendedof HTTP/1.1, If-Match applies only tohave similar functionalitythe Request-URI, and not to theIf-None-Match header defined in section 14.26Destination ofRFC 2068. However the if-none-state-match header is intended for use with any URI which represents state information aboutaresource, referred to asCOPY or MOVE. If astate token. A typical exampleCOPY or MOVE isa lock token. If any of the state tokens identifiesnot performed due to thecurrent statevalue of theresource, the server MUST NOT perform the requested method. Instead, ifOverwrite header, therequestmethodwas GET, HEAD, INDEX, or PROPFIND, the server SHOULD respondMUST fail with a304 Not Modified response, including the cache-related entity-header fields (particularly ETag) of409 Conflict status code. 8.10 Status-URI Response Header The Status-URI response header MAY be used with thecurrent state of102 Processing status code to inform theresource. For all other request methods,client as to theserver MUST respond with astatus of412 Precondition Failed. If nonea method. Status-URI = "Status-URI" ":" *(Status-Code "<" URI ">") ; Status- Code is defined in 6.1.1 of [Fielding et al., 1997] The URIs listed in thestate tokens identifies the current state of the resource, the server MAY performheader are source resources which have been affected by therequestedoutstanding method.If anyThe status code indicates the resolution of thetokens is not recognized thenmethod on the identified resource. So, for example, if a MOVE methodMUST fail withon a412 Precondition Failed. INTERNET-DRAFT WebDAV November 19, 1997 Note that the "AND"collection is outstanding and"OR" keywords specifieda 102 "Processing" response withthe If-State- Matcha Status-URI response headerare intentionally not defined for If-None-State-Match, because this functionalityisnot required. 9.8. If-State-Match If-State-Matchreturned, the included URIs will indicate resources that have had move attempted on them and what the result was. 8.11 Timeout Header TimeOut ="If-State-Match""Timeout" ":"("AND"1#TimeType TimeType = ("Second-" DAVTimeOutVal |"OR") 1#Coded-URL The If-State-Match header is intended to have similar functionality to the If-Match header defined in"Infinite" | Other) DAVTimeOutVal = 1*digit Other = Extend field-value ; See section14.254.2 ofRFC 2068. However[Fielding et al., 1997] Clients MAY include Timeout headers in their LOCK requests. However, theIf-State-Match headerserver isintended for usenot required to honor or even consider these requests. Clients MUST NOT submit a Timeout request header with anyURI which represents state information aboutmethod other than aresource.LOCK method. Atypical example is a lock token. If the AND keyword is usedTimeout request header MUST contain at least one TimeType andall of the state tokens identify the state of the resource, then the serverMAYperform the requested method. If the OR keyword is used and anycontain multiple TimeType entries. The purpose ofthe state tokens identifies the current state of the resource, then the server MAY perform the requested method. If the keyword requirement for the the keyword usedlisting multiple Goland et al. [Page 53] INTERNET-DRAFT WebDAV January 18, 1998 TimeType entries isnot met,to indicate multiple different values and value types that are acceptable to theserver MUST NOT performclient. The client lists therequested method, andTimeType entries in order of preference. The Timeout response header MUSTreturnuse a412 Precondition Failed response. If any ofSecond value, Infinite, or a TimeType thetokensclient has indicated familiarity with. The server MAY assume a client isnot recognized then the method MUST failfamiliar with any TimeType submitted in a412 Precondition Failed. 9.9. Lock-Info Request Header LockInfo = "Lock-Info" ":" DAVLockType SP DAVLockScope [SP AdditionalLocks] [SP Lock-Tree] DAVLockType = "LockType" "=" DAVLockTypeValue DAVLockTypeValue = ("Write" | Extend) DAVLockScope = "LockScope" "=" DAVLockScopeValue DAVLockScopeValue = ("Exclusive" |"Shared" | Extend) AdditionalLocks = "AddLocks" "=" 1*("<" URI ">") Lock-Tree = "Lock-Tree" "=" ("T" | "F")Timeout header. TheLock-Info request header"Second" TimeType specifies thescope and typenumber ofaseconds that MUST elapse between granting of the lockfor a LOCK method request. The syntax specification below is extensible, allowing new typeat the server, andscope identifiers to be added. The LockType field specifiestheaccess typeautomatic removal of the lock.At present, this specification only defines one lock type, the "Write" lock.A server MUST not generate a timeout value for "Second" greater than 2^32-1. TheLockScope field specifies whethertimeout counter SHOULD be restarted any time an owner of the lockis an exclusive lock, orsends ashared lock. The AddLocks field specifies additional URIs, beyond the Request-URI,method to any member of the lock, including unsupported methods, or methods which are unsuccessful. However the lockrequest applies. The LockTree fieldMUST be refreshed if a refresh LOCK method isused to specify recursive locks.successfully received. If theLockTree field is "T",timeout expires then the lockrequest applies tois lost. Specifically thehierarchy traversal ofserver SHOULD act as if an UNLOCK method was executed by theinternal member resources ofserver on theRequest-URI, andresource using theAddLocks URIs, inclusivelock token of theRequest-URI and the AddLocks URIs. It is not an error if LockTree is "T", and the Request-URI or the AddLocks URIs have no internal member resources. By default, INTERNET-DRAFT WebDAV November 19, 1997timed-out lock, performed with its override authority. Thus logs should be updated with thevaluedisposition ofLockTree is "F", and this field MAYthe lock, notifications should beomitted when its value is "F". 9.10. Lock-Token Request Header Lock-Token = "Lock-Token" ":" 1#Coded-URL The Lock-Token request header, containing a lock token owned bysent, etc., just as they would be for an UNLOCK request. Servers are advised to pay close attention to therequesting principal, is usedvalues submitted by clients, as they will be indicative of theprincipal to indicate thattype of activity theprincipal is awareclient intends to perform. For example, an applet running in a browser may need to lock a resource, but because of theexistenceinstability of thelock specified byenvironment within which thelock token. Ifapplet is running, thefollowing conditions are met: 1) The methodapplet may be turned off without warning. As a result, the applet isrestricted bylikely to ask for alock typerelatively small timeout value so thatrequiresif the applet dies, thesubmission of alocktoken, such as a write lock, 2) The user-agent has authenticated itself ascan be quickly harvested. However, aprincipal, 3) The user-agentdocument management system issubmitting a method requestlikely toa resourceask for an extremely long timeout because its user may be planning onwhich the principal owns a write lock, Then: 1) The method request MUST include a Lock-Token header with the lock token, or, 2)going off-line. 9 Status Code Extensions to HTTP/1.1 Themethod MUST fail with a 409 Conflictfollowing statuscode. If multiple resourcescodes areinvolved with a method, such as a COPY or MOVE method, then the lock tokens, if any, for all involved resources, MUST be includedadded to those defined inthe Lock-Token request header. For example, Program A, used by user A, takes out a write lock on a resource. Program A then makesHTTP/1.1 [Fielding et al., 1997]. 9.1 102 Processing Methods can potentially take anumberlong period ofPUT requests ontime to process, especially methods that support thelocked resource. AllDepth header. In such cases therequests containclient may time-out the connection while waiting for aLock-Token request header that includesresponse. To prevent this thewrite lock state token. Program B, also run by User A, then proceeds to performserver MAY return aPUT102 status code to indicate to thelocked resource. However, program B was not aware of the existence ofclient that thelock and so does not includeserver is still processing theappropriate Lock-Token request header. Themethod. Goland et al. [Page 54] INTERNET-DRAFT WebDAV January 18, 1998 If a method isrejected even though principal A is authorizedtaking longer than 20 seconds (a reasonable, but arbitrary value) toperformprocess thePUT. Program B can, if it so chooses, now perform lock discovery and obtain the lock token. Note that programs A and B can perform GETs without using the Lock-Token header because the ability to perform a GET is not affected by a write lock. Havingserver SHOULD return alock token102 "Processing" response. 9.2 207 Multi-Status The response providesno special access rights. Anyone can find out anyone else's lock token by performing lock discovery. Locks arestatus for multiple independent operations. 9.3 422 Unprocessable Entity The server understands the content type of the request entity, but was unable tobe enforced based upon whatever authentication mechanism is used byprocess theserver, not basedcontained instructions. 9.4 423 Insufficient Space on Resource The resource does not have sufficient space to record thesecrecystate of thetoken values. 9.11. Lock-Token Response Header INTERNET-DRAFT WebDAV November 19, 1997 Lock-Token = "Lock-Token" ":" Coded-URL If aresourceis successfully locked then a Lock-Token header will be returned containing the lock token that represents the lock. 9.12. Overwrite Header Overwrite = "Overwrite" ":" ("T" | "F") The Overwrite header specifies whether the server should overwriteafter thestateexecution of this method. 9.5 424 Method Failure The method was not executed on anon-null destinationparticular resourceduring a COPY or MOVE. A valuewithin its scope because some part of_F_ states thattheserver MUST NOT performmethod's execution failed causing theCOPY or MOVE operationentire method to be aborted. For example, ifthe statea resource could not be moved as part of a MOVE method, all the other resources would fail with a 424 Method Failure. 9.6 425 Locked The source or destination resourceis non-null. By default, the valueofOverwritea method is_T,_locked, and either the request did not contain aclient MAY omit thisvalid Lock-Token header, or the lock token in the Lock-Token headerfromidentifies arequest when its valuelock held by another principal. 10 Multi-Status Response The default 207 Multi-Status response body is_T._ Whilea text/xml HTTP entity that contains a single XML element called multistatus, which contains a set of XML elements called response, one for each 200, 300, 400, and 500 series status code generated during theOverwrite header appears to duplicatemethod invocation. 100 series status codes MUST NOT be recorded in a response XML element. 11 XML Element Definitions In thefunctionalitysection below, the final line of each section gives theIf- Match: * headerelement type declaration using the format defined in [Bray, Paoli, Sperberg-McQueen, 1998]. The "Value" field, where present, specifies futher restrictions on the allowable contents ofHTTP/1.1, If-Match applies only totheRequest- URI, and notXML element using BNF (i.e., to further restrict theDestinationvalues of aCOPY or MOVE. IfPCDATA element). Goland et al. [Page 55] INTERNET-DRAFT WebDAV January 18, 1998 11.1 activelock XML Element Name: activelock Namespace: http://www.iana.org/standards/dav/ Purpose: Describes aCOPY or MOVE is not performed due to thelock on a resource. <!ELEMENT activelock (locktype, lockscope, depth?, owner, timeout, locktoken) > 11.1.1 depth XML Element Name: depth Namespace: http://www.iana.org/standards/dav/ Purpose: The value of theOverwrite header, the method MUST fail with a 409 Conflict status code. 9.13. Propfind Request Header Propfind = "Propfind" ":" ("allprop" | "propname" | RFC-Reg | 1*(Property-Name)) The Propfinddepth headerisused tospecify which properties are to be returnedcreate a lock. Description: If this element is not included in aPROPFIND method. The properties are identified by their URIs. Two special tokens are defined for use withlockinfo element then thePropfind header, allprop and propname. The allprop token specifiesclient MUST assume thatall property names and values ontheresource are to be returned.lock is of depth 0. Value: "0" | "infinity" <!ELEMENT depth (#PCDATA) > 11.1.2 locktoken XML Element Name: locktoken Namespace: http://www.iana.org/standards/dav/ Purpose: Thepropnamelock tokenspecifies that onlyassociated with alist of property names onlock. Description: The href contains an opaque lock token URI (i.e., theresource are to be returned. 9.14. Status-URI Response HeaderOpaqueLockToken-URI production in Section 4.4). <!ELEMENT locktoken (href) > 11.1.3 timeout XML Element Name: timeout Namespace: http://www.iana.org/standards/dav/ Purpose: TheStatus-URI response header MAY be usedtimeout associated with a lock Value: TimeType <!ELEMENT timeout (#PCDATA) > 11.2 collection XML Element Name: collection Namespace: http://www.iana.org/standards/dav/ Purpose: Identifies the102 Processing response code to inform the clientassociated resource astoa collection. The resourcetype property of a collection resource MUST have this value. <!ELEMENT collection EMPTY > 11.3 href XML Element Name: href Goland et al. [Page 56] INTERNET-DRAFT WebDAV January 18, 1998 Namespace: http://www.iana.org/standards/dav/ Purpose: Identifies thestatuscontent of the element as amethod. Status-URI = "Status-URI" ":" *(Status-Code "<"URI. Value: URI">");Status- Code is defined in 6.1.1See section 3.2.1 of [Fielding et al., 1997]The URIs listed in<!ELEMENT href (#PCDATA)> 11.4 link XML Element Name: link Namespace: http://www.iana.org/standards/dav/ Purpose: Identifies theheader are source resources which have been affected byproperty as a link and contains theoutstanding method.source and destination of that link. Description: Thestatus code indicateslink XML element is used to provide theresolutionsources and destinations of a link. The name of themethod onproperty containing theidentified resource. So, for example, if a MOVE method on a collectionlink XML element provides the type of the link. Link isoutstanding anda102 "Processing" responsemulti- valued element, so multiple links may be used together to indicate multiple links witha Status-URI response header is returned,theincluded URIs will indicate resources that have had move attempted on them and whatsame type. <!ELEMENT link (src+, dst+) > 11.4.1 dst XML Element Name: dst Namespace: http://www.iana.org/standards/dav/ Purpose: Indicates theresult was. 9.15. Timeout Header INTERNET-DRAFT WebDAV November 19, 1997 TimeOut = "Timeout" ":" 1#TimeType TimeType = ("Second-" DAVTimeOutVal | "Infinite" | Other) DAVTimeOutVal = 1*digit Other = Extend field-value ; See section 4.2destination ofRFC 2068 Clients MAY include Timeout headers in their LOCK requests. However, the server is not required to honor or even consider these requests. Clients MUST NOT submit a Timeout request header with any method other thanaLOCK method. A Timeout request header MUST contain at least one TimeType and MAY contain multiple TimeType entries. The purpose of listing multiple TimeType entries is to indicate multiple different values and value types that are acceptable to the client. The client listslink Value: URI <!ELEMENT dst (#PCDATA) > 11.4.2 src XML Element Name: src Namespace: http://www.iana.org/standards/dav/ Purpose: Indicates theTimeType entries in ordersource ofpreference. The Timeout response header MUST use a Second value, Infinite, oraTimeTypelink. Value: URI <!ELEMENT src (#PCDATA) > 11.5 lockentry XML Element Name: lockentry Namespace: http://www.iana.org/standards/dav/ Purpose: Defines theclient has indicated familiarity with.types of locks that can be used with the resource. <!ELEMENT lockentry (lockscope, locktype) > 11.6 lockinfo XML Element Name: lockinfo Namespace: http://www.iana.org/standards/dav/ Goland et al. [Page 57] INTERNET-DRAFT WebDAV January 18, 1998 Purpose: Theserver MAY assume a clientlockinfo XML element isfamiliarused withany TimeType submitted inaTimeout header. The _Second_ TimeType specifiesLOCK method to specify thenumber of seconds that MUST elapse between grantingtype ofthelockat the server, and the automatic removal ofthelock. A server MUST not generateclient wishes to have created. <!ELEMENT lockinfo (lockscope, locktype, owner?) > 11.7 lockscope XML Element Name: lockscope Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies whether atimeout value for _Second_ greater than 2^32-1. The timeout counterlock isrestarted any timeanowner of theexclusive lock, or a shared lock. <!ELEMENT lockscope (exclusive | shared) > 11.7.1 exclusive XML Element Name: exclusive Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies an exclusive locksends<!ELEMENT exclusive EMPTY > 11.7.2 shared XML Element Name: shared Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies amethod to any member ofshared lock <!ELEMENT shared EMPTY > 11.8 locktype XML Element Name: locktype Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies thelock, including unsupported methods, or methods which are unsuccessful. It is recommended thataccess type of a lock. At present, this specification only defines one lock type, theHEAD method be used whenwrite lock. <!ELEMENT locktype (write) > 11.8.1 write XML Element Name: write Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies a write lock. <!ELEMENT write EMPTY > 11.9 multistatus XML Element Name: multistatus Namespace: http://www.iana.org/standards/dav/ Purpose: Contains multiple response messages. Goland et al. [Page 58] INTERNET-DRAFT WebDAV January 18, 1998 Description: The responsedescription at thegoaltop level issimplyused torestart the timeout counter. Ifprovide a general message describing thetimeout expires thenoverarching nature of thelockresponse. If this value islost. Specifically the server SHOULD act as ifavailable anUNLOCK method was executed byapplication MAY use it instead of presenting theserver onindividual response descriptions contained within theresource usingresponses. <!ELEMENT multistatus (response+, responsedescription?) > 11.9.1 response XML Element Name: response Namespace: http://www.iana.org/standards/dav/ Purpose: Holds a single response describing thelock tokeneffect ofthe timed-out lock, performed witha method on resource and/or itsoverride authority. Thus logs should be updated with the disposition of the lock, notifications should be sent, etc., justproperties. Description: A particular href MUST NOT appear more than once asthey would be for an UNLOCK request. Servers are advised to pay close attention tothevalues submitted by clients, as they will be indicative of the typechild ofactivity the client intends to perform. For example, an applet running in a browser may need to lockaresource, but because of the instability of the environment within which the applet is running, the applet may be turned off without warning. Asresponse XML element under aresult, the appletmultistatus XML element. This requirement islikelynecessary in order toaskkeep processing costs for arelatively small timeout value so that if the applet dies,response to linear time. Essentially, this prevents having to search in order to group together all thelock can be quickly harvested. However,responses by href. There are, however, no requirements regarding ordering based on href values. <!ELEMENT response (href, ((href*, status)|(propstat+)), responsedescription?) > 11.9.1.1 propstat XML Element Name: propstat Namespace: http://www.iana.org/standards/dav/ Purpose: Groups together adocument management systemprop and status element that islikely to ask for an extremely long timeout because its userassociated with a particular href element. Description: Prop MUST contain one or more empty XML elements representing the names of properties. Multiple properties may beplanning on going off-line. INTERNET-DRAFT WebDAV November 19, 1997 10. Response Code Extensions to HTTP/1.1 The followingincluded if the same responsecodes are addedapplies tothosethem all. <!ELEMENT propstat (prop, status) > 11.9.1.2 status XML Element Name: status Namespace: http://www.iana.org/standards/dav/ Purpose: Holds a single HTTP status-line Value: status-line ;status-line defined inHTTP/1.1[Fielding et al.,1997]. 10.1. 102 Processing Methods can potentially take1997] <!ELEMENT status (#PCDATA) > 11.9.2 responsedescription XML Element Name: responsedescription Namespace: http://www.iana.org/standards/dav/ Goland et al. [Page 59] INTERNET-DRAFT WebDAV January 18, 1998 Purpose: Contains along period of time to process, especially methodsmessage thatsupportcan be displayed to theDepth header. In such casesuser explaining theclient may time-outnature of theconnection while waiting for aresponse.To prevent this the server MAY return a 102 response codeDescription: This XML element provides information suitable toindicatebe presented to a user. <!ELEMENT responsedescription (#PCDATA) > 11.10 owner XML Element Name: owner Namespace: http://www.iana.org/standards/dav/ Purpose: Provides information about theclient thatprincipal taking out a lock. Description: The owner XML element provides information sufficient for either directly contacting a principal (such as a telephone number or Email URI), or for discovering theserver is still processingprincipal (such as themethod. IfURL of amethod is taking longer than 20 seconds (a reasonable, but arbitrary value)homepage) who owns a lock. <!ELEMENT owner (#PCDATA, ANY)* > 11.11 prop XML element Name: prop Namespace: http://www.iana.org/standards/dav/ Purpose: Contains properties related toprocess the server SHOULD returna102 "Processing" response. 10.2. 207 Multi-Statusresource. Description: Theresponse requires providing statusprop XML element is a generic container formultiple independent operations. 10.3. 418 Unprocessable Entity The server understandsproperties defined on resources. All elements inside prop MUST define properties related to thecontent typeresource. No other elements may be used inside of a prop element. <!ELEMENT prop ANY> 11.12 propertybehavior XML element Name: propertybehavior Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies how properties are handled during a COPY or MOVE. Description: The propertybehavior XML element specifies how properties are handled during a COPY or MOVE. If this XML element is not included in the requestentity, but was unable to processbody then thecontained instructions. 10.4. 419 Insufficient Space on Resource The resource does not have sufficient spaceserver is expected torecordact as defined by thestatedefault property handling behavior of theresource afterassociated method. <!ELEMENT propertybehavior (omit | keepalive) > 11.12.1 keepalive XML element Name: keepalive Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies requirements for theexecutioncopying/moving ofthis method. 10.5. 420 Method Failure The method was not executed onlive properties. Goland et al. [Page 60] INTERNET-DRAFT WebDAV January 18, 1998 Description: If aparticular resource within its scope because some partlist of URIs is included as themethod's execution failed causingvalue of keepalive then theentire method to be aborted. For example, if a resource could notnamed properties MUST bemoved as part of a MOVE method, all"live" after they are copied (moved) to theother resources would fail with a 420 Method Failure. 10.6. 421 Destination Locked Thedestination resource of amethod is locked, and either the request did not contain a valid Lock-Info header, orCOPY (or MOVE). If theLock-Info header identifies a lock held by another principal. 11. Multi-Status Response The default 207 Multi-Status response bodyvalue "*" isa text/xml HTTP entity that contains a single XML element called multistatus, which contains a set of XML elements called response, onegiven foreach 200, INTERNET-DRAFT WebDAV November 19, 1997 300, 400, and 500 series status code generated duringthemethod invocation. 100 series status codeskeepalive XML element, this designates that all live properties on the source resource MUSTNOTberecorded in a response XML element. 11.1. multistatuslive on the destination. Value: "*" ; #PCDATA value can only be "*" <!ELEMENT keepalive (#PCDATA | href+) > 11.12.2 omit XMLElementelement Name:multistatusomit Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:Contains multiple response messages. Parent: Any Value: 1*response [responsedescription] Description: The responsedescription atIndicates that thetop levelassociated method MAY succeed even if the server isusednot able toprovide a general message describing the overarching nature ofcopy/move every property on theresponse. If this valuesource resource, even in a dead form. Description: The default behavior for a COPY or MOVE isavailable an application MAY use it instead of presenting the individual response descriptions contained within the responses. 11.2. response XML Element Name: response Namespace: http://www.ietf.org/standards/dav/ Purpose: Holds a single response Parent: multistatus Value: href [prop] status [responsedescription] Description: Prop MUST contain oneto copy/move all properties ormore empty XML elements representingfail thenames of properties. Multiple propertiesmethod. In certain circumstances, such as when a server copies a resource over another protocol such as FTP, it may not beincluded if the same response appliespossible tothem all. If href is used thencopy/move theresponse refers to a problemproperties associated with thereferenced resource,resource. Thus any attempt to copy/move over FTP would always have to fail because properties could nota property. 11.3. statusbe moved over, even as dead properties. The omit XMLElement Name: status Namespace: http://www.ietf.org/standards/dav/ Purpose: Holdselement instructs the server that it should use best effort to copy properties but asingle HTTP status-line Parent: response Value: status-line ;status-line defined in [Fielding et al., 1997] 11.4. responsedescriptionfailure to copy a property should not cause the method to fail. <!ELEMENT omit EMPTY > 11.13 propertyupdate XMLElementelement Name:responsedescriptionpropertyupdate Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose: Contains amessage that can be displayedrequest to alter theuser explaining the nature of the response. Parent: multistatus | response Value: Anyproperties on a resource. Description: This XML elementprovidesis a container for the informationsuitable to be presentedrequired toa user. 12. Generic DAV XML Elements INTERNET-DRAFT WebDAV November 19, 1997 12.1. href XML Element Name: href Namespace: http://www.ietf.org/standards/dav/ Purpose: To identify thatmodify thecontent ofproperties on the resource. This XML element isa URI. Parent: Any Value: URI ; See section 3.2.1 of [Fielding et al., 1997] 12.2. linkmulti-valued. <!ELEMENT propertyupdate (remove | set)+ > 11.13.1 remove XMLElementelement Name:linkremove Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:To identify a property as a link and to containLists thesource and destination of that link. Values= 1*src 1*dst Description: Link is usedDAV properties toprovidebe removed from a resource. Description: Remove instructs that thesources and destinationsproperties specified in prop should be removed. Specifying the removal of alink. The typeproperty that does not exist is not an error. All the XML elements in prop MUST be empty, as only the names of properties to be removed are required. <!ELEMENT remove (prop) > Goland et al. [Page 61] INTERNET-DRAFT WebDAV January 18, 1998 11.13.2 set XML element Name: set Namespace: http://www.iana.org/standards/dav/ Purpose: Lists the DAV propertycontaining the linkvalues to be set for a resource. Value: prop Description: This XML elementprovidesMUST contain only a prop XML element. The elements contained by prop specify thetypename and value of properties that are set on thelink. Link isRequest-URI. If amulti-valued element, so multiple Links may be used togetherproperty already exists then its value is replaced. <!ELEMENT set (prop) > 11.14 propfind XML Element Name: propfind Namespace: http://www.iana.org/standards/dav/ Purpose: Specifies the properties toindicate multiple linksbe returned from a PROPFIND method. Two special elements are specified for use withthe same type. 12.2.1. srcpropfind, allprop and propname. <!ELEMENT propfind (allprop | propname | href+) > 11.14.1 allprop XML Element Name:srcallprop Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:To indicateThe allprop XML element specifies that all property names and values on thesource of a link. Parent: link Values= URI 12.2.2. dstresource are to be returned. <!ELEMENT allprop EMPTY > 11.14.2 propname XML Element Name:dstpropname Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:To indicatethedestination ofpropname XML element specifies that only alink Parent: link Values= URI 12.2.3. Example <?XML version="1.0"> <?namespace href = "http://www.ietf.org/standards/dav/" AS = "D"?> <?namespace href = "http://www.foocorp.com/Project/" AS = "F"?> <D:prop> <D:Source> <D:link> <F:projfiles>Source</F:projfiles> <D:src>http://foo.bar/program</D:src> <D:dst>http://foo.bar/src/main.c</D:dst> </D:link> <D:link> <F:projfiles>Library</F:projfiles> INTERNET-DRAFT WebDAV November 19, 1997 <D:src>http://foo.bar/program</D:src> <D:dst>http://foo.bar/src/main.lib</D:dst> </D:link> <D:link> <F:projfiles>Makefile</F:projfiles> <D:src>http://foo.bar/program</D:src> <D:dst>http://foo.bar/src/makefile</D:dst> </D:link> </D:Source> </D:prop> In this example the resource http://foo.bar/program has a source property that contains three links. Each link contains three elements, two of which, src and dst, are partlist of property names on theDAV schema defined in this document, and one whichresource isdefined by the schema http://www.foocorp.com/project/ (Source, Library, and Makefile). A client which only implements the elements in theto be returned. <!ELEMENT propname EMPTY > 12 DAVspec will not understand the foocorp elements and will ignore them, thus seeing the expected source and destination links. An enhanced client may know aboutProperties For DAV properties, thefoocorp elements and be able to presentname of theuser with additional information aboutproperty is also thelinks. This example demonstratessame as thepowername of the XMLmarkup that allows forelementvalues to be enhanced without breaking older clients. 12.3. prop XMLwhich contains its value. In the section below, the final line of each section gives the elementName: prop Namespace: http://www.ietf.org/standards/dav/ Purpose: Contains properties related to a resource. Parent: Any Values: XML Elements Description:type declaration using the format defined in [Bray, Paoli, Sperberg- McQueen, 1998]. Theprop"Value" field, where present, specifies futher restrictions on the allowable contents of the XML elementis a generic container for properties defined on resources. All elements inside prop MUST define properties relatedusing BNF (i.e., to further restrict theresource. No other elements may be used insidevalues of aprop element. 13. DAV Properties 13.1.PCDATA element). Goland et al. [Page 62] INTERNET-DRAFT WebDAV January 18, 1998 12.1 creationdate Property Name: creationdate Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:TheRecords the time and date the resource was created. Value:The;The time and date MUST be given in ISO 8601 format[ISO8601]defined in Appendix 2 Description: This property SHOULD be defined on all DAV compliant resources. If present, it contains a timestamp of the moment when the resource was created (i.e., the moment it had non-null state).13.2.<!ELEMENT creationdate (#PCDATA) > 12.2 displayname PropertyINTERNET-DRAFT WebDAV November 19, 1997Name: displayname Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:AProvies a name for the resource that is suitable for presentation to a user.Value: Any valid XML character data (as defined in [Bray, Sperberg-McQueen, 1997]) Description:ThisDescription: This property SHOULD be defined on all DAV compliant resources. If present, the property contains a description of the resource that is suitable for presentation to a user.13.3. get-content-language<!ELEMENT displayname (#PCDATA) > 12.3 externalmembers Property Name:get-content-languageexternalmembers Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:ContainsProvides theContent-Language header returned by a GET without accept headers. If no Content-Language header is available, this property MUST NOTlist of external members defined on the resource. Description: This property MUST be defined on any DAV compliant resource with external members. If defined it MUST contain the full list of external members. Resources MAY make this property read- only, thus only allowing its value to be altered using the ADDREF/DELREF methods. <!ELEMENT externalmembers (href*) > 12.4 getcontentlanguage Property Name: getcontentlanguage Namespace: http://www.iana.org/standards/dav/ Purpose: Contains the Content-Language header returned by a GET without accept headers Description: This property MUST be defined on any DAV compliant resource which supports GET, with the exception that if no Content- Language header is available, this property MUST NOT exist. Value: language-tag ;language-tag is defined in section 14.13 ofRFC 2068 13.4. get-content-length[Fielding et al., 1997] Goland et al. [Page 63] INTERNET-DRAFT WebDAV January 18, 1998 <!ELEMENT getcontentlanguage (#PCDATA) > 12.5 getcontentlength Property Name:get-content-lengthgetcontentlength Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose: Contains the Content-Length header returned by a GET without accept headers. If no Content-Length header is available, this property MUST NOT exist. Description: This property MUST be defined on any DAV compliant resource which returns the Content-Length header in response to a GET. Value: content-length ; see section 14.14 ofRFC 2068 13.5. get-content-type[Fielding et al., 1997] <!ELEMENT getcontentlength (#PCDATA) > 12.6 getcontenttype Property Name:get-content-typegetcontenttype Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose: Contains the Content-Type header returned by a GET without accept headers. If no Content-Type header is available, this property MUST NOT exist. Description: This property MUST be defined on any DAV compliant resource which returns the Content-Type header in response to a GET. Value: media-type ; defined in Section 3.7 of [Fielding et al., 1997]13.6. get-etag<!ELEMENT getcontenttype (#PCDATA) > 12.7 getetag Property Name:get-etaggetetag Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose: Contains the ETag header returned by a GET without accept headers.If no ETag header is available, this property MUST NOT exist. Value: entity-tag ; defined in Section 3.11 of [Fielding et al., 1997] Description:NoteDescription: Note that the ETag onsomea resource may reflect changes in any part of the state of the resource, not necessarily just a change to the response to the GET method. For example, a changein the ACLto a resource's access permissions may cause the ETag to change.INTERNET-DRAFT WebDAV November 19, 1997 13.7. get-last-modified Property Name: get-last-modified Namespace: http://www.ietf.org/standards/dav/ Purpose: ContainsThis property MUST be defined on any DAV compliant resource which returns theLast-ModifiedEtag headerreturned byin response to aGET method without accept headers. IfGET, except for the case if noLast-ModifiedETag header isavailable,returned, this property MUST NOT exist. Value:HTTP-dateentity-tag ; defined in Section3.3.13.11 of [Fielding et al., 1997]Description:Note<!ELEMENT getetag (#PCDATA) > 12.8 getlastmodified Property Name: getlastmodified Goland et al. [Page 64] INTERNET-DRAFT WebDAV January 18, 1998 Namespace: http://www.iana.org/standards/dav/ Purpose: Contains the Last-Modified header returned by a GET method without accept headers. Description: Note that the last-modified date onsomea resource may reflect changes in any part of the state of the resource, not necessarily just a change to the response to the GET method. For example, a change in a property may cause the last-modified date to change.13.8. index-content-language Property Name: index-content-language Namespace: http://www.ietf.org/standards/dav/ Purpose: Contains the Content-Language header returned by an INDEX without accept headers. If no Content-Language header is available, thisThis property MUSTNOT exist. Value: language-tag ;language-tag isbe definedin section 14.13 of RFC 2068 13.9. index-content-length Property Name: index-content-length Namespace: http://www.ietf.org/standards/dav/ Purpose: Containson any DAV compliant resource which returns theContent-Length header returned by an INDEX without accept headers. If no Content-LengthLast-Modified headeris available, this property MUST NOT exist. Value: content-length ; see section 14.14 of RFC 2068 13.10. index-content-type Property Name: index-content-type Namespace: http://www.ietf.org/standards/dav/ Purpose: Containsin response to a GET, except for theContent-Type header returned by an INDEX without accept headers. Ifcase if noContent-TypeLast-Modified header isavailable,returned, this property MUST NOT exist. Value:media-typeHTTP-date ; defined in Section3.73.3.1 of [Fielding et al., 1997]13.11. index-etag<!ELEMENT getlastmodified (#PCDATA) > 12.9 lockdiscovery Property Name:index-etaglockdiscovery Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:Contains the ETag header returned by an INDEX without accept headers. If no ETag header is available, this property MUST NOT exist. INTERNET-DRAFT WebDAV November 19, 1997 Value: entity-tag ; defined in Section 3.11 of [Fielding et al., 1997] Description:Note thatDescribes theETagactive locks onsomea resourcemay reflect changes in any partDescription: The lockdiscovery property returns a listing ofthe statewho has a lock, what type of lock he has, theresource, not necessarily just a change totimeout type and theresponse totime remaining on theINDEX method. For example, a change intimeout, and theACL may causeassociated lock token. The server is free to withhold any or all of this information if theETagrequesting principal does not have sufficient access rights tochange. 13.12. index-last-modified Property Name: index-last-modified Namespace: http://www.ietf.org/standards/dav/ Purpose: Contains the Last-Modified header returned by an INDEX method without accept headers. If no Last-Modified header is available, this property MUST NOT exist. Value: HTTP-date ; defined in Section 3.3.1 of [Fielding et al., 1997] Description:Note that the last-modified date on some resource may reflect changes in any part of the state of the resource, not necessarily just a change to the response to the INDEX method. For example, a change in a property may cause the last-modified date to change. 13.13. lockdiscovery Property Name: lockdiscovery Namespace: http://www.ietf.org/standards/dav/ Purpose: To discover what locks are active on a resource Values= *activelock Description:The lockdiscovery property returns a listing of who has a lock, what type of lock he have, the timeout type and the time remaining on the timeout, and the associated lock token. The server is free to withhold any or all of this information if the requesting principal does not have sufficient access rights to seesee the requested data. A server which supports locks MUST provide the lockdiscovery property on any resource with locks on it.13.13.1. activelock XML Element Name: activelock Namespace: http://www.ietf.org/standards/dav/ Purpose: A multivalued XML element that describes a particular active lock on a resource Parent:<!ELEMENT lockdiscoveryValues= locktype lockscope [addlocks] owner timeout locktoken 13.13.2. owner XML Element Name: owner Namespace: http://www.ietf.org/standards/dav/ Purpose: Returns owner information Parent: activelock Values= XML:REF | *PCDATA INTERNET-DRAFT WebDAV November 19, 1997 13.13.3. timeout XML Element Name: timeout Namespace: http://www.ietf.org/standards/dav/ Purpose: Returns information about the timeout associated with the lock Parent: activelock Values= TimeType 13.13.4. addlocks XML Element Name: addlocks Namespace: http://www.ietf.org/standards/dav/ Purpose: Lists additional resources associated with this lock, if any. Parent: activelock Values= 1*href 13.13.5. locktoken XML Element Name: locktoken Namespace: http://www.ietf.org/standards/dav/ Purpose: Returns the lock token Parent: activelock Values= href Description:The href contains a Lock-Token-URL. 13.13.6.(activelock)* > 12.9.1 Example >>Request PROPFIND /container/ HTTP/1.1 Host: www.foo.bar Content-Length: xxxx Content-Type: text/xml<?XML version="1.0"><?xml version="1.0"?> <?namespacehref = "http://www.ietf.org/standards/dav/" AS = "D"?>href="http://www.iana.org/standards/dav/" as="D"?> <D:propfind> <D:prop><lockdiscovery/></D:prop> </D:propfind> >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx<?XML version="1.0">Goland et al. [Page 65] INTERNET-DRAFT WebDAV January 18, 1998 <?xml version="1.0"?> <?namespace href="http://www.ietf.org/standards/dav/" AS = "D"?>="http://www.iana.org/standards/dav/" as="D"?> <D:multistatus> <D:response> <D:propstat> <D:prop> <D:lockdiscovery> <D:activelock>INTERNET-DRAFT WebDAV November 19, 1997<D:locktype>write</D:locktype> <D:lockscope>exclusive</D:lockscope><D:addlocks> <D:href>http://foo.com/doc/</D:href> </D:addlocks><D:Depth>0</D:Depth> <D:owner>Jane Smith</D:owner> <D:timeout>Infinite</D:timeout> <D:locktoken><D:href>iamuri:unique!!!!!</D:href><D:href> opaquelocktoken:f81de2ad-7f3d-a1b2-4f3c-00a0c91a9d76 </D:href> </D:locktoken> </D:activelock> </D:lockdiscovery> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> </D:response> </D:multistatus> This resource has a single exclusive write lock on it, with an infinite timeout.This same lock also coversNote that theresource http://foo.com/doc/. 13.14.Depth element could have been omitted as 0 is the default value of Depth. 12.10 resourcetype Property Name: resourcetype Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose:This property contains a series of XML elements that specify information regardingSpecifies the nature of the resource. Description: Thisspecification only defines a single value, collection. Value: XML elements Description:Thisproperty MUST be defined on all DAV compliant resources. The default value is empty.13.14.1. collection XML Element Name: collection Namespace: http://www.ietf.org/standards/dav/ Purpose: Identifies the associated resource as a collection. Collection resources MUST define this value with the resourcetype property. Parent:<!ELEMENT resourcetypeValues: None 13.15. Source LinkANY > 12.11 source PropertyTypeName: source Namespace:http://www.ietf.org/standards/dav/link/http://www.iana.org/standards/dav/link/ Purpose: The destination of the source link identifies the resource that contains the unprocessed source of the link's source.Parent: None Value: An XML document with zero or more link XML elements. INTERNET-DRAFT WebDAV November 19, 1997 Discussion:Description: The source of the link (src) is typically the URI of the output resource on which the link is defined, and there is typically only one destination (dst) of the link, which is the URI where the unprocessed source of the resource may be accessed. When more than one link destination exists, this specification asserts no policy on ordering.13.16.Goland et al. [Page 66] INTERNET-DRAFT WebDAV January 18, 1998 <!ELEMENT source (link)* > 12.11.1 Example <?xml version="1.0"?> <?namespace href="http://www.iana.org/standards/dav/" as="D"?> <?namespace href="http://www.foocorp.com/Project/" as="F"?> <D:prop> <D:source> <D:link> <F:projfiles>Source</F:projfiles> <D:src>http://foo.bar/program</D:src> <D:dst>http://foo.bar/src/main.c</D:dst> </D:link> <D:link> <F:projfiles>Library</F:projfiles> <D:src>http://foo.bar/program</D:src> <D:dst>http://foo.bar/src/main.lib</D:dst> </D:link> <D:link> <F:projfiles>Makefile</F:projfiles> <D:src>http://foo.bar/program</D:src> <D:dst>http://foo.bar/src/makefile</D:dst> </D:link> </D:source> </D:prop> In this example the resource http://foo.bar/program has a source property that contains three links. Each link contains three elements, two of which, src and dst, are part of the DAV schema defined in this document, and one which is defined by the schema http://www.foocorp.com/project/ (Source, Library, and Makefile). A client which only implements the elements in the DAV spec will not understand the foocorp elements and will ignore them, thus seeing the expected source and destination links. An enhanced client may know about the foocorp elements and be able to present the user with additional information about the links. This example demonstrates the power of XML markup, allowing element values to be enhanced without breaking older clients. 12.12 supportedlock Property Name: supportedlock Namespace:http://www.ietf.org/standards/dav/http://www.iana.org/standards/dav/ Purpose: To provide a listing of the lock capabilities supported by the resource.Values: An XML document containing zero or more LockEntry XML elements. Description:TheDescription: The supportedlock property of a resource returns a listing of the combinations of scope and access types which may be specified in a lock request on the resource. Note that the actual contents are themselves controlled by access controls so a server is not required to provide information the client is not authorized to Goland et al. [Page 67] INTERNET-DRAFT WebDAV January 18, 1998 see. If supportedlock is available on_*_"*" then it MUST define the set of locks allowed on all resources on that server.13.16.1. lockentry XML Element Name: lockentry Namespace: http://www.ietf.org/standards/dav/ Purpose: Defines a DAVLockType/LockScope pair that may be legally used with a LOCK on the specified resource. Parent:<!ELEMENT supportedlockValues= locktype lockscope 13.16.2. locktype XML Element Name: locktype Namespace: http://www.ietf.org/standards/dav/ Purpose: Lists a DAVLockType Parent: lockentry Values= DAVLockTypeValue 13.16.3. lockscope XML Element Name: lockscope Namespace: http://www.ietf.org/standards/dav/ Purpose: Lists a DAVLockScope Parent: lockentry Values: DAVLockScopeValue 13.16.4.(lockentry)* > 12.12.1 Example >>Request PROPFIND /container/ HTTP/1.1 Host: www.foo.barINTERNET-DRAFT WebDAV November 19, 1997Content-Length: xxxx Content-Type: text/xml<?XML version="1.0"><?xml version="1.0"?> <?namespacehref = "http://www.ietf.org/standards/dav/" AS = "D"?>href="http://www.iana.org/standards/dav/" as="D"?> <D:propfind> <D:prop><supportedlock/></D:prop> </D:propfind> >>Response HTTP/1.1 207 Multi-Status Content-Type: text/xml Content-Length: xxxxx<?XML version="1.0"><?xml version="1.0"?> <?namespace href="http://www.ietf.org/standards/dav/" AS = "D"?>="http://www.iana.org/standards/dav/" as="D"?> <D:multistatus> <D:response> <D:propstat> <D:prop> <D:supportedlock> <D:LockEntry><D:locktype>Write</D:locktype> <D:lockscope>Exclusive</D:lockscope><D:locktype><D:Write/></D:locktype> <D:lockscope><D:Exclusive/></D:lockscope> </D:LockEntry> <D:LockEntry><D:locktype>Write</D:locktype> <D:lockscope>Shared</D:lockscope><D:locktype><D:Write/></D:locktype> <D:lockscope><D:Shared/></D:lockscope> </D:LockEntry> </D:supportedlock> </D:prop> <D:status>HTTP/1.1 200 OK</D:status> </D:propstat> </D:response> </D:multistatus>14.13 DAV ComplianceLevelsClasses Goland et al. [Page 68] INTERNET-DRAFT WebDAV January 18, 1998 A DAV compliant resource can choose from twolevelsclasses of compliance. A client can discoverwhich levelthe compliance classes of a resourcesupportsby executing OPTIONS on the resource, and examining the "DAV" header which is returned. Since this document describes extensions to the HTTP/1.1 protocol, minimally all DAV compliant resources, clients, and proxies MUST be compliant withRFC 2068[Fielding et al., 1997].14.1. LevelCompliance classes are not necessarily sequential. A resource that is class 2 compliant MUST also be class 1 compliant; but if additional compliance classes are defined later, a resource that is class 1, 2, and 4 compliant might not be class 3 compliant. 13.1 Class 1 Alevelclass 1 compliant resource MUST meet all "MUST" requirements in all sections of this document.14.2. LevelClass 1 compliant resources MUST return, at minimum, the value "1" in the DAV header on all responses to the OPTIONS method. 13.2 Class 2INTERNET-DRAFT WebDAV November 19, 1997Alevelclass 2 compliant resource MUST meet alllevelclass 1 requirements and support the supportedlock property as well as the LOCK method.15.It MUST also support the lockdiscovery property, since Section 12.9 specifies that the LOCK method MUST also support the lockdiscovery property. Class 2 compliant resources MUST return, at minimum, the value "2" in the DAV header on all responses to the OPTIONS method. 14 Internationalization Considerations In the realm ofinternationalization issues,internationalization, this specificationis substantively in compliancecomplies with the IETF Character Set Policy [Alvestrand,1997].1998]. In this specification, human-readable fields can be foundineither in the value of a property, or in an error message returned in a response entity body. In both cases, thehuman- readablehuman-readable content is encoded using XML, which has explicit provisions for character set tagging and encoding, and requiresby defaultthat XML processors read XML elements encoded using the UTF-8 and UCS-2 encodings of the ISO 10646 basic multilingual plane. Furthermore, XML contains provisions for encoding XML elements using other encoding schemes, notable among them UCS-4, which permits encoding of characters from any ISO 10646 character plane. The default character set encoding for XML data in this specification, and in general, is UTF-8. WebDAV compliant applications MUST support the UTF-8 and UCS-2 character set Goland et al. [Page 69] INTERNET-DRAFT WebDAV January 18, 1998 encodings for XML elements, and SHOULD support the UCS-4 encoding. The XML character set encoding declaration for each supported character set MUST also be supported, since it is by using this encoding declaration that an XML processor determines the encoding of an element. XML also provides a language tagging capabilitywhich provides the ability to specifyfor specifying the language of the contents of a particular XML element.Although XML, and hence WebDAV, does not use RFC 1766XML uses either IANA registered language tagsfor its(see RFC 1766, [Alvestrand, 1995]) or ISO 639 languagenames,tags [ISO-639] in thebenefit"xml:lang" attribute ofusing standardan XMLin this context outweighselement to identify theadvantage of using RFC 1766languagetags.its content and attributes. Names used within this specification fall intotwothree categories: namesspecific toof protocol elements such as methods and headers, names of XML elements, and names of properties. Naming of protocol elements follows the precedent of HTTP, using English names encoded in USASCII for methods and headers. Since these protocol elements are not visible to users, and are in fact simply long token identifiers, they do not need to support encoding in multiple character sets. Similarly, though the names of XML elements used in this specification are English names encoded in UTF-8, these names are not visible to the user, and hence do not need to support multiple character set encodings. The name of a property defined on a resource is a URI. Although some applications (e.g., a generic property viewer) will display property URIs directly to their users, it is expected that the typical application will use a fixed set of properties, and will provide a mapping from the property name URI to a human-readableINTERNET-DRAFT WebDAV November 19, 1997field when displaying the property name to a user. It is only in the case where the set of properties is not known ahead of time that an application need display a property name URI to a user. We recommend that applications provide human-readable property names wherever feasible. For error reporting, we follow the convention of HTTP/1.1 status codes, including with each status code a short, English description of the code (e.g.,421 Destination425 Locked). While the possibility exists that a poorly crafted user agent would display this message to a user, internationalized applications will ignore this message, and display an appropriate message in the user's language and character set. Since interoperation of clients and servers does not require locale information, this specification does not specify any mechanism for transmission of this information.16.15 Security Considerations[TBD] 17. Terminology Collection - A resource that contains member resources. Member Resource - A resource contained by a collection. There are two types of member resources: external and internal. Internal Member Resource _ A member resource of a collection whose URIThis section isrelativeprovided tothe URIdetail issues concerning security implications ofthe collection. External Member Resource - A member resource of a collection with an absolute URI that is not relativewhich WebDAV applications need toits parent's URI. Property - A name/value pair that contains descriptive information about a resource. Live Property _ A property whose semantics and syntax are enforced by the server. For example, a live "content-length" property would have its value, the lengthbe aware. Goland et al. [Page 70] INTERNET-DRAFT WebDAV January 18, 1998 All of theentity returned by a GET request, automatically calculated bysecurity considerations of HTTP/1.1 also apply to WebDAV. In addition, theserver. Dead Property _ A property whose semanticssecurity risks inherent in remote authoring require stronger authentication technology, andsyntaxintroduce several new privacy concerns, and may increase the hazards from poor server design. These issues are detailed below. 15.1 Authentication of Clients Due to their emphasis on authoring, WebDAV servers need to use authentication technology to protect notenforced byjust access to a network resource, but theserver. The server only recordsintegrity of thevalueresource as well. Furthermore, the introduction ofa dead property;locking functionality requires support for authentication. A password sent in theclientclear over an insecure channel isresponsiblean inadequate means formaintaining the consistency ofprotecting thesyntaxaccessibility andsemanticsintegrity of adead property. 18. Copyright INTERNET-DRAFT WebDAV November 19, 1997 The following copyright notice is copied from RFC 2026 chapter 10.4, and describesresource as theapplicable copyrightpassword may be intercepted. Since Basic authentication forthis document Copyright (C) The Internet Society November 19, 1997. All Rights Reserved. This document and translationsHTTP/1.1 performs essentially clear text transmission ofit maya password, Basic authentication MUST NOT becopied and furnishedused toothers, and derivative works that comment on or otherwise explain it or assistauthenticate a WebDAV client to a server unless the connection is secure. Furthermore, a WebDAV server MUST NOT send Basic authentication credentials inits implementation may be prepared, copied, published and distributed, in wholea WWW-Authenticate header unless the connection is secure. Examples of secure connections include a Transport Layer Security (TLS) connection, or a connection over a network which is physically secure, for example, an isolated network inpart,a building with restricted access. WebDAV applications MUST support the Digest authentication scheme [Franks, et al., 1997]. Since Digest authentication verifies that both parties to a communication know a shared secret, a password, withoutrestriction of any kind, providedhaving to send that secret in theabove copyright notice and this paragraphclear, Digest authentication avoids the security problems inherent in Basic authentication while providing a level of authentication which is useful in a wide range of scenarios. 15.2 Denial of Service Denial of service attacks areincludedof special concern to WebDAV servers. WebDAV plus HTTP enables denial of service attacks onall such copies and derivative works. However, this document itself may notevery part of a system's resources. The underlying storage can bemodified in any way, such asattacked byremoving the copyright notice or referencesPUTting extremely large files. Asking for recursive operations on large collections can attack processing time. Making multiple pipelined requests on multiple connections can attack network connections. Goland et al. [Page 71] INTERNET-DRAFT WebDAV January 18, 1998 WebDAV servers need to be aware of theInternet Society or other Internet organizations, except as neededpossibility of a denial of service attack at all levels. 15.3 Security through Obscurity WebDAV provides, through the PROPFIND method, a mechanism for listing thepurposemember resources ofdeveloping Internet standards ina collection. This greatly diminishes the effectiveness of security or privacy techniques whichcaserely only on theprocedures for copyrights defined indifficulty of discovering theInternet Standards process must be followed, or as requirednames of network resources. Users of WebDAV servers are encouraged totranslate it into languages otheruse access control techniques to prevent unwanted access to resources, rather thanEnglish. The limited permissions granted above are perpetual and will not be revoked bydepending on theInternet Society or its successors or assignees.relative obscurity of their resource names. 15.4 Privacy Issues Connected to Locks When submitting a lock request a user agent may also submit an owner XML field giving contact information for the person taking out the lock (for those cases where a person, rather than a robot, is taking out the lock). Thisdocumentcontact information is stored in a lockdiscovery property on the resource, and can be used by other collaborators to begin negotiation over access to the resource. However, in many cases this contact information can be very private, and should not be widely disseminated. Servers SHOULD limit read access to the lockdiscovery property as appropriate. Furthermore, user agents SHOULD provide control over whether contact informationcontained hereinisprovided on an "AS IS" basissent at all, andTHE 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. 19. Acknowledgements A specificationif contact information is sent, control over exactly what information is sent. 15.5 Privacy Issues Connected to Properties Since property values are typically used to hold information such asthis thrives on piercing critical review and withersthe author of a document, there is the possibility that privacy concerns could arise stemming fromapathetic neglect. The authors gratefully acknowledgewidespread access to a resource's property data. To reduce thecontributionsrisk of inadvertent release of private information via properties, servers are encouraged to develop access control mechanisms that separate read access to thefollowing people, whose insights were so valuable at every stageresource body and read access to the resource's properties. This allows a user to control the dissemination ofour work. Terry Allen, Harald Alvestrand, Alan Babich, Dylan Barrell, Bernard Chester, Tim Berners-Lee, Dan Connolly, Jim Cunningham, Ron Daniel, Jr., Jim Davis, Keith Dawson, Mark Day, Martin Duerst, David Durand, Lee Farrell, Chuck Fay, Roy Fielding, Mark Fisher, Alan Freier, George Florentine, Jim Gettys, Phill Hallam-Baker, Dennis Hamilton, Steve Henning, Alex Hopmann, Andre van der Hoek, Ben Laurie, Paul Leach, Ora Lassila, Karen MacArthur, Steven Martin, Larry Masinter, Michael Mealling, Keith Moore, Henrik Nielsen, Kenji Ota, Bob Parker, Glenn Peterson, Jon Radoff, Saveen Reddy, Henry Sanders, Christopher Seiwald, Judith Slein, Mike Spreitzer, Einar Stefferud, Ralph Swick, Kenji Takahashi, Richard N. Taylor, Robert Thau, John Turner, Sankar Virdhagriswaran, Fabio Vitali, Gregory Woodhouse, and Lauren Wood. INTERNET-DRAFT WebDAV November 19, 1997 One from this list deserves special mention. The contributions by Larry Masinter have been invaluable, both in helpingtheir property data without overly restricting access to theformationresource's contents. 15.6 Reduction of Security due to Source Link HTTP/1.1 warns against providing read access to script code because it may contain sensitive information. Yet WebDAV, via its source link facility, can potentially provide a URL for script resources so they may be authored. For HTTP/1.1, a server could reasonably prevent access to source resources due to theworking grouppredominance of read- only access. WebDAV, with its emphasis on authoring, encourages read andin patiently coachingwrite access to source resources, and provides theauthors alongsource link facility to identify theway. In so many ways he has set high standards we have toiledsource. This reduces the security benefits of eliminating access tomeet.source resources. Users and administrators of WebDAV servers should be very cautious when Goland et al. [Page 72] INTERNET-DRAFT WebDAVNovember 19, 1997 20. References [Alvestrand, 1997] H. T. Alvestrand, "IETF Policy on Character Sets and Languages." Internet-draft, work-in-progress. ftp://ds.internic.net/internet-drafts/draft-alvestrand-charset- policy-02.txt [Berners-Lee, 1997] T. Berners-Lee, "Metadata Architecture." Unpublished white paper,January1997. http://www.w3.org/pub/WWW/DesignIssues/Metadata.html. [Bradner, 1997] S. Bradner, "Key words for use in RFCs to Indicate Requirement Levels." RFC 2119, BCP 14. Harvard University. March, 1997. [Bray, Sperberg-McQueen, 1997] T. Bray, C. M. Sperberg-McQueen, "Extensible Markup Language (XML): Part I. Syntax", WD-xml- lang.html, http://www.w3.org/pub/WWW/TR/WD-xml-lang.html. [Fielding et al., 1997] R. Fielding, J. Gettys, J. Mogul, H. Frystyk, T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1." RFC 2068. U.C. Irvine, DEC, MIT/LCS. January, 1997. ftp://ds.internic.net/rfc/rfc2068.txt [Lasher, Cohen, 1995] R. Lasher, D. Cohen, "A Format for Bibliographic Records," RFC 1807. Stanford, Myricom. June, 1995. ftp://ds.internic.net/rfc/rfc1807.txt [Leach, Salz, 1997] P. J. Leach, R. Salz, "UUIDs and GUIDs." Internet-draft (expired), work-in-progress, February, 1997. http://www.internic.net/internet-drafts/draft-leach-uuids-guids- 00.txt [Maloney, 1996] M. Maloney, "Hypertext Links in HTML." Internet draft (expired), work-in-progress, January, 1996. [MARC, 1994] Network Development18, 1998 allowing remote authoring of scripts, limiting read andMARC Standards, Office, ed. 1994. "USMARC Format for Bibliographic Data", 1994. Washington, DC: Cataloging Distribution Service, Librarywrite access to the source resources to authorized principals. 16 IANA Considerations This document defines two namespaces, the namespace ofCongress. [Miller et al., 1996] J. Miller, T. Krauskopf, P. Resnick, W. Treese, "PICS Label Distribution Label Syntaxproperty names, andCommunication Protocols" Version 1.1, W3C Recommendation REC-PICS-labels-961031. http://www.w3.org/pub/WWW/TR/REC-PICS-labels-961031.html. [Slein et al., 1997] J. A. Slein, F. Vitali, E. J. Whitehead, Jr., D. Durand, "Requirementsthe namespace of WebDAV-specific XML elements used within property values. URLs are used forDistributed Authoring and Versioning Protocolboth names, forthe World Wide Web." RFC XXXX. Xerox, Univ.several reasons. Assignment ofBologna, U.C. Irvine, Boston Univ. YYY, 1997. ftp://ds.internic.net/rfc/rfcXXXX.txt INTERNET-DRAFTa URL does not require a request to a central naming authority, and hence allow WebDAVNovember 19, 1997 [WebDAV, 1997] WEBDAV Design Team. "A Proposal for Web Metadata Operations." Unpublished manuscript. http://www.ics.uci.edu/~ejw/authoring/proposals/metadata.html [Weibel et al., 1995] S. Weibel, J. Godby, E. Miller, R. Daniel, "OCLC/NCSA Metadata Workshop Report." http://purl.oclc.org/metadata/dublin_core_report. [Yergeau, 1997] F. Yergeau, "UTF-8,property names and XML elements to be quickly defined by any WebDAV user or application. URLs also provide atransformation formatunique address space, ensuring that the distributed users ofUnicodeWebDAV will not have collisions among the property names andISO 10646", Internet Draft, work-in-progress, draft- yergeau-utf8-rev-00.txt, http://www.internic.net/internet- drafts/draft-yergeau-utf8-rev-00.txt. INTERNET-DRAFTXML elements they create. This specification defines a distinguished set of property names and XML elements which are understood by all WebDAVNovember 19, 1997 21. Authors' Addresses Y. Y. Goland Microsoft Corporation One Microsoft Way Redmond, WA 98052-6399 Email: yarong@microsoft.com E. J. Whitehead, Jr. Dept. Of Informationapplications. The property names andComputer Science UniversityXML elements in this specification are all derived from the base URL: http://www.iana.org/standards/dav/ by adding a suffix to this URL, for example, http://www.iana.org/standards/dav/creationdate for the "creationdate" property. To ensure correct interoperation ofCalifornia, Irvine Irvine, CA 92697-3425 Email: ejw@ics.uci.edu A. Faizi Netscape 685 East Middlefield Road Mountain View, CA 94043 Email: asad@netscape.com S. R. Carter Novell 1555 N. Technology Way M/S ORM F111 Orem, UT 84097-2399 Email: srcarter@novell.com D. Jensen Novell 1555 N. Technology Way M/S ORM F111 Orem, UT 84097-2399 Email: dcjensen@novell.comthis specification, IANA MUST reserve the URL namespace starting with http://www.iana.org/standards/dav/ for use by this specification, its revisions, and related WebDAV specifications. 17 Terminology Collection - A resource that contains member resources. Member Resource - A resource contained by a collection. There are two types of member resources: external and internal. Internal Member Resource - A member resource of a collection whose URI is relative to the URI of the collection. External Member Resource - A member resource of a collection with an absolute URI that is not relative to its parent's URI. Property - A name/value pair that contains descriptive information about a resource. Live Property - A property whose semantics and syntax are enforced by the server. For example, a live "content-length" property would have its value, the length of the entity returned by a GET request, automatically calculated by the server. Goland et al. [Page 73] INTERNET-DRAFT WebDAV January 18, 1998 Dead Property - A property whose semantics and syntax are not enforced by the server. The server only records the value of a dead property; the client is responsible for maintaining the consistency of the syntax and semantics of a dead property. 18 Copyright The following copyright notice is copied from RFC 2026 [Bradner, 1996], Section 10.4, and describes the applicable copyright for this document. Copyright (C) The Internet Society January 18, 1998. 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 assignees. 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. 19 Intellectual Property The following notice is copied from RFC 2026 [Bradner, 1996], Section 10.4, and describes the position of the IETF concerning intellectual property claims made against this document. The IETF takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use other technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it Goland et al. [Page 74] INTERNET-DRAFT WebDAV January 18, 1998 has made any effort to identify any such rights. Information on the IETF's procedures with respect to rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication 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 implementors or users of this specification can be obtained from the IETF Secretariat. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to practice this standard. Please address the information to the IETF Executive Director. 20 Acknowledgements A specification such as this thrives on piercing critical review and withers from apathetic neglect. The authors gratefully acknowledge the contributions of the following people, whose insights were so valuable at every stage of our work. Terry Allen, Harald Alvestrand, Alan Babich, Dylan Barrell, Bernard Chester, Tim Berners-Lee, Dan Connolly, Jim Cunningham, Ron Daniel, Jr., Jim Davis, Keith Dawson, Mark Day, Brian Deen, Martin Duerst, David Durand, Lee Farrell, Chuck Fay, Roy Fielding, Mark Fisher, Alan Freier, George Florentine, Jim Gettys, Phill Hallam-Baker, Dennis Hamilton, Steve Henning, Alex Hopmann, Andre van der Hoek, Ben Laurie, Paul Leach, Ora Lassila, Karen MacArthur, Steven Martin, Larry Masinter, Michael Mealling, Keith Moore, Henrik Nielsen, Kenji Ota, Bob Parker, Glenn Peterson, Jon Radoff, Saveen Reddy, Henry Sanders, Christopher Seiwald, Judith Slein, Mike Spreitzer, Einar Stefferud, Ralph Swick, Kenji Takahashi, Richard N. Taylor, Robert Thau, John Turner, Sankar Virdhagriswaran, Fabio Vitali, Gregory Woodhouse, and Lauren Wood. Two from this list deserve special mention. The contributions by Larry Masinter have been invaluable, both in helping the formation of the working group and in patiently coaching the authors along the way. In so many ways he has set high standards we have toiled to meet. The contributions of Judith Slein in clarifying the requirements, and in patiently reviewing draft after draft, both improved this specification and expanded our minds on document management. We would also like to thank John Turner for developing the XML DTD. Goland et al. [Page 75] INTERNET-DRAFT WebDAV January 18, 1998 21 References [Alvestrand, 1995] H. T. Alvestrand, "Tags for the Identification of Languages." RFC 1766. Uninett. March, 1995. [Alvestrand, 1998] H. T. Alvestrand, "IETF Policy on Character Sets and Languages." RFC XXXX, BCP YY. Maxware. January, 1998. [Bradner, 1996] S. Bradner, "The Internet Standards Process - Revision 3." RFC 2026, BCP 9. Harvard University. October, 1996. [Bradner, 1997] S. Bradner, "Key words for use in RFCs to Indicate Requirement Levels." RFC 2119, BCP 14. Harvard University. March, 1997. [Bray, Paoli, Sperberg-McQueen, 1998] T. Bray, J. Paoli, C. M. Sperberg-McQueen, "Extensible Markup Language (XML)." World Wide Web Consortium Recommendation REC-XML-ZZZZ. http://www.w3.org/TR/PR-xml- 971208. [Fielding et al., 1997] R. Fielding, J. Gettys, J. Mogul, H. Frystyk, T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1." RFC 2068. U.C. Irvine, DEC, MIT/LCS. January, 1997. [ISO-639] ISO (International Organization for Standardization). ISO 639:1988. "Code for the representation of names of languages." [ISO-8601] ISO (International Organization for Standardization). ISO 8601:1988. "Data elements and interchange formats - Information interchange - Representation of dates and times." [Lasher, Cohen, 1995] R. Lasher, D. Cohen, "A Format for Bibliographic Records," RFC 1807. Stanford, Myricom. June, 1995. [Leach, Salz, 1997] P. J. Leach, R. Salz, "UUIDs and GUIDs." Internet-draft (expired), work-in-progress, February, 1997. http://www.internic.net/internet-drafts/draft-leach-uuids-guids- 00.txt [MARC, 1994] Network Development and MARC Standards, Office, ed. 1994. "USMARC Format for Bibliographic Data", 1994. Washington, DC: Cataloging Distribution Service, Library of Congress. [Miller et al., 1996] J. Miller, T. Krauskopf, P. Resnick, W. Treese, "PICS Label Distribution Label Syntax and Communication Protocols" Version 1.1, World Wide Web Consortium Recommendation REC-PICS-labels-961031. http://www.w3.org/pub/WWW/TR/REC-PICS- labels-961031.html. [Slein et al., 1997] J. A. Slein, F. Vitali, E. J. Whitehead, Jr., D. Durand, "Requirements for Distributed Authoring and Versioning Goland et al. [Page 76] INTERNET-DRAFT WebDAV January 18, 1998 Protocol for the World Wide Web." RFC XXXX. Xerox, Univ. of Bologna, U.C. Irvine, Boston Univ. YYY, 1997. [Weibel et al., 1995] S. Weibel, J. Godby, E. Miller, R. Daniel, "OCLC/NCSA Metadata Workshop Report." http://purl.oclc.org/metadata/dublin_core_report. [Yergeau, 1997] F. Yergeau, "UTF-8, a transformation format of Unicode and ISO 10646." RFC 2044. Alis Technologies. October, 1996. Goland et al. [Page 77] INTERNET-DRAFT WebDAV January 18, 1998 22 Authors' Addresses Y. Y. Goland Microsoft Corporation One Microsoft Way Redmond, WA 98052-6399 Email: yarong@microsoft.com E. J. Whitehead, Jr. Dept. Of Information and Computer Science University of California, Irvine Irvine, CA 92697-3425 Email: ejw@ics.uci.edu A. Faizi Netscape 685 East Middlefield Road Mountain View, CA 94043 Email: asad@netscape.com S. R. Carter Novell 1555 N. Technology Way M/S ORM F111 Orem, UT 84097-2399 Email: srcarter@novell.com D. Jensen Novell 1555 N. Technology Way M/S ORM F111 Orem, UT 84097-2399 Email: dcjensen@novell.com Goland et al. [Page 78] INTERNET-DRAFT WebDAV January 18, 1998 23 Appendices 23.1 Appendix 1 - WebDAV Document Type Definition This section provides a document type definition, following the rules in [Bray, Paoli, Sperberg-McQueen, 1998], for the XML elements used in the protocol stream and in the values of properties. It collects the element definitions given in Sections 11 and 12. <!DOCTYPE webdav-1.0 [ <!--============ XML Elements from Section 11 ==================--> <!ELEMENT activelock (locktype, lockscope, depth?, owner, timeout, locktoken) > <!ELEMENT lockentry (lockscope, locktype) > <!ELEMENT lockinfo (lockscope, locktype, owner?) > <!ELEMENT locktype (write) > <!ELEMENT write EMPTY > <!ELEMENT lockscope (exclusive | shared) > <!ELEMENT exclusive EMPTY > <!ELEMENT shared EMPTY > <!ELEMENT depth (#PCDATA) > <!ELEMENT owner (#PCDATA, ANY)* > <!ELEMENT timeout (#PCDATA) > <!ELEMENT locktoken (href) > <!ELEMENT href (#PCDATA) > <!ELEMENT link (src+, dst+) > <!ELEMENT dst (#PCDATA) > <!ELEMENT src (#PCDATA) > <!ELEMENT multistatus (response+, responsedescription?) > <!ELEMENT response (href, ((href*, status)|(propstat+)), responsedescription?) > <!ELEMENT status (#PCDATA) > <!ELEMENT propstat (prop status) > <!ELEMENT responsedescription (#PCDATA) > <!ELEMENT prop ANY > <!ELEMENT propertybehavior (omit | keepalive) > <!ELEMENT omit EMPTY > Goland et al. [Page 79] INTERNET-DRAFT WebDAV January 18, 1998 <!ELEMENT keepalive (#PCDATA | href+) > <!ELEMENT propertyupdate (remove | set)+ > <!ELEMENT remove (prop) > <!ELEMENT set (prop) > <!ELEMENT propfind (allprop | propname | href+) > <!ELEMENT allprop EMPTY > <!ELEMENT propname EMPTY > <!ELEMENT collection EMPTY > <!--=========== Property Elements from Section 12 ===============--> <!ELEMENT creationdate (#PCDATA) > <!ELEMENT displayname (#PCDATA) > <!ELEMENT externalmembers (href*) > <!ELEMENT getcontentlanguage (#PCDATA) > <!ELEMENT getcontentlength (#PCDATA) > <!ELEMENT getcontenttype (#PCDATA) > <!ELEMENT getetag (#PCDATA) > <!ELEMENT getlastmodified (#PCDATA) > <!ELEMENT lockdiscovery (activelock)* > <!ELEMENT resourcetype ANY > <!ELEMENT source (link)* > <!ELEMENT supportedlock (lockentry)* > ]> 23.2 Appendix 2 - ISO 8601 Date and Time Profile The creationdate property specifies the use of the ISO 8601 date format. This section defines a profile of the ISO 8601 date format for use with this specification. This profile is quoted verbatim from draft-newman-datetime-01.txt (expired). date-time = full-date "T" full-time full-date = date-fullyear "-" date-month "-" date-mday full-time = partial-time time-offset date-fullyear = 4DIGIT date-month = 2DIGIT ; 01-12 date-mday = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on month/year time-hour = 2DIGIT ; 00-23 time-minute = 2DIGIT ; 00-59 time-second = 2DIGIT ; 00-59, 00-60 based on leap second rules time-secfrac = "." 1*DIGIT time-numoffset = ("+" / "-") time-hour ":" time-minute time-offset = "Z" / time-numoffset Goland et al. [Page 80] INTERNET-DRAFT WebDAV January 18, 1998 partial-time = time-hour ":" time-minute ":" time-second [time-secfrac] Numeric offsets are calculated as local time minus UTC (Coordinated Universal Time). So the equivalent time in UTC can be determined by subtracting the offset from the local time. For example, 18:50:00- 04:00 is the same time as 22:58:00Z. If the time in UTC is known, but the offset to local time is unknown, this can be represented with an offset of "-00:00". This differs from an offset of "Z" which implies that UTC is the preferred reference point for the specified time. 23.3 Appendix 3 - Notes on Processing XML Elements XML is a flexible data format that makes it easy to submit data that appears legal but in fact is not. The philosophy of "Be flexible in what you accept and strict in what you send" still applies, but it must not be applied inappropriately. XML is extremely flexible in dealing with issues of white space, element ordering, inserting new elements, etc. This flexibility does not require extension, especially not in the area of the meaning of elements. There is no kindness in accepting illegal combinations of XML elements. At best it will cause an unwanted result and at worst it can cause real damage. 23.3.1 XML Syntax Error Example The following request body for a PROPFIND method is illegal. <?xml version="1.0"?> <?namespace href ="http://www.iana.org/standards/dav/" as="D"?> <D:propfind> <D:allprop/> <D:propname/> </D:propfind> The definition of the propfind element only allows for the allprop or the propname element, not both. Thus the above is an error and MUST be responded to with a 400 Bad Request. Imagine, however, that a server wanted to be "kind" and decided to pick the allprop element as the true element and respond to it. A client running over a bandwidth limited line who intended to execute a propname would be in for a big surprise if the server treated the command as an allprop. 23.3.2 Unknown XML Element Example Goland et al. [Page 81] INTERNET-DRAFT WebDAV January 18, 1998 The previous example was illegal because it contained two elements that were explicitly banned from appearing together in the propfind element. However, XML is an extensible language, so one can imagine new elements being defined for use with propfind. Below is the request body of a PROPFIND and, like the previous example, MUST be rejected with a 400 Bad Request by a server that does not understand the expired-props element. <?xml version="1.0"?> <?namespace href ="http://www.iana.org/standards/dav/" as="D"?> <?namespace href="http://www.foo.bar/standards/props/" as="E"?> <D:propfind> <E:expired-props/> </D:propfind> To understand why a 400 Bad Request is returned let us look at the request body as the server unfamiliar with expired-props sees it. <?xml version="1.0"?> <?namespace href ="http://www.iana.org/standards/dav/" as="D"?> <?namespace href="http://www.foo.bar/standards/props/" as="E"?> <D:propfind> </D:propfind> As the server does not understand the expired-props element, by the rules of XML, it MUST ignore it. Thus the server sees an empty propfind, which by the definition of the propfind element is illegal. Please note that had the extension been additive it would not necessarily have resulted in a 400 Bad Request. For example, imagine the following request body for a PROPFIND: <?xml version="1.0"?> <?namespace href ="http://www.iana.org/standards/dav/" as="D"?> <?namespace href="http://www.foo.bar/standards/props/" as="E"?> <D:propfind> <D:propname/> <E:leave-out>*boss*</E:leave-out> </D:propfind> The previous example contains the fictitious element leave-out. Its purpose is to prevent the return of any property whose name matches the submitted pattern. If the previous example were submitted to a server unfamiliar with leave-out, the only result would be that the leave-out element would be ignored and a propname would be executed. Goland et al. [Page 82] ----