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-00.txt < prev    next >
Text File  |  1997-06-02  |  38KB  |  918 lines

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