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-02.txt < prev    next >
Text File  |  1997-08-30  |  41KB  |  968 lines

  1.  
  2. WEBDAV Working Group                J.A. Slein
  3. INTERNET-DRAFT                      Xerox Corporation
  4. <draft-ietf-webdav-requirements-02.txt>        F. Vitali
  5.                         University of Bologna              
  6.                         E.J. Whitehead, Jr.
  7.                         U.C. Irvine
  8.                         D.G. Durand
  9.                         Boston University
  10.                         August 29, 1997
  11.  
  12. Expires February 28, 1998
  13.  
  14.      Requirements for Distributed Authoring and Versioning 
  15.                     on the World Wide Web
  16.  
  17.  
  18. Status of this Memo
  19.  
  20. This document is an Internet draft. Internet drafts are working
  21. documents of the Internet Engineering Task Force (IETF), its areas and
  22. its working groups. Note that other groups may also distribute working
  23. information as Internet drafts.
  24.  
  25. Internet Drafts are draft documents valid for a maximum of six months
  26. and can be updated, replaced or obsoleted by other documents at any
  27. time. It is inappropriate to use Internet drafts as reference material
  28. or to cite them as other than as "work in progress".
  29.  
  30. To learn the current status of any Internet draft please check the
  31. "lid-abstracts.txt" listing contained in the Internet drafts shadow
  32. directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
  33. munnari.oz.au (Pacific Rim), ds.internic.net (US East coast) or
  34. ftp.isi.edu (US West coast). Further information about the IETF can be
  35. found at URL: http://www.ietf.org/
  36.  
  37. Distribution of this document is unlimited. Please send comments to the
  38. WWW Distributed Authoring and Versioning (WebDAV) mailing list,
  39. <w3c-dist-auth@w3.org>, which may be joined by sending a message with
  40. subject "subscribe" to <w3c-dist-auth-request@w3.org>. Discussions are
  41. archived at URL:
  42. http://www.w3.org/pub/WWW/Archives/Public/w3c-dist-auth/.
  43.  
  44. Abstract
  45.  
  46. Current World Wide Web (WWW or Web) standards provide simple support 
  47. for applications which allow remote editing of typed data. In practice, 
  48. the existing capabilities of the WWW have proven inadequate to support 
  49. efficient, scalable remote editing free of overwriting conflicts.  
  50. This document presents a list of features in the form of requirements 
  51. which, if implemented, would improve the efficiency of common remote 
  52. editing operations, provide a locking mechanism to prevent overwrite 
  53. conflicts, improve link management support between non-HTML 
  54. data types, provide a simple attribute-value metadata facility, provide
  55. for the creation and reading of container data types, and integrate 
  56. versioning into the WWW.
  57.  
  58. 1. Introduction
  59.  
  60. Slein, Vitali, Whitehead, Durand                                Page 1
  61. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  62.  
  63.  
  64. This document describes functionality which, if incorporated in an 
  65. extension to the existing HTTP proposed standard [HTTP], would allow tools 
  66. for remote loading, editing and saving (publishing) of various media 
  67. types on the WWW to interoperate with any compliant Web server. As much 
  68. as possible, this functionality is described without suggesting a 
  69. proposed implementation, since there are many ways to perform the 
  70. functionality within the WWW framework. It is also possible that a 
  71. single mechanism could simultaneously satisfy several requirements.
  72.  
  73. This document is intended to reflect the consensus of the WWW 
  74. Distributed Authoring and Versioning working group (WebDAV) as to the 
  75. functionality that needs to be standardized to support distributed 
  76. authoring and versioning on the Web.
  77.  
  78. 2. Rationale
  79.  
  80. Current Web standards contain functionality which enables the editing of 
  81. Web content at a remote location, without direct access to the storage 
  82. media via an operating system. This capability is exploited by several 
  83. existing HTML distributed authoring tools, and by a growing number of 
  84. mainstream applications (e.g., word processors) which allow users to 
  85. write (publish) their work to an HTTP server. To date, experience from 
  86. the HTML authoring tools has shown they are unable to meet their users' 
  87. needs using the facilities of Web standards. The consequence of 
  88. this is either postponed introduction of distributed authoring 
  89. capability, or the addition of nonstandard extensions to the HTTP 
  90. protocol or other Web standards.  These extensions, developed in 
  91. isolation, are not interoperable.
  92.  
  93. Other authoring applications have wanted to access document repositories 
  94. or version control systems through Web gateways, and have been similarly
  95. frustrated.  Where this access is available at all, it is through
  96. nonstandard extensions to HTTP or other standards that force clients to 
  97. use a different interface for each vendor's service.
  98.  
  99. This document describes requirements for a set of standard extensions
  100. to HTTP that would allow distributed Web authoring tools to provide
  101. the functionality their users need by means of the same standard
  102. syntax across all compliant servers. The broad categories of 
  103. functionality that need to be standardized are:
  104.  
  105.     Properties
  106.     Links
  107.     Locking
  108.     Reservations
  109.     Retrieval of Unprocessed Source
  110.     Partial Write
  111.     Name Space Manipulation
  112.     Collections
  113.     Versioning
  114.     Variants
  115.     Security
  116.     Internationalization
  117.  
  118.  
  119. Slein, Vitali, Whitehead, Durand                                Page 2
  120. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  121.  
  122. 3. Terminology
  123.  
  124. Where there is overlap, usage is intended to be consistent with that in 
  125. the HTTP 1.1 specification [HTTP].
  126.  
  127. Client
  128.     A program which issues HTTP requests and accepts responses.
  129.  
  130. Collection
  131.     A collection is a resource that contains other resources,
  132.     either directly or by reference.
  133.  
  134. Distributed Authoring Tool
  135.     A program which can retrieve a source entity via HTTP, allow 
  136.     editing of this entity, and then save/publish this entity
  137.     to a server using HTTP.
  138.  
  139. Entity
  140.     The information transferred in a request or response.
  141.  
  142. Hierarchical Collection
  143.     A hierarchical organization of resources.  A hierarchical
  144.     collection is a resource that contains other resources, 
  145.     including collections, either directly or by reference.
  146.  
  147. Link
  148.     A typed connection between two or more resources.
  149.  
  150. Lock
  151.     A mechanism for preventing anyone other than the owner of the
  152.     lock from accessing a resource.
  153.  
  154. Member of Version Graph
  155.     A resource that is a node in a version graph, and so is derived
  156.     from the resources that precede it in the graph, and is the 
  157.     basis of those that succeed it.
  158.  
  159. Property
  160.     Named descriptive information about a resource.
  161.  
  162. Reservation
  163.     A declaration that one intends to edit a resource.
  164.  
  165. Resource
  166.     A network data object or service that can be identified by
  167.     a URI.
  168.  
  169. Server
  170.     A program which receives and responds to HTTP requests.
  171.  
  172. User Agent
  173.     The client that initiates a request.
  174.  
  175. Variant
  176.     A representation of a resource.  A resource may have one or more
  177.  
  178. Slein, Vitali, Whitehead, Durand                                Page 3
  179. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  180.  
  181.     representations associated with it at any given time.
  182.  
  183. Version Graph
  184.     A directed acyclic graph with resources as its nodes, where
  185.     each node is derived from its predecessor(s).
  186.  
  187. Write Lock
  188.     A lock that prevents anyone except its owner from modifying
  189.     the resource it applies to.
  190.  
  191.  
  192. 4. General Principles
  193.  
  194. This section describes a set of general principles that the WebDAV
  195. extensions should follow.  These principles cut across categories of
  196. functionality.
  197.  
  198. 4.1. User Agent Interoperability
  199.  
  200. All WebDAV clients should be able to work with any WebDAV-compliant HTTP
  201. server. It is acceptable for some client/server combinations to provide
  202. special features that are not universally available, but the protocol
  203. should be sufficient that a basic level of functionality will be
  204. universal.
  205.  
  206. 4.2. Client Simplicity
  207.  
  208. The WebDAV extensions should be designed to allow client implementations
  209. to be simple.
  210.  
  211. 4.3. Legacy Client Support
  212.  
  213. It should be possible to implement a WebDAV-compliant server in such a
  214. way that it can interoperate with non-WebDAV clients.  Such a server
  215. would be able to understand any valid HTTP 1.1 request from an ordinary
  216. Web client without WebDAV extensions, and to provide a valid HTTP 1.1 
  217. response that does not require the client to understand the extensions.
  218.  
  219. 4.4. Data Format Compatibility
  220.  
  221. WebDAV-compliant servers should be able to work with existing resources 
  222. and URIs [URL]. Special additional information should not become a 
  223. mandatory part of document formats.
  224.  
  225. 4.5. Replicated, Distributed Systems
  226.  
  227. Distribution and replication are at the heart of the Internet.  All
  228. WebDAV extensions should be designed to allow for distribution and
  229. replication.  Version trees should be able to be split across multiple
  230. servers.  Collections may have members on different servers.  Resources
  231. may have properties on different servers.  Any resources may be cached
  232. or replicated for mobile computing or other reasons.  Consequently, the
  233. WebDAV extensions must be able to operate in a distributed, replicated
  234. environment.
  235.  
  236.  
  237. Slein, Vitali, Whitehead, Durand                                Page 4
  238. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  239.  
  240. 4.6 Parsimony in Client-Server Interactions 
  241.  
  242. The WebDAV extensions should keep to a minimum the number of 
  243. interactions between the client and the server needed to perform common
  244. functions. For example, publishing a document to the Web will often mean
  245. publishing content together with related properties.  A client may often 
  246. need to find out what version graph a particular resource belongs to, 
  247. or to find out which resource in a version graph is the published one.
  248. The extensions should make it possible to do these things efficiently.
  249.  
  250. 4.7. Changes to HTTP
  251.  
  252. WebDAV adds a number of new types of objects to the Web: properties, 
  253. collections, version graphs, etc.  Existing HTTP methods such as
  254. DELETE and PUT will have to operate in well-defined ways in this 
  255. expanded environment. WebDAV should explicitly address not only new
  256. methods, headers, and MIME types, but also any required changes to the
  257. existing HTTP methods and headers.
  258.  
  259. 4.8. Alternate Transport Mechanisms
  260.  
  261. It may be desirable to transport WebDAV requests and responses by other
  262. mechanisms, particularly EMail, in addition to HTTP.  The WebDAV protocol
  263. specification should not preclude a future body from developing an
  264. interoperability specification for disconnected operation via EMail.
  265.  
  266. 5. Requirements
  267.  
  268. In the requirement descriptions below, the requirement will be stated,
  269. followed by its rationale.
  270.  
  271. 5.1. Properties
  272.  
  273. 5.1.1. Functional Requirements
  274.  
  275. It must be possible to create, modify, read and delete arbitrary
  276. properties on resources of any media type.
  277.  
  278. 5.1.2. Rationale 
  279.  
  280. Properties describe resources of any media type.  They may 
  281. include bibliographic information such as author, title, publisher, 
  282. and subject, constraints on usage, PICS ratings, etc. These
  283. properties have many uses, such as supporting searches on property
  284. values, enforcing copyrights, and the creation of catalog entries as 
  285. placeholders for objects which are not available in electronic form, or 
  286. which will be available later.
  287.  
  288. 5.2. Links
  289.  
  290. 5.2.1. Functional Requirements
  291.  
  292. It must be possible to create, modify, read and delete typed 
  293. links between resources of any media type.
  294.  
  295.  
  296. Slein, Vitali, Whitehead, Durand                                Page 5
  297. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  298.  
  299. 5.2.2. Rationale 
  300.  
  301. One type of link between resources is the hypertext link, which is 
  302. browsable using a hypertext style point-and-click user interface. Links, 
  303. whether they are browsable hypertext links, or simply a means of 
  304. capturing a connection between resources, have many purposes.  Links 
  305. can support pushbutton printing of a multi-resource document in a 
  306. prescribed order, jumping to the access control page for a resource, 
  307. and quick browsing of related information, such as a table of contents, 
  308. an index, a glossary, a bibliographic record, help pages, etc. While 
  309. link support is provided by the HTML "LINK" element, this is limited 
  310. only to HTML resources [HTML]. Similar support is needed for bitmap image 
  311. types, and other non-HTML media types.  
  312.  
  313. 5.3. Locking
  314.  
  315. 5.3.1. General Principles
  316.  
  317. 5.3.1.1. Independence of locks. It must be possible to lock a resource
  318. without re-reading the resource, and without committing to editing the 
  319. resource.
  320.  
  321. 5.3.1.2. Multi-Resource Locking. It must be possible to take out a 
  322. lock on multiple resources residing on the same server in a single action, 
  323. and this locking operation must be atomic across these resources.
  324.  
  325. 5.3.2. Functional Requirements
  326.  
  327. 5.3.2.1. Write Locks. It must be possible to restrict modification of 
  328. a resource to a specific person.
  329.  
  330. 5.3.2.2. Lock Query. It must be possible to find out whether a given 
  331. resource has any active locks, and if so, who holds those locks.
  332.  
  333. 5.3.2.3. Unlock. It must be possible to remove a lock.
  334.  
  335. 5.3.3. Rationale
  336.  
  337. At present, the Web provides limited support for preventing two or more 
  338. people from overwriting each other's modifications when they save to a 
  339. given URI. Furthermore, there is no way to discover whether someone else
  340. is currently making modifications to a resource. This is known as the 
  341. "lost update problem," or the "overwrite problem." Since there can be 
  342. significant cost associated with discovering and repairing lost 
  343. modifications, preventing this problem is crucial for supporting 
  344. distributed authoring. A write lock ensures that only one person may 
  345. modify a resource, preventing overwrites. Furthermore, locking support 
  346. is a key component of many versioning schemes, a desirable capability 
  347. for distributed authoring.
  348.  
  349. An author may wish to lock an entire web of resources even though he 
  350. is editing just a single resource, to keep the other resources from 
  351. changing. In this way, an author can ensure that if a local hypertext 
  352. web is consistent in his distributed authoring tool, it will then be 
  353. consistent when he writes it to the server. Because of this, it should 
  354.  
  355. Slein, Vitali, Whitehead, Durand                                Page 6
  356. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  357.  
  358. be possible to take out a lock without also causing transmission of the 
  359. contents of a resource.
  360.  
  361. It is often necessary to guarantee that a lock or unlock operation 
  362. occurs at the same time across multiple resources, a feature which is 
  363. supported by the multiple-resource locking requirement. This is useful 
  364. for preventing a collision between two people trying to establish locks 
  365. on the same set of resources, since with multi-resource locking, one of 
  366. the two people will get a lock. If this same multiple-resource locking 
  367. scenario was repeated by using atomic lock operations iterated across 
  368. the resources, the result would be a splitting of the locks between the 
  369. two people, based on resource ordering and race conditions.
  370.  
  371. 5.4. Reservations
  372.  
  373. 5.4.1. Functional Requirements 
  374.  
  375. 5.4.1.1. Reserve. It must be possible for a principal to register with 
  376. the server an intent to edit a given resource, so that other principals 
  377. can discover who intends to edit the resource.
  378.  
  379. 5.4.1.2. Reservation Query. It must be possible to find out whether 
  380. a given resource has any active reservations, and if so, who currently 
  381. holds reservations.
  382.  
  383. 5.4.1.3. Release Reservation.  It must be possible to release the 
  384. reservation.
  385.  
  386. 5.4.2. Rationale
  387.  
  388. Experience from configuration management systems has shown that people 
  389. need to know when they are about to enter a parallel editing situation. 
  390. Once notified, they either decide not to edit in parallel with the 
  391. other authors, or they use out-of-band communication (face-to-face, 
  392. telephone, etc.) to coordinate their editing to minimize the difficulty 
  393. of merging their results. Reservations are separate from locking, since 
  394. a write lock does not necessarily imply a resource will be edited, and 
  395. a reservation does not carry with it any access restrictions. This 
  396. capability supports versioning, since a check-out typically involves 
  397. taking out a write lock, making a reservation, and getting the resource
  398. to be edited.
  399.  
  400. 5.5. Retrieval of Unprocessed Source for Editing
  401.  
  402. 5.5.1. Functional Requirement
  403.  
  404. The source of any given resource must be retrievable.
  405.  
  406. 5.5.2. Rationale
  407.  
  408. There are many cases where the source stored on a server does 
  409. not correspond to the actual entity transmitted in response to an HTTP 
  410. GET. Current known cases are server side include directives, and 
  411. Standard Generalized Markup Language (SGML) source which is
  412. converted on the fly to HyperText Markup Language (HTML) [HTML] output 
  413.  
  414. Slein, Vitali, Whitehead, Durand                                Page 7
  415. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  416.  
  417. entities. There are many possible cases, such as automatic conversion 
  418. of bitmap images into several variant bitmap media types (e.g. GIF, 
  419. JPEG), and automatic conversion of an application's native media type 
  420. into HTML. As an example of this last case, a word processor could 
  421. store its native media type on a server which automatically converts 
  422. it to HTML. A GET of this resource would retrieve the HTML. Retrieving 
  423. the source would retrieve the word processor native format.
  424.  
  425. 5.6. Partial Write.
  426.  
  427. 5.6.1. Functional Requirement 
  428.  
  429. After editing a resource, it must be possible to write only the changes
  430. to the resource, rather than retransmitting the entire resource.
  431.  
  432. 5.6.2. Rationale
  433.  
  434. During distributed editing which occurs over wide geographic separations
  435. and/or over low bandwidth connections, it is extremely inefficient
  436. and frustrating to rewrite a large resource after minor changes, such 
  437. as a one-character spelling correction. Support is needed for 
  438. transmitting "insert" (e.g., add this sentence in the middle of a 
  439. document) and "delete" (e.g. remove this paragraph from the middle of 
  440. a document) style updates. Support for partial resource updates will 
  441. make small edits more efficient, and allow distributed authoring tools 
  442. to scale up for editing large documents.
  443.  
  444. 5.7. Name Space Manipulation
  445.  
  446. 5.7.1. Copy
  447.  
  448. 5.7.1.1. Functional Requirements 
  449.  
  450. It must be possible to duplicate a resource without a client loading, 
  451. then resaving the resource. After the copy operation, the content of 
  452. the destination resource must be octet for octet identical to the 
  453. content of the source resource. A modification to either resource must 
  454. not cause a modification to the other.
  455.  
  456. 5.7.1.2. Rationale
  457.  
  458. There are many reasons why a resource might need to be duplicated, such 
  459. as changing ownership, preparing for major modifications, or making 
  460. a backup. Due to network costs associated with loading and saving a 
  461. resource, it is far preferable to have a server perform a resource copy
  462. than a client. If a copied resource records which resource it is a copy
  463. of, then it would be possible for a cache to avoid loading the copied 
  464. resource if it already locally stores the original.
  465.  
  466. 5.7.2. Move/Rename
  467.  
  468. 5.7.2.1. Functional Requirements 
  469.  
  470. It must be possible to change the location of a resource without 
  471. a client loading, then resaving the resource under a different name. 
  472.  
  473. Slein, Vitali, Whitehead, Durand                                Page 8
  474. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  475.  
  476. After the move operation, the content of the resource at its new 
  477. location must be octet for octet identical to the content of the prior 
  478. resource. It must no longer be possible to access the resource at its 
  479. 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.  
  532. Slein, Vitali, Whitehead, Durand                                Page 9
  533. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  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.     o Release lock
  590.  
  591. Slein, Vitali, Whitehead, Durand                                Page 10
  592. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  593.  
  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. version history. In these cases, a way to refer to the whole version 
  649.  
  650. Slein, Vitali, Whitehead, Durand                                Page 11
  651. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  652.  
  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. 5.9.2.7. Version Topology. There must be a way to retrieve the complete 
  708.  
  709. Slein, Vitali, Whitehead, Durand                                Page 12
  710. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  711.  
  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. those resources, but also well-defined methods to determine the 
  767.  
  768. Slein, Vitali, Whitehead, Durand                                Page 13
  769. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  770.  
  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. 5.10.1. Functional Requirements
  781.  
  782. It must be possible to send variants to the server, describing the 
  783. relationships between the variants and their parent resource.  In 
  784. addition, it must be possible to write and retrieve variants of
  785. property labels, property descriptions, and property values.
  786.  
  787. 5.10.2. Rationale
  788.  
  789. The HTTP working group is addressing problems of content negotiation
  790. and retrieval of variants of a resource.  To extend this work to an 
  791. authoring environment, WEBDAV must standardize mechanisms for authors 
  792. to use when submitting variants to a server.  Authors need to be able 
  793. to provide variants in different file or document formats, for different 
  794. uses. They need to provide variants optimized for different for different
  795. clients and for different output devices.  They need to be able to provide 
  796. variants in different languages in the international environment of the Web.
  797. In support of internationalization requirements (See 5.12 below), variants 
  798. need to be supported not just for the content of resources, but for any 
  799. information intended for human use, such as property values, labels, and 
  800. descriptions.
  801.  
  802. 5.11. Security
  803.  
  804. 5.11.1. Authentication. The WebDAV specification should state how the 
  805. WebDAV extensions interoperate with existing authentication schemes, 
  806. and should make recommendations for using those schemes.
  807.  
  808. 5.11.2. Access Control. Access control requirements are specified 
  809. in a separate access control draft [AC].
  810.  
  811. 5.11.3. Interoperability with Security Protocols. The WebDAV 
  812. specification should provide a minimal list of security protocols
  813. which any compliant server / client should support.  These protocols
  814. should insure the authenticity of messages and the privacy and 
  815. integrity of messages in transit.
  816.  
  817. 5.12. Internationalization
  818.  
  819. 5.12.1. Character Sets and Languages
  820.  
  821. Since Web distributed authoring occurs in a multi-lingual 
  822. environment, information intended for user comprehension must 
  823. conform to the IETF Character Set Policy [CHAR].  This policy
  824. addresses character sets and encodings, and language tagging.
  825.  
  826.  
  827. Slein, Vitali, Whitehead, Durand                                Page 14
  828. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  829.  
  830. 5.12.2. Rationale
  831.  
  832. In the international environment of the Internet, it is important 
  833. to insure that any information intended for user comprehension can be
  834. displayed in a writing system and language agreeable to both the 
  835. client and the server. The information encompassed by this requirement 
  836. includes not only the content of resources, but also such things as
  837. display names and descriptions of properties, property values, and 
  838. status messages. 
  839.  
  840. 6. Acknowledgements
  841.  
  842. Our understanding of these issues has emerged as the result of much
  843. thoughtful discussion, email, and assistance by many people, who
  844. deserve recognition for their effort.
  845.  
  846. Terry Allen, tallen@sonic.net
  847. Alan Babich, FileNet, babich@filenet.com
  848. Dylan Barrell, Open Text, dbarrell@opentext.ch
  849. Barbara Bazemore, PC DOCS, barbarab@pcdocs.com
  850. Martin Cagan, Continuus Software, Marty_Cagan@continuus.com
  851. Steve Carter, Novell, srcarter@novell.com
  852. Dan Connolly, World Wide Web Consortium, connolly@w3.org
  853. Jim Cunningham, Netscape, jfc@netscape.com
  854. Ron Daniel Jr., Los Alamos National Laboratory, rdaniel@lanl.gov
  855. Mark Day, Lotus, Mark_Day@lotus.com
  856. Martin J. Duerst, mduerst@ifi.unizh.ch
  857. Asad Faizi, Netscape, asad@netscape.com
  858. Ron Fein, Microsoft, ronfe@microsoft.com
  859. David Fiander, Mortice Kern Systems, davidf@mks.com
  860. Roy Fielding, U.C. Irvine, fielding@ics.uci.edu
  861. Mark Fisher, Thomson Consumer Electronics, FisherM@indy.tce.com
  862. Yaron Y. Goland, Microsoft, yarong@microsoft.com
  863. Phill Hallam-Baker, MIT, hallam@ai.mit.edu
  864. Dennis Hamilton, Xerox PARC, hamilton@parc.xerox.com
  865. Andre van der Hoek, University of Colorado, Boulder,
  866.   andre@cs.colorado.edu
  867. Del Jensen, Novell, dcjensen@novell.com
  868. Gail Kaiser, Columbia University, kaiser@cs.columbia.edu
  869. Rohit Khare, World Wide Web Consortium, khare@w3.org
  870. Ora Lassila, Nokia Research Center, ora.lassila@research.nokia.com
  871. Ben Laurie, A.L. Digital, ben@algroup.co.uk
  872. Mike Little, Bellcore, little@bellcore.com
  873. Dave Long, America Online, dave@sb.aol.com
  874. Larry Masinter, Xerox PARC, masinter@parc.xerox.com
  875. Murray Maloney, SoftQuad, murray@sq.com
  876. Jim Miller, World Wide Web Consortium, jmiller@w3.org
  877. Howard S. Modell, Boeing, howard.s.modell@boeing.com
  878. Keith Moore, University of Tennessee, Knoxville, moore@cs.utk.edu
  879. Henrik Frystyk Nielsen, World Wide Web Consortium, frystyk@w3.org
  880. Jon Radoff, NovaLink, jradoff@novalink.com
  881. Alan Robertson, alanr@bell-labs.com
  882. Henry Sanders, Microsoft, 
  883. Andrew Schulert, Microsoft, andyschu@microsoft.com
  884. Christopher Seiwald, Perforce Software, seiwald@perforce.com
  885.  
  886. Slein, Vitali, Whitehead, Durand                                Page 15
  887. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  888.  
  889. Einar Stefferud, stef@nma.com
  890. Richard Taylor, U.C. Irvine, taylor@ics.uci.edu
  891. Robert Thau, MIT, rst@ai.mit.edu
  892. Sankar Virdhagriswaran, sv@hunchuen.crystaliz.com
  893. Dan Whelan, FileNet, dan@FILENET.COM
  894. Gregory J. Woodhouse, gjw@wnetc.com
  895.  
  896. 7. References
  897.  
  898. [AC] J. Radoff, "Requirements for Access Control within 
  899. Distributed Authoring and Versioning Environments on the World 
  900. Wide Web".
  901.  
  902. [CHAR] H.T. Alvestrand, "IETF Policy on Character Sets and Languages", 
  903. June 1997, working draft, draft-alvestrand-charset-policy-00.txt.
  904.  
  905. [CM] P. Feiler, "Configuration Management Models in Commercial
  906. Environments", Software Engineering Institute Technical Report
  907. CMU/SEI-91-TR-7, 
  908. <http://www.sei.cmu.edu/products/publications/91.reports/91.tr.007.html>
  909.  
  910. [HTML] T. Berners-Lee, D. Connolly, "HyperText Markup Language
  911. Specification - 2.0", RFC 1866, MIT/LCS, November 1995.
  912.  
  913. [HTTP] R. Fielding, J. Gettys, J. C. Mogul, H. Frystyk, and
  914. T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2068,
  915. U.C. Irvine, DEC, MIT/LCS, January 1997.
  916.  
  917. [ISO 10646] ISO/IEC 10646-1:1993. "International Standard --
  918. Information Technology -- Universal Multiple-Octet Coded Character
  919. Set (UCS) -- Part 1: Architecture and Basic Multilingual Plane."
  920.  
  921. [URL] T. Berners-Lee, L. Masinter, M. McCahill. "Uniform Resource
  922. Locators (URL)", RFC 1738, CERN, Xerox PARC, University of Minnesota,
  923. December 1994.
  924.  
  925. [VSE] A. Haake, D. Hicks, "VerSE: Towards Hypertext Versioning Styles", 
  926. Proc. Hypertext'96, The Seventh ACM Conference on Hypertext, 1996,
  927. pages 224-234.
  928.  
  929. 8. Authors' Addresses
  930.  
  931. Judith Slein
  932. Xerox Corporation
  933. 800 Phillips Road 128-29E
  934. Webster, NY 14580
  935.  
  936. EMail: slein@wrc.xerox.com
  937.  
  938. Fabio Vitali
  939. Department of Computer Science
  940. University of Bologna
  941. ITALY
  942.  
  943. EMail: fabio@cs.unibo.it
  944.  
  945. Slein, Vitali, Whitehead, Durand                                Page 16
  946. draft-ietf-webdav-requirements-02.txt   WebDAV Requirements   Aug 1997
  947.  
  948.  
  949. E. James Whitehead, Jr.
  950. Department of Information and Computer Science
  951. University of California
  952. Irvine, CA 92697-3425
  953.  
  954. Fax: 714-824-4056
  955. EMail: ejw@ics.uci.edu
  956.  
  957. David G. Durand
  958. Department of Computer Science
  959. Boston University
  960. Boston, MA
  961.  
  962. EMail: dgd@cs.bu.edu
  963.  
  964. Expires February 28, 1998
  965.  
  966. Slein, Vitali, Whitehead, Durand                                Page 17
  967.  
  968.