home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1997 December / Internet_Info_CD-ROM_Walnut_Creek_December_1997.iso / drafts / draft_ietf_u_z / draft-ietf-webdav-requirements-01.txt < prev    next >
Text File  |  1997-07-25  |  39KB  |  936 lines

  1.  
  2. WEBDAV Working Group                J.A. Slein
  3. INTERNET-DRAFT                      Xerox Corporation
  4. <draft-ietf-webdav-requirements-01.txt>        F. Vitali
  5.                         University of Bologna              
  6.                         E.J. Whitehead, Jr.
  7.                         U.C. Irvine
  8.                         D.G. Durand
  9.                         Boston University
  10.                         July 24, 1997
  11.  
  12. Expires January 24, 1998
  13.  
  14.      Requirements for Distributed Authoring and Versioning 
  15.                     on the World Wide Web
  16.  
  17.  
  18. Status of this Memo
  19.  
  20. This document is an Internet draft. Internet drafts are working
  21. documents of the Internet Engineering Task Force (IETF), its areas and
  22. its working groups. Note that other groups may also distribute working
  23. information as Internet drafts.
  24.  
  25. Internet Drafts are draft documents valid for a maximum of six months
  26. and can be updated, replaced or obsoleted by other documents at any
  27. time. It is inappropriate to use Internet drafts as reference material
  28. or to cite them as other than as "work in progress".
  29.  
  30. To learn the current status of any Internet draft please check the
  31. "lid-abstracts.txt" listing contained in the Internet drafts shadow
  32. directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
  33. munnari.oz.au (Pacific Rim), ds.internic.net (US East coast) or
  34. ftp.isi.edu (US West coast). Further information about the IETF can be
  35. found at URL: http://www.ietf.org/
  36.  
  37. Distribution of this document is unlimited. Please send comments to the
  38. WWW Distributed Authoring and Versioning (WebDAV) mailing list,
  39. <w3c-dist-auth@w3.org>, which may be joined by sending a message with
  40. subject "subscribe" to <w3c-dist-auth-request@w3.org>. Discussions are
  41. archived at URL:
  42. http://www.w3.org/pub/WWW/Archives/Public/w3c-dist-auth/.
  43.  
  44. Abstract
  45.  
  46. Current World Wide Web (WWW or Web) standards provide simple support 
  47. for applications which allow remote editing of typed data. In practice, 
  48. the existing capabilities of the WWW have proven inadequate to support 
  49. efficient, scalable remote editing free of overwriting conflicts.  
  50. This document presents a list of features in the form of requirements 
  51. which, if implemented, would improve the efficiency of common remote 
  52. editing operations, provide a locking mechanism to prevent overwrite 
  53. conflicts, improve link management support between non-HTML 
  54. data types, provide a simple attribute-value metadata facility, provide
  55. for the creation and reading of container data types, and integrate 
  56. versioning into the WWW.
  57.  
  58. 1. Introduction
  59.  
  60. Slein, Vitali, Whitehead, Durand                                Page 1
  61. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  62.  
  63.  
  64. This document describes functionality which, if incorporated in an 
  65. extension to the existing HTTP proposed standard [HTTP], would allow tools 
  66. for remote loading, editing and saving (publishing) of various media 
  67. types on the WWW to interoperate with any compliant Web server. As much 
  68. as possible, this functionality is described without suggesting a 
  69. proposed implementation, since there are many ways to perform the 
  70. functionality within the WWW framework. It is also possible that a 
  71. single mechanism could simultaneously satisfy several requirements.
  72.  
  73. This document is intended to reflect the consensus of the WWW 
  74. Distributed Authoring and Versioning working group (WebDAV) as to the 
  75. functionality that needs to be standardized to support distributed 
  76. authoring and versioning on the Web. However, this version still has 
  77. some elements that are being debated in the working group. The following
  78. elements are still under discussion:
  79.  
  80.     o Whether support for multi-resource locking is needed
  81.     o Whether support for query on properties and links is needed
  82.     o What requirements there should be for internationalization
  83.  
  84. 2. Rationale
  85.  
  86. Current Web standards contain functionality which enables the editing of 
  87. Web content at a remote location, without direct access to the storage 
  88. media via an operating system. This capability is exploited by several 
  89. existing HTML distributed authoring tools, and by a growing number of 
  90. mainstream applications (e.g., word processors) which allow users to 
  91. write (publish) their work to an HTTP server. To date, experience from 
  92. the HTML authoring tools has shown they are unable to meet their users' 
  93. needs using the facilities of Web standards. The consequence of 
  94. this is either postponed introduction of distributed authoring 
  95. capability, or the addition of nonstandard extensions to the HTTP 
  96. protocol or other Web standards.  These extensions, developed in 
  97. isolation, are not interoperable.
  98.  
  99. Other authoring applications have wanted to access document repositories 
  100. or version control systems through Web gateways, and have been similarly
  101. frustrated.  Where this access is available at all, it is through
  102. nonstandard extensions to HTTP or other standards that force clients to 
  103. use a different interface for each vendor's service.
  104.  
  105. This document describes requirements for a set of standard extensions
  106. to HTTP that would allow distributed Web authoring tools to provide
  107. the functionality their users need by means of the same standard
  108. syntax across all compliant servers. The broad categories of 
  109. functionality that need to be standardized are:
  110.  
  111.     Properties
  112.     Links
  113.     Locking
  114.     Reservations
  115.     Retrieval of Unprocessed Source
  116.     Partial Write
  117.     Name Space Manipulation
  118.  
  119. Slein, Vitali, Whitehead, Durand                                Page 2
  120. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  121.  
  122.     Collections
  123.     Versioning
  124.     Security
  125.     Internationalization
  126.  
  127. 3. Terminology
  128.  
  129. Where there is overlap, usage is intended to be consistent with that in 
  130. the HTTP 1.1 specification [HTTP].
  131.  
  132. Client
  133.     A program which issues HTTP requests and accepts responses.
  134.  
  135. Collection
  136.     A collection is a resource that contains other resources,
  137.     either directly or by reference.
  138.  
  139. Distributed Authoring Tool
  140.     A program which can retrieve a source entity via HTTP, allow 
  141.     editing of this entity, and then save/publish this entity
  142.     to a server using HTTP.
  143.  
  144. Entity
  145.     The information transferred in a request or response.
  146.  
  147. Hierarchical Collection
  148.     A hierarchical organization of resources.  A hierarchical
  149.     collection is a resource that contains other resources, 
  150.     including collections, either directly or by reference.
  151.  
  152. Link
  153.     A typed connection between two or more resources.
  154.  
  155. Lock
  156.     A mechanism for preventing anyone other than the owner of the
  157.     lock from accessing a resource.
  158.  
  159. Member of Version Graph
  160.     A resource that is a node in a version graph, and so is derived
  161.     from the resources that precede it in the graph, and is the 
  162.     basis of those that succeed it.
  163.  
  164. Property
  165.     Named descriptive information about a resource.
  166.  
  167. Reservation
  168.     A declaration that one intends to edit a resource.
  169.  
  170. Resource
  171.     A network data object or service that can be identified by
  172.     a URI.
  173.  
  174. Server
  175.     A program which receives and responds to HTTP requests.
  176.  
  177.  
  178. Slein, Vitali, Whitehead, Durand                                Page 3
  179. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  180.  
  181. User Agent
  182.     The client that initiates a request.
  183.  
  184. Version Graph
  185.     A directed acyclic graph with resources as its nodes, where
  186.     each node is derived from its predecessor(s).
  187.  
  188. Write Lock
  189.     A lock that prevents anyone except its owner from modifying
  190.     the resource it applies to.
  191.  
  192.  
  193. 4. General Principles
  194.  
  195. This section describes a set of general principles that the WebDAV
  196. extensions should follow.  These principles cut across categories of
  197. functionality.
  198.  
  199. 4.1. User Agent Interoperability
  200.  
  201. All WebDAV clients should be able to work with any WebDAV-compliant HTTP
  202. server. It is acceptable for some client/server combinations to provide
  203. special features that are not universally available, but the protocol
  204. should be sufficient that a basic level of functionality will be
  205. universal.
  206.  
  207. 4.2. Client Simplicity
  208.  
  209. The WebDAV extensions should be designed to allow client implementations
  210. to be simple.
  211.  
  212. 4.3. Legacy Client Support
  213.  
  214. It should be possible to implement a WebDAV-compliant server in such a
  215. way that it can interoperate with non-WebDAV clients.  Such a server
  216. would be able to understand any valid HTTP 1.1 request from an ordinary
  217. Web client without WebDAV extensions, and to provide a valid HTTP 1.1 
  218. response that does not require the client to understand the extensions.
  219.  
  220. 4.4. Data Format Compatibility
  221.  
  222. WebDAV-compliant servers should be able to work with existing resources 
  223. and URIs [URL]. Special additional information should not become a 
  224. mandatory part of document formats.
  225.  
  226. 4.5. Replicated, Distributed Systems
  227.  
  228. Distribution and replication are at the heart of the Internet.  All
  229. WebDAV extensions should be designed to allow for distribution and
  230. replication.  Version trees should be able to be split across multiple
  231. servers.  Collections may have members on different servers.  Resources
  232. may have properties on different servers.  Any resources may be cached
  233. or replicated for mobile computing or other reasons.  Consequently, the
  234. WebDAV extensions must be able to operate in a distributed, replicated
  235. environment.
  236.  
  237. Slein, Vitali, Whitehead, Durand                                Page 4
  238. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  239.  
  240.  
  241. 4.6 Parsimony in Client-Server Interactions 
  242.  
  243. The WebDAV extensions should keep to a minimum the number of 
  244. interactions between the client and the server needed to perform common
  245. functions. For example, publishing a document to the Web will often mean
  246. publishing content together with related properties.  A client may often 
  247. need to find out what version graph a particular resource belongs to, 
  248. or to find out which resource in a version graph is the published one.
  249. The extensions should make it possible to do these things efficiently.
  250.  
  251. 4.7. Changes to HTTP
  252.  
  253. WebDAV adds a number of new types of objects to the Web: properties, 
  254. collections, version graphs, etc.  Existing HTTP methods such as
  255. DELETE and PUT will have to operate in well-defined ways in this 
  256. expanded environment. WebDAV should explicitly address not only new
  257. methods, headers, and MIME types, but also any required changes to the
  258. existing HTTP methods and headers.
  259.  
  260. 4.8. Alternate Transport Mechanisms
  261.  
  262. It may be desirable to transport WebDAV requests and responses by other
  263. mechanisms, particularly EMail, in addition to HTTP.  The WebDAV protocol
  264. specification should not preclude a future body from developing an
  265. interoperability specification for disconnected operation via EMail.
  266.  
  267. 5. Requirements
  268.  
  269. In the requirement descriptions below, the requirement will be stated,
  270. followed by its rationale.
  271.  
  272. 5.1. Properties
  273.  
  274. 5.1.1. Functional Requirements
  275.  
  276. It must be possible to create, modify, query, read and delete arbitrary
  277. properties on resources of any media type.
  278.  
  279. 5.1.2. Rationale 
  280.  
  281. Properties describe resources of any media type.  They may 
  282. include bibliographic information such as author, title, publisher, 
  283. and subject, constraints on usage, PICS ratings, etc. These
  284. properties have many uses, such as supporting searches on property
  285. values, enforcing copyrights, and the creation of catalog entries as 
  286. placeholders for objects which are not available in electronic form, or 
  287. which will be available later.
  288.  
  289. 5.2. Links
  290.  
  291. 5.2.1. Functional Requirements
  292.  
  293. It must be possible to create, modify, query, read and delete typed 
  294. links between resources of any media type.
  295.  
  296. Slein, Vitali, Whitehead, Durand                                Page 5
  297. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  298.  
  299.  
  300. 5.2.2. Rationale 
  301.  
  302. One type of link between resources is the hypertext link, which is 
  303. browsable using a hypertext style point-and-click user interface. Links, 
  304. whether they are browsable hypertext links, or simply a means of 
  305. capturing a connection between resources, have many purposes.  Links 
  306. can support pushbutton printing of a multi-resource document in a 
  307. prescribed order, jumping to the access control page for a resource, 
  308. and quick browsing of related information, such as a table of contents, 
  309. an index, a glossary, a bibliographic record, help pages, etc. While 
  310. link support is provided by the HTML "LINK" element, this is limited 
  311. only to HTML resources [HTML]. Similar support is needed for bitmap image 
  312. types, and other non-HTML media types.  
  313.  
  314. 5.3. Locking
  315.  
  316. 5.3.1. General Principles
  317.  
  318. 5.3.1.1. Independence of locks. It must be possible to lock a resource
  319. without re-reading the resource, and without committing to editing the 
  320. resource.
  321.  
  322. 5.3.1.2. Multi-Resource Locking. It must be possible to take out a 
  323. lock on multiple resources residing on the same server in a single action, 
  324. and this locking operation must be atomic across these resources.
  325.  
  326. 5.3.2. Functional Requirements
  327.  
  328. 5.3.2.1. Write Locks. It must be possible to restrict modification of 
  329. a resource to a specific person.
  330.  
  331. 5.3.2.2. Lock Query. It must be possible to find out whether a given 
  332. resource has any active locks, and if so, who holds those locks.
  333.  
  334. 5.3.2.3. Unlock. It must be possible to remove a lock.
  335.  
  336. 5.3.3. Rationale
  337.  
  338. At present, the Web provides limited support for preventing two or more 
  339. people from overwriting each other's modifications when they save to a 
  340. given URI. Furthermore, there is no way to discover whether someone else
  341. is currently making modifications to a resource. This is known as the 
  342. "lost update problem," or the "overwrite problem." Since there can be 
  343. significant cost associated with discovering and repairing lost 
  344. modifications, preventing this problem is crucial for supporting 
  345. distributed authoring. A write lock ensures that only one person may 
  346. modify a resource, preventing overwrites. Furthermore, locking support 
  347. is a key component of many versioning schemes, a desirable capability 
  348. for distributed authoring.
  349.  
  350. An author may wish to lock an entire web of resources even though he 
  351. is editing just a single resource, to keep the other resources from 
  352. changing. In this way, an author can ensure that if a local hypertext 
  353. web is consistent in his distributed authoring tool, it will then be 
  354.  
  355. Slein, Vitali, Whitehead, Durand                                Page 6
  356. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  357.  
  358. consistent when he writes it to the server. Because of this, it should 
  359. be possible to take out a lock without also causing transmission of the 
  360. contents of a resource.
  361.  
  362. It is often necessary to guarantee that a lock or unlock operation 
  363. occurs at the same time across multiple resources, a feature which is 
  364. supported by the multiple-resource locking requirement. This is useful 
  365. for preventing a collision between two people trying to establish locks 
  366. on the same set of resources, since with multi-resource locking, one of 
  367. the two people will get a lock. If this same multiple-resource locking 
  368. scenario was repeated by using atomic lock operations iterated across 
  369. the resources, the result would be a splitting of the locks between the 
  370. two people, based on resource ordering and race conditions.
  371.  
  372. 5.4. Reservations
  373.  
  374. 5.4.1. Functional Requirements 
  375.  
  376. 5.4.1.1. Reserve. It must be possible for a principal to register with 
  377. the server an intent to edit a given resource, so that other principals 
  378. can discover who intends to edit the resource.
  379.  
  380. 5.4.1.2. Reservation Query. It must be possible to find out whether 
  381. a given resource has any active reservations, and if so, who currently 
  382. holds reservations.
  383.  
  384. 5.4.1.3. Release Reservation.  It must be possible to release the 
  385. reservation.
  386.  
  387. 5.4.2. Rationale
  388.  
  389. Experience from configuration management systems has shown that people 
  390. need to know when they are about to enter a parallel editing situation. 
  391. Once notified, they either decide not to edit in parallel with the 
  392. other authors, or they use out-of-band communication (face-to-face, 
  393. telephone, etc.) to coordinate their editing to minimize the difficulty 
  394. of merging their results. Reservations are separate from locking, since 
  395. a write lock does not necessarily imply a resource will be edited, and 
  396. a reservation does not carry with it any access restrictions. This 
  397. capability supports versioning, since a check-out typically involves 
  398. taking out a write lock, making a reservation, and getting the resource
  399. to be edited.
  400.  
  401. 5.5. Retrieval of Unprocessed Source for Editing
  402.  
  403. 5.5.1. Functional Requirement
  404.  
  405. The source of any given resource must be retrievable.
  406.  
  407. 5.5.2. Rationale
  408.  
  409. There are many cases where the source stored on a server does 
  410. not correspond to the actual entity transmitted in response to an HTTP 
  411. GET. Current known cases are server side include directives, and 
  412. Standard Generalized Markup Language (SGML) source which is
  413.  
  414. Slein, Vitali, Whitehead, Durand                                Page 7
  415. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  416.  
  417. converted on the fly to HyperText Markup Language (HTML) [HTML] output 
  418. entities. There are many possible cases, such as automatic conversion 
  419. of bitmap images into several variant bitmap media types (e.g. GIF, 
  420. JPEG), and automatic conversion of an application's native media type 
  421. into HTML. As an example of this last case, a word processor could 
  422. store its native media type on a server which automatically converts 
  423. it to HTML. A GET of this resource would retrieve the HTML. Retrieving 
  424. the source would retrieve the word processor native format.
  425.  
  426. 5.6. Partial Write.
  427.  
  428. 5.6.1. Functional Requirement 
  429.  
  430. After editing a resource, it must be possible to write only the changes
  431. to the resource, rather than retransmitting the entire resource.
  432.  
  433. 5.6.2. Rationale
  434.  
  435. During distributed editing which occurs over wide geographic separations
  436. and/or over low bandwidth connections, it is extremely inefficient
  437. and frustrating to rewrite a large resource after minor changes, such 
  438. as a one-character spelling correction. Support is needed for 
  439. transmitting "insert" (e.g., add this sentence in the middle of a 
  440. document) and "delete" (e.g. remove this paragraph from the middle of 
  441. a document) style updates. Support for partial resource updates will 
  442. make small edits more efficient, and allow distributed authoring tools 
  443. to scale up for editing large documents.
  444.  
  445. 5.7. Name Space Manipulation
  446.  
  447. 5.7.1. Copy
  448.  
  449. 5.7.1.1. Functional Requirements 
  450.  
  451. It must be possible to duplicate a resource without a client loading, 
  452. then resaving the resource. After the copy operation, the content of 
  453. the destination resource must be octet for octet identical to the 
  454. content of the source resource. A modification to either resource must 
  455. not cause a modification to the other.
  456.  
  457. 5.7.1.2. Rationale
  458.  
  459. There are many reasons why a resource might need to be duplicated, such 
  460. as changing ownership, preparing for major modifications, or making 
  461. a backup. Due to network costs associated with loading and saving a 
  462. resource, it is far preferable to have a server perform a resource copy
  463. than a client. If a copied resource records which resource it is a copy
  464. of, then it would be possible for a cache to avoid loading the copied 
  465. resource if it already locally stores the original.
  466.  
  467. 5.7.2. Move/Rename
  468.  
  469. 5.7.2.1. Functional Requirements 
  470.  
  471. It must be possible to change the location of a resource without 
  472.  
  473. Slein, Vitali, Whitehead, Durand                                Page 8
  474. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  475.  
  476. a client loading, then resaving the resource under a different name. 
  477. After the move operation, the content of the resource at its new 
  478. location must be octet for octet identical to the content of the prior 
  479. resource. It must no longer be possible to access the resource at its 
  480. original location.
  481.  
  482. 5.7.2.2. Rationale
  483.  
  484. It is often necessary to change the name of a resource, for example due 
  485. to adoption of a new naming convention, or if a typing error was made 
  486. entering the name originally. Due to network costs, it is undesirable 
  487. to perform this operation by loading, then resaving the resource,
  488. followed by a delete of the old resource. Similarly, a single rename 
  489. operation is more efficient than a copy followed by a delete operation.
  490. Note that moving a resource is considered the same function as renaming
  491. a resource.
  492.  
  493. 5.8. Collections
  494.  
  495. A collection is a resource that is a container for other resources,
  496. including other collections.  A resource may belong to a collection
  497. either directly or by reference.  If a resource belongs to a
  498. collection directly, name space operations like copy, move, and
  499. delete applied to the collection also apply to the resource.  If a
  500. resource belongs to a collection by reference, name space operations
  501. applied to the collection affect only the reference, not the resource
  502. itself.
  503.  
  504. 5.8.1. Functional Requirements
  505.  
  506. 5.8.1.1. List Collection. A listing of all resources in a specific 
  507. collection must be accessible.
  508.  
  509. 5.8.1.2. Make Collection. It must be possible to create a new 
  510. collection.
  511.  
  512. 5.8.1.3. Add to Collection.  It must be possible to add a resource to a
  513. collection directly or by reference.
  514.  
  515. 5.8.1.4. Remove from Collection.  It must be possible to remove a
  516. resource from a collection.
  517.  
  518. 5.8.2. Rationale
  519.  
  520. In [URL] it states that, "some URL schemes (such as the ftp, http, and 
  521. file schemes) contain names that can be considered hierarchical." 
  522. Especially for HTTP servers which directly map all or part of their URL 
  523. name space into a filesystem, it is very useful to get a listing of all 
  524. resources located at a particular hierarchy level. This functionality 
  525. supports "Save As..." dialog boxes, which provide a listing of the 
  526. entities at a current hierarchy level, and allow navigation through 
  527. the hierarchy. It also supports the creation of graphical visualizations
  528. (typically as a network) of the hypertext structure among the entities 
  529. at a hierarchy level, or set of levels. It also supports a tree
  530. visualization of the entities and their hierarchy levels.
  531.  
  532. Slein, Vitali, Whitehead, Durand                                Page 9
  533. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  534.  
  535.  
  536. In addition, document management systems may want to make their 
  537. documents accessible through the Web.  They typically allow the 
  538. organization of documents into collections, and so also want their users
  539. to be able to view the collection hierarchy through the Web.
  540.  
  541. There are many instances where there is not a strong correlation between
  542. a URL hierarchy level and the notion of a collection. One example is a 
  543. server in which the URL hierarchy level maps to a computational process 
  544. which performs some resolution on the name. In this case, the contents 
  545. of the URL hierarchy level can vary depending on the input to the 
  546. computation, and the number of resources accessible via the computation 
  547. can be very large. It does not make sense to implement a directory 
  548. feature for such a name space. However, the utility of listing the 
  549. contents of those URL hierarchy levels which do correspond to 
  550. collections, such as the large number of HTTP servers which map their 
  551. name space to a filesystem, argue for the inclusion of this capability, 
  552. despite not being meaningful in all cases. If listing the contents of 
  553. a URL hierarchy level does not makes sense for a particular URL, then 
  554. a "405 Method Not Allowed" status code could be issued.
  555.  
  556. The ability to create collections to hold related resources supports 
  557. management of a name space by packaging its members into small, related 
  558. clusters. The utility of this capability is demonstrated by the broad 
  559. implementation of directories in recent operating systems. The ability 
  560. to create a collection also supports the creation of "Save As..." 
  561. dialog boxes with "New Level/Folder/Directory" capability, common in 
  562. many applications.
  563.  
  564. 5.9. Versioning
  565.  
  566. 5.9.1. Background and General Principles
  567.  
  568. 5.9.1.1. Stability of versions. Most versioning systems are intended to
  569. provide an accurate record of the history of evolution of a document. 
  570. This accuracy is ensured by the fact that a version eventually becomes 
  571. "frozen" and immutable. Once a version is frozen, further changes will 
  572. create new versions rather than modifying the original. In order for 
  573. caching and persistent references to be properly maintained, a client 
  574. must be able to determine that a version has been frozen. Any successful
  575. attempt to retrieve a frozen version of a resource will always retrieve
  576. exactly the same content, or return an error if that version (or the 
  577. resource itself) is no longer available.
  578.  
  579. 5.9.1.2. Operations for Creating New Versions
  580.  
  581. Version management systems vary greatly in the operations they require,
  582. the order of the operations, and how they are combined into atomic
  583. functions.  In the most complete cases, the logical operations involved
  584. are:
  585.     o Reserve existing version
  586.     o Lock existing version
  587.     o Retrieve existing version
  588.     o Request or suggest identifier for new version
  589.     o Write new version
  590.  
  591. Slein, Vitali, Whitehead, Durand                                Page 10
  592. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  593.  
  594.     o Release lock
  595.     o Release reservation
  596. With the exception of requesting a new version identifier, all of these
  597. operations have applications outside of versioning and are either 
  598. already part of HTTP or are discussed in earlier sections of these
  599. requirements. Typically, versioning systems combine reservation, 
  600. locking, and retrieval -- or some subset of these -- into an atomic 
  601. checkout function.  They combine writing, releasing the lock, and 
  602. releasing the reservation -- or some subset of these -- into an atomic 
  603. checkin function.  The new version identifier may be assigned either at 
  604. checkout or at checkin.
  605.  
  606. The WebDAV extensions must find some balance between allowing versioning
  607. servers to adopt whatever policies they wish with regard to these 
  608. operations and enforcing enough uniformity to keep client 
  609. implementations simple.
  610.  
  611. 5.9.1.3. The Versioning Model
  612.  
  613. Each version typically stands in a "derived from" relationship to its 
  614. predecessor(s).  It is possible to derive several different versions 
  615. from a single version (branching), and to derive a single version from 
  616. several versions (merging).  Consequently, the collection of related
  617. versions forms a directed acyclic graph.  In the following discussion,
  618. this graph will be called a "version graph".  Each node of this graph
  619. is a "version" or "member of the version graph".  The arcs of the graph
  620. capture the "derived from" relationships.
  621.  
  622. It is also possible for a single resource to participate in multiple
  623. version graphs.
  624.  
  625. The WebDAV extensions should support this versioning model, though
  626. particular servers may restrict it in various ways.
  627.  
  628. 5.9.1.4. Versioning Policies. Many writers, including Feiler [CM] and 
  629. Haake and Hicks [VSE], have discussed the notion of versioning styles 
  630. (referred to here as versioning policies, to reflect the nature of 
  631. client/server interaction) as one way to think about the different 
  632. policies that versioning systems implement. Versioning policies include
  633. decisions on the shape of version histories (linear or branched), the 
  634. granularity of change tracking, locking requirements made by a server, 
  635. etc. The protocol should clearly identify the policies that it dictates
  636. and the policies that are left up to versioning system implementors or
  637. administrators.
  638.  
  639. 5.9.1.5. It is possible to version resources of any media type.
  640.  
  641. 5.9.2. Functional Requirements
  642.  
  643. 5.9.2.1. Referring to a version graph. There must be a way to refer to
  644. a version graph as a whole.  
  645.  
  646. Some queries and operations apply, not to any one member of a
  647. version graph, but to the version graph as a whole.  For example, a 
  648. client may request that an entire graph be moved, or may ask for a 
  649.  
  650. Slein, Vitali, Whitehead, Durand                                Page 11
  651. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  652.  
  653. version history. In these cases, a way to refer to the whole version 
  654. graph is required.
  655.  
  656. 5.9.2.2. Referring to a specific member of a version graph. There must
  657. be a way to refer to each member of a version graph. This means that 
  658. each member of the graph is itself a resource. 
  659.  
  660. Each member of a version graph must be a resource if it is to be 
  661. possible for a hypertext link to refer to specific version of a page, 
  662. or for a client to request a specific version of a document for editing.
  663.  
  664. 5.9.2.3. A client must be able to determine whether a resource is a 
  665. version graph, or whether a resource is itself a member of a version 
  666. graph.
  667.  
  668. A resource may be a simple, non-versioned resource, or it may be a 
  669. version graph, or it may be a member of a version graph.  A client needs
  670. to be able to tell which sort of resource it is accessing.
  671.  
  672. 5.9.2.4. There must be a way to refer to a server-defined default 
  673. member of a version graph.
  674.  
  675. The server should return a default version of a resource for requests 
  676. that ask for the default version, as well as for requests where no
  677. specific version information is provided. This is one of the simplest 
  678. ways to guarantee non-versioning client compatibility. This does not 
  679. rule out the possibility of a server returning an error when no sensible
  680. default exists.
  681.  
  682. It may also be desirable to be able to refer to other special members 
  683. of a version graph. For example, there may be a current version for
  684. editing that is different from the default version.  For a graph with
  685. several branches, it may be useful to be able to request the tip version
  686. of any branch.
  687.  
  688. 5.9.2.5. It must be possible, given a reference to a member of a version
  689. graph, to find out which version graph(s) that resource belongs to.
  690.  
  691. This makes it possible to understand the versioning context of the 
  692. resource. It makes it possible to retrieve a version history for the 
  693. graphs to which it belongs, and to browse the version graph. It also 
  694. supports some comparison operations: It makes it possible to determine 
  695. whether two references designate members of the same version graph.
  696.  
  697. 5.9.2.6. Navigation of a version graph.  Given a reference to a member 
  698. of a version graph, it must be possible to discover and access the 
  699. following related members of the version graph.
  700.    o root member of the graph
  701.    o predecessor member(s)
  702.    o successor member(s)
  703.    o default member of the graph
  704.  
  705. It must be possible in some way for a versioning client to access
  706. versions related to a resource currently being examined.
  707.  
  708.  
  709. Slein, Vitali, Whitehead, Durand                                Page 12
  710. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  711.  
  712. 5.9.2.7. Version Topology. There must be a way to retrieve the complete 
  713. version topology for a version graph, including information about all 
  714. members of the version graph. The format for this information must be 
  715. standardized so that the basic information can be used by all clients. 
  716. Other specialized formats should be accommodated, for servers and 
  717. clients that require information that cannot be included in the 
  718. standard topology.
  719.  
  720. 5.9.2.8. A client must be able to propose a version identifier to be 
  721. used for a new member of a version graph. The server may refuse to use 
  722. the client's suggested version identifier.  The server should tell the
  723. client what version identifier it has assigned to the new member of the
  724. version graph.
  725.  
  726. 5.9.2.9. A version identifier must be unique across a version graph.
  727.  
  728. 5.9.2.10. A client must be able to supply version-specific properties to 
  729. be associated with a new member of a version graph. (See Section 5.1 
  730. "Properties" above.) At a minimum, it must be possible to associate 
  731. comments with the new member, explaining what changes were made.
  732.  
  733. 5.9.2.11. A client must be able to query the server for information 
  734. about a version tree, including which versions are locked, which are 
  735. reserved for editing, and by whom (Session Tracking).
  736.  
  737. 5.9.3. Rationale
  738.  
  739. Versioning in the context of the world-wide web offers a variety of
  740. benefits:
  741.  
  742. It provides infrastructure for efficient and controlled management of 
  743. large evolving web sites. Modern configuration management systems are 
  744. built on some form of repository that can track the revision history of
  745. individual resources, and provide the higher-level tools to manage 
  746. those saved versions. Basic versioning capabilities are required to 
  747. support such systems.
  748.  
  749. It allows parallel development and update of single resources. Since 
  750. versioning systems register change by creating new objects, they
  751. enable simultaneous write access by allowing the creation of variant
  752. versions. Many also provide merge support to ease the reverse operation.
  753.  
  754. It provides a framework for coordinating changes to resources. While 
  755. specifics vary, most systems provide some method of controlling or 
  756. tracking access to enable collaborative resource development.
  757.  
  758. It allows browsing through past and alternative versions of a resource.
  759. Frequently the modification and authorship history of a resource is
  760. critical information in itself.
  761.  
  762. It provides stable names that can support externally stored links for
  763. annotation and link-server support. Both annotation and link servers 
  764. frequently need to store stable references to portions of resources 
  765. that are not under their direct control. By providing stable states of 
  766. resources, version control systems allow not only stable pointers into 
  767.  
  768. Slein, Vitali, Whitehead, Durand                                Page 13
  769. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  770.  
  771. those resources, but also well-defined methods to determine the 
  772. relationships of those states of a resource.
  773.  
  774. It allows explicit semantic representation of single resources with 
  775. multiple states. A versioning system directly represents the fact that 
  776. a resource has an explicit history, and a persistent identity across 
  777. the various states it has had during the course of that history.
  778.  
  779. 5.10. Security
  780.  
  781. 5.10.1. Authentication. The WebDAV specification should state how the 
  782. WebDAV extensions interoperate with existing authentication schemes, 
  783. and should make recommendations for using those schemes.
  784.  
  785. 5.10.2. Access Control. Access control requirements are specified 
  786. in a separate access control draft [AC].
  787.  
  788. 5.10.3. Interoperability with Security Protocols. The WebDAV 
  789. specification should provide a minimal list of security protocols
  790. which any compliant server / client should support.  These protocols
  791. should insure the authenticity of messages and the privacy and 
  792. integrity of messages in transit.
  793.  
  794. 5.11. Internationalization
  795.  
  796. 5.11.1. Functional Requirement
  797.  
  798. For transmission of information intended for user comprehension,
  799. the full Universal Character Set (UCS) [ISO 10646] must be available.
  800. Language information and negotiation must be available where
  801. appropriate.
  802.  
  803. 5.11.2. Rationale
  804.  
  805. In the international environment of the Internet, it is important 
  806. to insure that any information intended for user comprehension will 
  807. be transported in a form that makes it possible to display the 
  808. information in any writing system and language agreeable to both the 
  809. client and the server. The information encompassed by this requirement 
  810. includes not only the content of resources, but also display names 
  811. and descriptions of properties, property values, and status messages. 
  812.  
  813. 6. Acknowledgements
  814.  
  815. Our understanding of these issues has emerged as the result of much
  816. thoughtful discussion, email, and assistance by many people, who
  817. deserve recognition for their effort.
  818.  
  819. Terry Allen, tallen@sonic.net
  820. Alan Babich, FileNet, babich@filenet.com
  821. Dylan Barrell, Open Text, dbarrell@opentext.ch
  822. Barbara Bazemore, PC DOCS, barbarab@pcdocs.com
  823. Martin Cagan, Continuus Software, Marty_Cagan@continuus.com
  824. Steve Carter, Novell, srcarter@novell.com
  825. Dan Connolly, World Wide Web Consortium, connolly@w3.org
  826.  
  827. Slein, Vitali, Whitehead, Durand                                Page 14
  828. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  829.  
  830. Jim Cunningham, Netscape, jfc@netscape.com
  831. Ron Daniel Jr., Los Alamos National Laboratory, rdaniel@lanl.gov
  832. Mark Day, Lotus, Mark_Day@lotus.com
  833. Martin J. Duerst, mduerst@ifi.unizh.ch
  834. Asad Faizi, Netscape, asad@netscape.com
  835. Ron Fein, Microsoft, ronfe@microsoft.com
  836. David Fiander, Mortice Kern Systems, davidf@mks.com
  837. Roy Fielding, U.C. Irvine, fielding@ics.uci.edu
  838. Mark Fisher, Thomson Consumer Electronics, FisherM@indy.tce.com
  839. Yaron Y. Goland, Microsoft, yarong@microsoft.com
  840. Phill Hallam-Baker, MIT, hallam@ai.mit.edu
  841. Dennis Hamilton, Xerox PARC, hamilton@parc.xerox.com
  842. Andre van der Hoek, University of Colorado, Boulder,
  843.   andre@cs.colorado.edu
  844. Del Jensen, Novell, dcjensen@novell.com
  845. Gail Kaiser, Columbia University, kaiser@cs.columbia.edu
  846. Rohit Khare, World Wide Web Consortium, khare@w3.org
  847. Mike Little, Bellcore, little@bellcore.com
  848. Dave Long, America Online, dave@sb.aol.com
  849. Henrik Frystyk Nielsen, World Wide Web Consortium, frystyk@w3.org
  850. Ora Lassila, Nokia Research Center, ora.lassila@research.nokia.com
  851. Larry Masinter, Xerox PARC, masinter@parc.xerox.com
  852. Murray Maloney, SoftQuad, murray@sq.com
  853. Jim Miller, World Wide Web Consortium, jmiller@w3.org
  854. Howard S. Modell, Boeing, howard.s.modell@boeing.com
  855. Keith Moore, University of Tennessee, Knoxville, moore@cs.utk.edu
  856. Jon Radoff, NovaLink, jradoff@novalink.com
  857. Alan Robertson, alanr@bell-labs.com
  858. Henry Sanders, Microsoft, 
  859. Andrew Schulert, Microsoft, andyschu@microsoft.com
  860. Christopher Seiwald, Perforce Software, seiwald@perforce.com
  861. Einar Stefferud, stef@nma.com
  862. Richard Taylor, U.C. Irvine, taylor@ics.uci.edu
  863. Robert Thau, MIT, rst@ai.mit.edu
  864. Sankar Virdhagriswaran, sv@hunchuen.crystaliz.com
  865. Gregory J. Woodhouse, gjw@wnetc.com
  866.  
  867. 7. References
  868.  
  869. [AC] J. Radoff, "Requirements for Access Control within 
  870. Distributed Authoring and Versioning Environments on the World 
  871. Wide Web".
  872.  
  873. [CM] P. Feiler, "Configuration Management Models in Commercial
  874. Environments", Software Engineering Institute Technical Report
  875. CMU/SEI-91-TR-7, 
  876. <http://www.sei.cmu.edu/products/publications/91.reports/91.tr.007.html>
  877.  
  878. [HTML] T. Berners-Lee, D. Connolly, "HyperText Markup Language
  879. Specification - 2.0", RFC 1866, MIT/LCS, November 1995.
  880.  
  881. [HTTP] R. Fielding, J. Gettys, J. C. Mogul, H. Frystyk, and
  882. T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2068,
  883. U.C. Irvine, DEC, MIT/LCS, January 1997.
  884.  
  885.  
  886. Slein, Vitali, Whitehead, Durand                                Page 15
  887. draft-ietf-webdav-requirements-01.txt   WebDAV Requirements   July 1997
  888.  
  889. [ISO 10646] ISO/IEC 10646-1:1993. "International Standard --
  890. Information Technology -- Universal Multiple-Octet Coded Character
  891. Set (UCS) -- Part 1: Architecture and Basic Multilingual Plane."
  892.  
  893. [URL] T. Berners-Lee, L. Masinter, M. McCahill. "Uniform Resource
  894. Locators (URL)", RFC 1738, CERN, Xerox PARC, University of Minnesota,
  895. December 1994.
  896.  
  897. [VSE] A. Haake, D. Hicks, "VerSE: Towards Hypertext Versioning Styles", 
  898. Proc. Hypertext'96, The Seventh ACM Conference on Hypertext, 1996,
  899. pages 224-234.
  900.  
  901. 8. Authors' Addresses
  902.  
  903. Judith Slein
  904. Xerox Corporation
  905. 800 Phillips Road 128-29E
  906. Webster, NY 14580
  907.  
  908. EMail: slein@wrc.xerox.com
  909.  
  910. Fabio Vitali
  911. Department of Computer Science
  912. University of Bologna
  913. ITALY
  914.  
  915. EMail: fabio@cs.unibo.it
  916.  
  917. E. James Whitehead, Jr.
  918. Department of Information and Computer Science
  919. University of California
  920. Irvine, CA 92697-3425
  921.  
  922. Fax: 714-824-4056
  923. EMail: ejw@ics.uci.edu
  924.  
  925. David G. Durand
  926. Department of Computer Science
  927. Boston University
  928. Boston, MA
  929.  
  930. EMail: dgd@cs.bu.edu
  931.  
  932. Expires January 24, 1998
  933.  
  934. Slein, Vitali, Whitehead, Durand                                Page 16
  935.  
  936.