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-03.txt < prev    next >
Text File  |  1997-09-23  |  41KB  |  974 lines

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