WEBDAV DASL Working GroupJ. Reschke
Internet-Draftgreenbytes
Intended status: InformationalS. Reddy
Expires: September 2002Oracle
J. Davis
Intelligent Markets
A. Babich
Filenet
March 2002

WebDAV SEARCH

Status of this Memo

This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress”.

The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt.

The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html.

This Internet-Draft will expire in September 2002.

Copyright Notice

Copyright © The Internet Society (2002). All Rights Reserved.

Abstract

1 This document specifies a set of methods, headers, and content-types composing DASL, an application of the HTTP/1.1 protocol to efficiently search for DAV resources based upon a set of client-supplied criteria.

2 Distribution of this document is unlimited. Please send comments to the Distributed Authoring and Versioning (WebDAV) working group at w3c-dist-auth@w3.org, which may be joined by sending a message with subject "subscribe" to w3c-dist-auth-request@w3.org.

3 Discussions of the WEBDAV working group are archived at URL: http://lists.w3.org/Archives/Public/w3c-dist-auth/.

4 This document specifies a set of methods, headers, properties and content-types composing WebDAV SEARCH, an application of the HTTP/1.1 protocol to efficiently search for DAV resources based upon a set of client-supplied criteria.

5 Distribution of this document is unlimited. Please send comments to the Distributed Authoring and Versioning (WebDAV) DASL working group at www-webdav-dasl@w3.org, which may be joined by sending a message with subject "subscribe" to www-webdav-dasl-request@w3.org.

6 Discussions of the WEBDAV DASL working group are archived at URL: http://www.w3.org/pub/WWW/Archives/Public/www-webdav-dasl/.



1. Introduction

1.1. DASL

 I  introduction   (type: change, status: closed)
julian.reschke@greenbytes.de2002-01-25Need to rewrite introduction stating that is based on the expired WebDAV DASL internet draft.

7 This document defines WebDAV SEARCH, an application of HTTP/1.1 forming a lightweight search protocol to transport queries and result sets and allows clients to make use of server-side search facilities. It is based on the expired draft for WebDAV DASL [DASL]. [DASLREQ] describes the motivation for DASL.

8 This document defines DAV Searching & Locating (DASL), an application of HTTP/1.1 forming a lightweight search protocol to transport queries and result sets and allows clients to make use of server-side search facilities. [DASLREQ] describes the motivation for DASL.

9 DASL will minimize the complexity of clients so as to facilitate widespread deployment of applications capable of utilizing the DASL search mechanisms.

10 DASL consists of:

  • the SEARCH method,
  • the DASL response header,
  • the DAV:searchrequest XML element,
  • the DAV:queryschema property,
  • the DAV:basicsearch XML element and query grammar, and
  • the DAV:basicsearchschema XML element.

17 For WebDAV-compliant servers, it also defines a new live property DAV:supported-query-grammar-set.

1.2. Relationship to DAV

18 DASL relies on the resource and property model defined by [RFC2518]. DASL does not alter this model. Instead, DASL allows clients to access DAV-modeled resources through server-side search.

1.3. Terms

19 This draft uses the terms defined in [RFC2616], [RFC2518], and [DASLREQ].

1.4. Notational Conventions

20 The augmented BNF used by this document to describe protocol elements is exactly the same as the one described in Section 2.1 of [RFC2616]. Because this augmented BNF uses the basic production rules provided in Section 2.2 of [RFC2616], those rules apply to this document as well.

21 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT" "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].

22 

 I  namespace   (type: change, status: closed)
julian.reschke@greenbytes.de2002-01-25As this is an individual (non working group) submission, it should not use the DAV: namespace for any new elements. Need to collect feedback.
When an XML element type in the "DAV:" namespace is referenced in this document outside of the context of an XML fragment, the string "DAV:" will be prefixed to the element type.

23 Note that this draft currently defines elements and properties in the WebDAV namespace "DAV:", which it shouldn't do as it isn't a work item of the WebDAV working group. The reason for this is the desire for some kind of backward compatibility to the expired DASL drafts and the assumption that the draft may become an official RFC submission of the WebDAV working group at a later point of time.

24 Similarily, when an XML element type in the namespace "http://www.w3.org/2001/XMLSchema" is referenced in this document outside of the context of an XML fragment, the string "xs:" will be prefixed to the element type.

1.5. An Overview of DASL at Work

25 One can express the basic usage of DASL in the following steps:

  • The client constructs a query using the DAV:basicsearch grammar.
  • The client invokes the SEARCH method on a resource that will perform the search (the search arbiter) and includes a text/xml or application/xmlrequest entity that contains the query.
  • The search arbiter performs the query.
  • The search arbiter sends the results of the query back to the client in the response. The server MUST send an entity a text/xml entity that matches the [RFC2518] PROPFIND response.

2. The SEARCH Method

2.1. Overview

30 The client invokes the SEARCH method to initiate a server-side search. The body of the request defines the query. The server MUST emit an entity text/xml entity matching the [RFC2518] PROPFIND response.

31 The SEARCH method plays the role of transport mechanism for the query and the result set. It does not define the semantics of the query. The type of the query defines the semantics.

2.2. The Request

32 The client invokes the SEARCH method on the resource named by the Request-URI.

2.2.1. The Request-URI

33 The Request-URI identifies the search arbiter. Any HTTP resource may function as search arbiter. It is not a new type of resource (in the sense of DAV:resourcetype as defined in [RFC2518]), nor does it have to be a WebDAV-compliant resource.

 I  JW3   (type: change, status: closed)
ejw@ics.uci.edu1999-04-26This specification essentially defines a new type of Web resource, of type "search arbiter". This raises a number of questions regarding how this kind of resource interacts with existing HTTP methods. I would expect to see a section which goes through and details the interactions between HTTP and WebDAV methods and search arbiters. For example, it seems reasonable to me to allow a search arbiter to potentially reply to GET (perhaps with a human-meaningful description of the capabilities of the arbiter), and for this GET response to potentially be authorable using PUT, and locked using LOCK. However, I wouldn't expect COPY, MOVE, or DELETE to work, although I would expect PROPPATCH and PROPFIND to work OK. Another issue is what kind of resource type a search arbiter returns in the resourcetype property (I'd expect a <searcharbiter/> element).
ejw@ics.uci.edu1999-04-26How does a search arbiter respond to searches, if the search arbiter URI is within a search scope? The answer to this is related to the answer to whether a search arbiter has its own properties, body, etc.
julian.reschke@greenbytes.de2002-03-03A SEARCH arbiter is no special kind of resource and thus this spec doesn't define any particular behaviour.
Martin.Wallmer@softwareag.com2002-03-08 for my understanding the term "search arbiter" is an abstract term for a piece of software, that suplies the SEARCH funcionality. As DASL is an extension of WEBDAV, this piece of software will always be a complete WebDAV server with the well defined behavior of GET, PROPFIND and so on. So no additional definition is necessesary IMHO.

34 The SEARCH method defines no relationship between the arbiter and the scope of the search, rather the particular query grammar used in the query defines the relationship. For example, the FOO query grammar may force the request-URI to correspond exactly to the search scope.

 I  JW9   (type: change, status: closed)
ejw@ics.uci.edu1999-04-26How does a DAV client discover which search arbiter can be used to search a portion of the DAV namespace? At present, the specification seems to imply two things (a) that "/" might be a typical arbiter, and (b) that other arbiters can exist and you can get redirected to them. If this issue isn't addressed in the specification, it might lead to clients having hard-coded search arbiter locations, thus forcing servers to put an arbiter at those locations or be non-interoperable. Or, it will require clients to be configured with the search arbiter location, which also seems bad. It seems far better to have a predefined mechanism which clients can use to discover the location of the search arbiter. One simple mechanism would be to define a property on each collection (but not each resource) which gives the location(s) of appropriate arbiters.
julian.reschke2002-03-10 If a WebDAV-enabled collection is smart enough to know about search arbiters in scope, couldn't it be just forward SEARCH requests to those (making itself a kind of proxy arbiter?). Issue closed as this doesn't seem to solve the *general* discovery problem.

2.2.2. The Request Body

35 The server MUST process a text/xml or application/xml request body, and MAY process request bodies in other formats. See [RFC3023] for guidance on packaging XML in requests.

36 If the client sends a text/xml or application/xml body, it MUST include the DAV:searchrequest XML element. The DAV:searchrequest XML element identifies the query grammar, defines the criteria, the result record, and any other details needed to perform the search.

2.3. The DAV:searchrequest XML Element

<!ELEMENT searchrequest ANY >

37 The DAV:searchrequest XML element contains a single XML element that defines the query. The name of the query element defines the type of the query. The value of that element defines the query itself.

2.4. The Successful 207 (Multistatus) Response

 I  JW8   (type: change, status: closed)
ejw@ics.uci.edu2000-04-20Is the response from SEARCH cacheable? (No).

38 If the server returns 207 (Multistatus), then the search proceeded successfully and the response MUST match that of a PROPFIND. The results of this method SHOULD NOT be cached.

39 There MUST be one DAV:response for each resource that matched the search criteria. For each such response, the DAV:href element contains the URI of the resource, and the response MUST include a DAV:propstat element.

40 In addition, the server MAY include DAV:response items in the reply where the DAV:href element contains a URI that is not a matching resource, e.g. that of a scope or the query arbiter. Each such response item MUST NOT contain a DAV:propstat element, and MUST contain a DAV:status element (unless no property was selected).It SHOULD contain a DAV:responsedescription.

2.4.1. Extending the PROPFIND Response

41 A response MAY include more information than PROPFIND defines so long as the extra information does not invalidate the PROPFIND response. Query grammars SHOULD define how the response matches the PROPFIND response.

2.4.2. Example: A Simple Request and Response

42 This example demonstrates the request and response framework. The following XML document shows a simple (hypothetical) natural language query. The name of the query element is FOO:natural-language-query, thus the type of the query is FOO:natural-language-query. The name of the query element is natural-language-query in the XML namespace "http://example.com/foo". The actual query is "Find the locations of good Thai restaurants in Los Angeles". For this hypothetical query, the arbiter returns two properties for each selected resource.

 I  encoding   (type: edit, status: closed)
julian.reschke@greenbytes.de2002-02-18 Make sure that all examples specify an encoding when content type text/xml is used.

43 >> Request:

SEARCH / HTTP/1.1
Host: ryu.com
Content-Type: application/xml
Content-Length: xxx

<?xml version="1.0" encoding="UTF-8"?>
<D:searchrequest xmlns:D="DAV:" xmlns:F="http://example.com/foo">
  <F:natural-language-query>
    Find the locations of good Thai restaurants in Los Angeles
  </F:natural-language-query>
</D:searchrequest>

44 >> Response:

HTTP/1.1 207 Multi-Status
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

<?xml version="1.0" encoding="UTF-8"?>
<D:multistatus xmlns:D="DAV:" xmlns:F="http://example.com/foo"
  xmlns:R="http://ryu.com/propschema">
  <D:response>
    <D:href>http://siamiam.com/</D:href>
    <D:propstat>
      <D:prop>
        <R:location>259 W. Hollywood</R:location>
        <R:rating><R:stars>4</R:stars></R:rating>
      </D:prop>
    </D:propstat>
  </D:response>
</D:multistatus>

45 >> Response:

HTTP/1.1 207 Multi-Status
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

<?xml version="1.0" encoding="UTF-8"?>
<D:multistatus xmlns:D="DAV:" xmlns:R="http://ryu.com/propschema">
  <D:response>
    <D:href>http://siamiam.com/</D:href>
    <D:propstat>
      <D:prop>
        <R:location>259 W. Hollywood</R:location>
        <R:rating><R:stars>4</R:stars></R:rating>
      </D:prop>
    </D:propstat>
  </D:response>
</D:multistatus>

2.4.3. Example: Result Set Truncation

46 A server MAY limit the number of resources in a reply, for example to limit the amount of resources expended in processing a query. If it does so, the reply MUST use status code 207, return a DAV:multistatus response body and indicate a status of 507 (Insufficient Storage) for the search arbiter URI. It SHOULD include the partial results.

47 When a result set is truncated, there may be many more resources that satisfy the search criteria but that were not examined.

48 If partial results are included and the client requested an ordered result set in the original request, then any partial results that are returned MUST be ordered as the client directed.

49 Note that the partial results returned MAY be any subset of the result set that would have satisfied the original query.

50 >> Request:

SEARCH / HTTP/1.1
Host: gdr.com
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

 ... the query goes here ...

51 >> Response:

HTTP/1.1 207 Multistatus
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

<?xml version="1.0" encoding="utf-8"?>
<D:multistatus xmlns:D="DAV:">
  <D:response>
    <D:href>http://www.gdr.com/sounds/unbrokenchain.au</D:href>
    <D:propstat>
      <D:prop/>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
  <D:response>
    <D:href>http://tech.mit.edu/archive96/photos/Lesh1.jpg</D:href>
    <D:propstat>
      <D:prop/>
      <D:status>HTTP/1.1 200 OK</D:status>
    </D:propstat>
  </D:response>
  <D:response>
    <D:href>http://gdr.com</D:href>
    <D:status>HTTP/1.1 507 Insufficient Storage</D:status>
    <D:responsedescription xml:lang="en">
       Only first two matching records were returned
    </D:responsedescription>
  </D:response>
</D:multistatus>

2.5. Unsuccessful Responses

52 If an error occurred that prevented execution of the query, the server MUST indicate the failure with the appropriate status code and SHOULD include a DAV:multistatus element to point out errors associated with scopes.

53 400 Bad Request. The query could not be executed. The request may be malformed (not valid XML for example). Additionally, this can be used for invalid scopes and search redirections.

54 422 Unprocessable entity. The query could not be executed. If a application/xml ortext/xml request entity was provided, then it may have been valid (well-formed) but may have contained an unsupported or unimplemented query operator.

 I  JW4/DB4/DB5   (type: change, status: closed)
ejw@ics.uci.edu1999-04-26Section 2.5 states that the 507 (Insufficient Storage) status code should be returned when SEARCH produces more responses that the server is willing to immediately return. A 5xx status code isn't appropriate for this case, since the response does have valid search results, indicating that the client correctly submitted a search, and this search was successfully performed by the server, even if it isn't returning all search results. I recommend defining a new status code for this case, 208 (Partial Results).
ejw@ics.uci.edu2000-04-20When results are truncated, server replies with a 507 and also returns an XML element.
ejw@ics.uci.edu2000-04-20507 is currently in conflict with other specs. Need to avoid collisions.
julian.reschke@greenbytes.de2002-02-18Use 207 (Multistatus) instead.

55 507 (Insufficient Storage). The query produced more results than the server was willing to transmit. Partial results have been transmitted. The server MUST send a body that matches that for 207, except that there MAY exist resources that matched the search criteria for which no corresponding DAV:response exists in the reply.

del-1. Example: Result Set Truncation

56 A server MAY limit the number of resources in a reply, for example to limit the amount of resources expended in processing a query. If it does so, the reply MUST use status code 507. It SHOULD include the partial results.

57 When a result set is truncated, there may be many more resources that satisfy the search criteria but that were not examined.

58 If partial results are included and the client requested an ordered result set in the original request, then any partial results that are returned MUST be ordered as the client directed.

59 Note that the partial results returned MAY be any subset of the result set that would have satisfied the original query.

60 >> Request:

SEARCH / HTTP/1.1
Host: gdr.com
Content-Type: application/xml
Content-Length: xxxxx

<?xml version="1.0" encoding="UTF-8"?>
<D:searchrequest xmlns:D="DAV:">
  <D:basicsearch>
    ... the query goes here ...
  </D:basicsearch>
</D:searchrequest>

61 >> Response:

HTTP/1.1 507 Insufficient Storage
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

<?xml version="1.0" encoding="UTF-8"?>
<D:multistatus xmlns:D="DAV:">
   <D:response>
      <D:href>http://www.gdr.com/sounds/unbrokenchain.au</D:href>
      <D:propstat>
         <D:prop/>
         <D:status>HTTP/1.1 200 OK</D:status>
      </D:propstat>
   </D:response>
   <D:response>
      <D:href>http://tech.mit.edu/archive96/photos/Lesh1.jpg</D:href>
        <D:propstat>
           <D:prop/>
           <D:status>HTTP/1.1 200 OK</D:status>
        </D:propstat>
   </D:response>
   <D:response>
     <D:href>http://gdr.com</D:href>
     <D:status>HTTP/1.1 507 Insufficient Storage</D:status>
     <D:responsedescription>
        Only first two matching records were returned
     </D:responsedescription>
   </D:response>
</D:multistatus>

2.6. Invalid Scopes

2.6.1. Indicating an Invalid Scope

62 A client may submit a scope that the arbiter may be unable to query. The inability to query may be due to network failure, administrative policy, security, etc. This raises the condition described as an "invalid scope".

63 To indicate an invalid scope, the server MUST respond with a 400 (Bad Request).

64 The response includes a text/xmlbody with a DAV:multistatus element. Each DAV:response in the DAV:multistatus identifies a scope. To indicate that this scope is the source of the error, the server MUST include the DAV:scopeerror element.

2.6.2. Example of an Invalid Scope

65 >> Response:

HTTP/1.1 400 Bad-Request
Content-Type: text/xml; charset="utf-8"   
Content-Length: xxx

<?xml version="1.0" encoding="UTF-8"?>

<d:multistatus xmlns:d="DAV:">
  <d:response>
    <d:href>http://www.foo.com/X</d:href>
      <d:status>HTTP/1.1 404 Object Not Found</d:status>
    <d:scopeerror/>
  </d:response>
</d:multistatus>

3. Discovery of Supported Query Grammars

66 Servers MUST support discovery of the query grammars supported by a search arbiter resource.

67 Clients can determine which query grammars are supported by an arbiter by invoking OPTIONS on the search arbiter. If the resource supports SEARCH, then the DASL response header will appear in the response. The DASL response header lists the supported grammars.

68 Servers supporting the WebDAV extensions [RFC3253] and/or [ACL] MUST also

3.1. The OPTIONS Method

71 The OPTIONS method allows the client to discover if a resource supports the SEARCH method and to determine the list of search grammars supported for that resource.

72 The client issues the OPTIONS method against a resource named by the Request-URI. This is a normal invocation of OPTIONS defined in [RFC2616].

73 If a resource supports the SEARCH method, then the server MUST list SEARCH in the OPTIONS response as defined by [RFC2616].

74 DASL servers MUST include the DASL header in the OPTIONS response. This header identifies the search grammars supported by that resource.

3.2. The DASL Response Header

75 >> Response:

DASLHeader = "DASL" ":" Coded-URL-List
Coded-URL-List : Coded-URL [ "," Coded-URL-List ]
Coded-URL ; defined in section 9.4 of [RFC2518]

76 

 I  URI-vs-QNAME   (type: change, status: closed)
julian.reschke@greenbytes.de2001-10-17Here, a grammar is represented as an URI. Later, a grammar is identified by a Qualified XML name (URI reference + local name). This means that the client needs to be aware of a mapping from a URI (that's reported here) to an XML element name (that it can use in a query). Proposal: report XML-based grammars through a different mechanism in SEARCH (details to be done).
The DASL response header indicates server support for a query grammar in the OPTIONS method. The value is a URI that indicates the type of grammar. Note that although the URI can be used to identify each supported search grammar, there is not necessarily a direct relationship between the URI and the XML element name that can be used in XML based SEARCH requests (the element name itself is identified by it's namespace name (a URI reference) and the element's local name).

77 This header MAY be repeated.

78 For example:

DASL: <http://foo.bar.com/syntax1> 
DASL: <http://akuma.com/syntax2>
DASL: <DAV:basicsearch>
DASL: <http://example.com/foo/natural-language-query>

3.3. DAV:supported-search-grammar-set (protected)

79 This WebDAV property is required for any server supporting either [RFC3253] and/or [ACL] and identifies the XML based query grammars that are supported by the search arbiter resource.

<!ELEMENT supported-query-grammar-set (supported-query-grammar*)>

<!ELEMENT supported-query-grammar grammar>

<!ELEMENT grammar ANY>

80 ANY value: a query grammar element type

3.4. Example: Grammar Discovery

81 This example shows that the server supports search on the /somefolder resource with the query grammars: DAV:basicsearch, http://foo.bar.com/syntax1 and http://akuma.com/syntax2. Note that every server MUST support DAV:basicsearch.

82 >> Request:

OPTIONS /somefolder HTTP/1.1
Host: ryu.com

83 >> Response:

HTTP/1.1 200 OK
Date: Tue, 20 Jan 1998 20:52:29 GMT
Allow: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, COPY, MOVE,
       MKCOL, PROPFIND, PROPPATCH, LOCK, UNLOCK, SEARCH
DASL: <DAV:basicsearch>
DASL: <http://foo.bar.com/syntax1> 
DASL: <http://akuma.com/syntax2>

84 This example shows the equivalent taking advantage of a server's support for DAV:supported-method-set and DAV:supported-query-grammar-set.

85 >> Request:

PROPFIND /somefolder HTTP/1.1
Host: ryu.com
Depth: 0
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

<?xml version="1.0" encoding="UTF-8" ?>
<propfind xmlns="DAV:">
  <prop>
    <supported-query-grammar-set/>
    <supported-method-set/>
  </prop>
</propfind>

86 >> Response:

HTTP/1.1 207 Multi-Status
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

<?xml version="1.0" encoding="utf-8" ?>
<multistatus xmlns="DAV:">
  <response>
    <href>http://ryu.com/somefolder</href>
    <propstat>
      <prop>
        <supported-query-grammar-set>
          <supported-query-grammar>
            <grammar><basicsearch/></grammar>
          </supported-query-grammar>
          <supported-query-grammar>
            <grammar><syntax1 xmlns="http://foo.bar.com" /></grammar>
          </supported-query-grammar>
          <supported-query-grammar>
            <grammar><syntax2 xmlns="http://akuma.com/"/></grammar>
          </supported-query-grammar>
        </supported-query-grammar-set>
        <supported-method-set>
          <supported-method name="COPY" />
          <supported-method name="DELETE" />
          <supported-method name="GET" />
          <supported-method name="HEAD" />
          <supported-method name="LOCK" />
          <supported-method name="MKCOL" />
          <supported-method name="MOVE" />
          <supported-method name="OPTIONS" />
          <supported-method name="POST" />
          <supported-method name="PROPFIND" />
          <supported-method name="PROPPATCH" />
          <supported-method name="PUT" />
          <supported-method name="SEARCH" />
          <supported-method name="TRACE" />
          <supported-method name="UNLOCK" />
        </supported-method-set>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
  </response>
</multistatus>

87 Note that the query grammar element names marshalled as part of the DAV:supported-query-grammar-set can be directly used as element names in an XML based query.


4. Query Schema Discovery: QSD

88 Servers MAY support the discovery of the schema for a query grammar.

89 The DASL response header provides means for clients to discover the set of query grammars supported by a resource. This alone is not sufficient information for a client to generate a query. For example, the DAV:basicsearch grammar defines a set of queries consisting of a set of operators applied to a set of properties and values, but the grammar itself does not specify which properties may be used in the query. QSD for the DAV:basicsearch grammar allows a client to discover the set of properties that are searchable, selectable, and sortable. Moreover, although the DAV:basicsearch grammar defines a minimal set of operators, it is possible that a resource might support additional operators in a query. For example, a resource might support a optional operator that can be used to express content-based queries in a proprietary syntax. QSD allows a client to discover these operators and their syntax. The set of discoverable quantities will differ from grammar to grammar, but each grammar can define a means for a client to discover what can be discovered.

90 In general, the schema for a given query grammar depends on both the resource (the arbiter) and the scope. A given resource might have access to one set of properties for one potential scope, and another set for a different scope. For example, consider a server able to search two distinct collections, one holding cooking recipes, the other design documents for nuclear weapons. While both collections might support properties such as author, title, and date, the first might also define properties such as calories and preparation time, while the second defined properties such as yield and applicable patents. Two distinct arbiters indexing the same collection might also have access to different properties. For example, the recipe collection mentioned above might also indexed by a value-added server that also stored the names of chefs who had tested the recipe. Note also that the available query schema might also depend on other factors, such as the identity of the principal conducting the search, but these factors are not exposed in this protocol.

91 

 I  qsd-pseudo-property   (type: , status: open)
julian.reschke@greenbytes.de2002-01-25It would be nice to avoid the definition of a "pseudo" property just for this special use case.
Each query grammar supported by DASL defines its own syntax for expressing the possible query schema. A client retrieves the schema for a given query grammar on an arbiter resource with a given scope by invoking the SEARCH method on that arbiter, with that grammar and scope, with a query whose DAV:select element includes the DAV:queryschema property. This property is defined only in the context of such a search, a server SHOULD not treat it as defined in the context of a PROPFIND on the scope. The content of this property is an XML element whose name and syntax depend upon the grammar, and whose value may (and likely will) vary depending upon the grammar, arbiter, and scope.

92 The query schema for DAV:basicsearch is defined in Section 5.19.

4.1. The DAV:queryschema Property

<!ELEMENT queryschema ANY >

4.1.1. Example of query schema discovery

93 In this example, the arbiter is recipes.com, the grammar is DAV:basicsearch, the scope is also recipes.com.

94 >> Request:

 I  queryschema-prop   (type: change, status: closed)
julian.reschke@greenbytes.de2001-10-09DAV:queryschema does not appear in a DAV:prop. Intentional?
SEARCH / HTTP/1.1
Host: recipes.com
Content-Type: application/xml
Content-Length: xxx

<?xml version="1.0"?>
<D:searchrequest xmlns:D="DAV:" >
  <D:basicsearch>
    <D:select>
       <D:queryschema/>
    </D:select>
    <D:from>
      <D:scope>
        <D:href>http://recipes.com</D:href>
      </D:scope>
    </D:from>
  </D:basicsearch>
</D:searchrequest>

95 >> Request:

SEARCH / HTTP/1.1
Host: recipes.com
Content-Type: application/xml
Content-Length: xxx

<?xml version="1.0"?>
<searchrequest xmlns="DAV:">
  <basicsearch>
    <select>
      <prop>
        <queryschema/>
      </prop>
    </select>
    <from>
      <scope>
        <href>http://recipes.com</href>
      </scope>
    </from>
  </basicsearch>
</searchrequest>

96 >> Request:

 I  querygrammar-prop   (type: change, status: closed)
julian.reschke@greenbytes.de2001-10-09DAV:queryschema was selected, but DAV:querygrammar was returned.
HTTP/1.1 207 Multistatus
Content-Type: application/xml
Content-Length: xxx

<?xml version="1.0"?>
<D:multistatus xmlns:D="DAV:">
  <D:response>  
    <D:href>http://recipes.com</D:href>
    <D:propstat>
       <D:prop>
         <D:querygrammar>
           <D:basicsearchschema>
               /See section 5.19.9 for actual contents)
           </D:basicsearchschema>
         </D:querygrammar>
       </D:prop>
       <D:status>HTTP/1.1 200 Okay</D:status>
    </D:propstat>
  </D:response>
</D:multistatus>

97 >> Response:

HTTP/1.1 207 Multistatus
Content-Type: application/xml
Content-Length: xxx

<?xml version="1.0"?>
<multistatus xmlns="DAV:">
  <response>  
    <href>http://recipes.com</href>
    <propstat>
      <prop>
        <queryschema>
          <basicsearchschema>
            (See section "Query schema for DAV:basicsearch" for
            the actual contents) 
          </basicsearchschema>
        </queryschema>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
  </response>
</multistatus>

5. The DAV:basicsearch Grammar

5.1. Introduction

98 DAV:basicsearch uses an extensible XML syntax that allows clients to express search requests that are generally useful for WebDAV scenarios. DASL-extended servers MUST accept this grammar, and MAY accept others grammars.

99 DAV:basicsearch has several components:

  • DAV:select provides the result record definition.
  • DAV:from defines the scope.
  • DAV:where defines the criteria.
  • DAV:orderby defines the sort order of the result set.
  • DAV:limit provides constraints on the query as a whole.
 I  JW24d   (type: , status: open)
ejw@ics.uci.edu2000-04-20Where does xml:lang go in a query?
julian.reschke@greenbytes.de2002-02-28What would be the *purpose* of putting xml:lang into a query?
 I  DB7   (type: change, status: closed)
ejw@ics.uci.edu2000-04-20Searches on XML chunks that include namespaces. Need to expand out the XML namespace when doing the search (i.e., do search on DAV:foo, not X:foo xmlns:X="DAV:") Also an issue for expressing searches on XML sub-elements of properties.
julian.reschke@greenbytes.de2002-01-28I think this is out-of-scope for now.

5.2. The DAV:basicsearch DTD

<!ELEMENT basicsearch   (select, from, where?, orderby?, limit?) >

<!ELEMENT select        (allprop | prop) >

<!ELEMENT from  (scope) >
<!ELEMENT scope (href, depth?) >

<!ENTITY %comp_ops      "eq | lt | gt| lte | gte">
<!ENTITY %log_ops       "and | or | not">
<!ENTITY %special_ops   "isdefined">
<!ENTITY %string_ops    "like">
<!ENTITY %content_ops   "contains">

<!ENTITY %all_ops       "%comp_ops; | %log_ops; | %special_ops; |
                            %string_ops; | %content_ops;">

<!ELEMENT where ( %all_ops; ) >

<!ELEMENT and   ( ( %all_ops; ) +) >

<!ELEMENT or    ( ( %all_ops; ) +) >

<!ELEMENT not   ( %all_ops; ) >

<!ELEMENT lt    ( prop , literal ) >
<!ATTLIST lt    casesensitive   (1|0) "1" >

<!ELEMENT lte   ( prop , literal ) >
<!ATTLIST lte   casesensitive   (1|0) "1" >

<!ELEMENT gt    ( prop , literal) >
<!ATTLIST gt    casesensitive   (1|0) "1" >

<!ELEMENT gte   ( prop , literal ) >
<!ATTLIST gte   casesensitive   (1|0) "1" >

<!ELEMENT eq    ( prop , literal ) >
<!ATTLIST eq    casesensitive   (1|0) "1" >

<!ELEMENT literal       (#PCDATA)>
<!ATTLIST literal       xml:space       (default|preserve) preserve >

<!ELEMENT isdefined     (prop) >
<!ELEMENT like  (prop, literal) >
<!ATTLIST like   casesensitive   (1|0) "1" >

<!ELEMENT contains      (#PCDATA)>

<!ELEMENT orderby       (order+) >
<!ELEMENT order (prop, (ascending | descending)?)

<!ATTLIST order casesensitive   (1|0) "1" >
<!ELEMENT ascending     EMPTY>

<!ELEMENT descending    EMPTY>


<!ELEMENT limit (nresults) >
<!ELEMENT nresults      (#PCDATA) >
<!ELEMENT basicsearch   (select, from, where?, orderby?, limit?) >

<!ELEMENT select        (allprop | prop) >

<!ELEMENT from  (scope) >
<!ELEMENT scope (href, depth) >

<!ENTITY %comp_ops      "eq | lt | gt| lte | gte">
<!ENTITY %log_ops       "and | or | not">
<!ENTITY %special_ops   "is-collection | isdefined">
<!ENTITY %string_ops    "like">
<!ENTITY %content_ops   "contains">

<!ENTITY %all_ops       "%comp_ops; | %log_ops; | %special_ops; |
                            %string_ops; | %content_ops;">

<!ELEMENT where ( %all_ops; ) >

<!ELEMENT and   ( ( %all_ops; ) +) >

<!ELEMENT or    ( ( %all_ops; ) +) >

<!ELEMENT not   ( %all_ops; ) >

<!ELEMENT lt    ( prop , literal ) >
<!ATTLIST lt    casesensitive   (1|0) "1" >

<!ELEMENT lte   ( prop , literal ) >
<!ATTLIST lte   casesensitive   (1|0) "1" >

<!ELEMENT gt    ( prop , literal) >
<!ATTLIST gt    casesensitive   (1|0) "1" >

<!ELEMENT gte   ( prop , literal ) >
<!ATTLIST gte   casesensitive   (1|0) "1" >

<!ELEMENT eq    ( prop , literal ) >
<!ATTLIST eq    casesensitive   (1|0) "1" >

<!ELEMENT literal       (#PCDATA)>

<!ELEMENT isdefined     (prop) >
<!ELEMENT like  (prop, literal) >
<!ATTLIST like   casesensitive   (1|0) "1" >

<!ELEMENT contains      (#PCDATA)>

<!ELEMENT orderby       (order+) >
<!ELEMENT order (prop, (ascending | descending)?)

<!ATTLIST order casesensitive   (1|0) "1" >
<!ELEMENT ascending     EMPTY>

<!ELEMENT descending    EMPTY>


<!ELEMENT limit (nresults) >
<!ELEMENT nresults      (#PCDATA) >

5.2.1. Example Query

106 This query retrieves the content length values for all resources located under the server's "/container1/" URI namespace whose length exceeds 10000.

<d:searchrequest xmlns:d="DAV:">
  <d:basicsearch>
    <d:select>
      <d:prop><d:getcontentlength/></d:prop>
    </d:select>
    <d:from>
      <d:scope>
        <d:href>/container1/</d:href>
        <d:depth>infinity</d:depth>
      </d:scope>
    </d:from>
    <d:where>
      <d:gt> 
        <d:prop><d:getcontentlength/></d:prop>
        <d:literal>10000</d:literal>
      </d:gt>
    </d:where>
      <d:orderby>
        <d:order>
        <d:prop><d:getcontentlength/></d:prop>
        <d:ascending/>
      </d:order>
    </d:orderby>
  </d:basicsearch>
</d:searchrequest>

5.3. DAV:select

107 DAV:select defines the result record, which is a set of properties and values. This document defines two possible values: DAV:allprop and DAV:prop, both defined in [RFC2518].

108 If the value is DAV:allprop, the result record for a given resource includes all the properties for that resource.

109 If the value is DAV:prop, then the result record for a given resource includes only those properties named by the DAV:prop element. Each property named by the DAV:prop element must be referenced in the Multistatus response.

110 The rules governing the status codes for each property match those of the PROPFIND method defined in [RFC2518].

5.4. DAV:from

111 DAV:from defines the query scope. This contains exactly one DAV:scope element. The scope element contains a mandatory DAV:href element and an optional DAV:depth element. The scope element contains mandatory DAV:href and DAV:depth elements.

 I  DB3   (type: change, status: closed)
ejw@ics.uci.edu2000-04-20What should the default Depth value be for SEARCH?
ejw@ics.uci.edu2000-04-20Agreement that Depth must be sent with SEARCH.

112 DAV:href indicates the URI for a collection to use as a scope.

113 When the scope is a collection, if DAV:depth is "0", the search includes only the collection. When it is "1", the search includes the (toplevel) members of the collection. When it is "infinity", the search includes all recursive members of the collection.

5.4.1. Relationship to the Request-URI

114 If the DAV:scope element is an absolute URI, the scope is exactly that URI.

 I  JW12   (type: change, status: closed)
ejw@ics.uci.edu2000-04-20Allowing relative URIs isn't very useful.
ejw@ics.uci.edu2000-04-24Accepted 24 April 2000.
julian.reschke@greenbytes.de2002-02-18Need agreement on either forbidding relate URIs or leaving them in (which doesn't seem to be hard to implement).
julian.reschke@greenbytes.de2002-03-03Relative URI reference resolving code is required in WebDAV anyway, so the issue is closed.

115 If the DAV:scope element is a relative URIis an absolute URI reference, the scope is taken to be relative to the request-URI.

5.4.2. Scope

116 A Scope can be an arbitrary URI.

 I  URIs   (type: change, status: closed)
julian.reschke@greenbytes.de2002-03-03Need to cleanup draft to use correct terms for URIs and URI references.

117 Servers, of course, may support only particular scopes. This may include limitations for particular schemes such as "http:" or "ftp:" or certain URI namespaces.

118 If a scope is given that is not supported the server MUST respond with a 400 status code that includes a Multistatus error. A scope in the query appears as a resource in the response and must include an appropriate status code indicating its validity with respect to the search arbiter.

119 Example:

HTTP/1.1 400 Bad Request
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx

<?xml version="1.0" encoding="UTF-8"?>
<d:multistatus xmlns:d="DAV:">
  <d:response>
    <d:href>http://www.foo.com/scope1</d:href>
    <d:status>HTTP/1.1 502 Bad Gateway</d:status>
  </d:response>
</d:multistatus>

120 This example shows the response if there is a scope error. The response provides a Multistatus with a status for the scope. In this case, the scope cannot be reached because the server cannot search another server (502).

5.5. DAV:where

121 DAV:where element defines the search condition for inclusion of resources in the result set. The value of this element is an XML element that defines a search operator that evaluates to one of the Boolean truth values TRUE, FALSE, or UNKNOWN. The search operator contained by DAV:where may itself contain and evaluate additional search operators as operands, which in turn may contain and evaluate additional search operators as operands, etc. recursively.

 I  query-on-href   (type: , status: open)
julian.reschke@greenbytes.de2002-02-28DAV:href isn't a property, so it can't be used in queries. Is this a problem? Examples where DAV:displayname is queried instead seem to indicate that. A possible solution would be to allow DAV:href whereever DAV:prop is allowed in the where clause.

5.5.1. Use of Three-Valued Logic in Queries

122 Each operator defined for use in the where clause that returns a Boolean value MUST evaluate to TRUE, FALSE, or UNKNOWN. The resource under scan is included as a member of the result set if and only if the search condition evaluates to TRUE.

123 Consult Appendix A for details on the application of three-valued logic in query expressions.

5.5.2. Handling Optional operators

124 If a query contains an operator that is not supported by the server, then the server MUST respond with a 422 (Unprocessable Entity) status code.

5.5.3. Treatment of NULL Values

125 If a PROPFIND for a property value would yield a 404 or 403 response for that property, then that property is considered NULL.

126 NULL values are "less than" all other values in comparisons.

127 Empty strings (zero length strings) are not NULL values. An empty string is "less than" a string with length greater than zero.

128 The DAV:isdefined operator is defined to test if the value of a property is NULL.

5.5.4. Treatment of properties with mixed/element content

129 Comparisons of properties that do not have simple types (text-only content) is out-of-scope for DAV:basicsearch. For querying the DAV:resourcetype property, see Section 5.11.

5.5.5. Example: Testing for Equality

130 The example shows a single operator (DAV:eq) applied in the criteria.

<d:where>
  <d:eq>
    <d:prop> <d:getcontentlength/> </d:prop>
    <d:literal> 100 </d:literal>
  </d:eq>
</d:where>
<d:where>
  <d:eq>
    <d:prop>
      <d:getcontentlength/>
    </d:prop>
    <d:literal>100</d:literal>
  </d:eq>
</d:where>

5.5.6. Example: Relative Comparisons

131 The example shows a more complex operation involving several operators (DAV:and, DAV:eq, DAV:gt) applied in the criteria. This DAV:where expression matches those resources that are "image/gifs" over 4K in size.

<D:where>
  <D:and>
    <D:eq>
      <D:prop> <D:getcontenttype/> </D:prop>
      <D:literal> image/gif </D:literal>
    </D:eq>
    <D:gt>
      <D:prop> <D:getcontentlength/> </D:prop>
      <D:literal> 4096 </D:literal>
    </D:gt>
  </D:and>
</D:where>
<D:where>
  <D:and>
    <D:eq>
      <D:prop>
        <D:getcontenttype/>
      </D:prop>
      <D:literal>image/gif</D:literal>
    </D:eq>
    <D:gt>
      <D:prop>
        <D:getcontentlength/>
      </D:prop>
      <D:literal>4096</D:literal>
    </D:gt>
  </D:and>
</D:where>

5.6. DAV:orderby

132 The DAV:orderby element specifies the ordering of the result set. It contains one or more DAV:order elements, each of which specifies a comparison between two items in the result set. Informally, a comparison specifies a test that determines whether one resource appears before another in the result set. Comparisons are applied in the order they occur in the DAV:orderby element, earlier comparisons being more significant.

 I  JW13   (type: edit, status: closed)
ejw@ics.uci.edu1999-04-26Section 5.6 should have a separate section, with a separate heading, for the description of ascending and descending. I had a hard time finding these descriptions without this section heading.
julian.reschke@greenbytes.de2002-03-03Added to index.

133 The comparisons defined here use only a single property from each resource, compared using the same ordering as the DAV:lt operator (ascending) or DAV:gt operator (descending). If neither direction is specified, the default is DAV:ascending.

 I  null-ordering   (type: , status: open)
ameliac@us.ibm.com2002-02-20In the WebDAV SEARCH spec (5.6, DAV:orderby), it says that nulls sort low, to match SQL92. However, SQL92 and SQL99 both say "Whether a sort key value that is null is considered greater or less than a non-null value is implementation-defined, but all sort key values that are null shall either be considered greater than all non-null values or be considered less than all non-null values." (words taken from SQL99, 14.1 <declare cursor> General Rule 2)c), in reference to null handling for the <order by clause>. ) I would note that in 5.5.3 WebDAV SEARCH says nulls are less than all other values in a comparison, so the DAV:orderby matches that statement, it just gives an inaccurate reason.

134 In the context of the DAV:orderby element, null values are considered to collate before any actual (i.e., non null) value, including strings of zero length (as in [SQL99]as in ANSI standard SQL, [ANSISQL]).

5.6.1. Comparing Natural Language Strings.

 I  language-comparison   (type: , status: open)
julian.reschke@greenbytes.de2002-03-03 XPath/XQuery (see draft, and open issue) specify string comparisons based on collations, not languages. I think we should adopt this. This would mean that "xml:lang" would be removed, and an optional attribute specifying the name of the collation is added.

135 Comparisons on strings take into account the language defined for that property. Clients MAY specify the language using the xml:lang attribute. If no language is specified either by the client or defined for that property by the server or if a comparison is performed on strings of two different languages, the results are undefined.

136 

 I  case-insensitivity   (type: change, status: closed)
julian.reschke@greenbytes.de2001-10-17I think case-insensitive comparison is underspecified here (what does it mean for generic Unicode strings?)
The DAV:casesensitive attribute may be used to indicate case-sensitivity for comparisons. Servers SHOULD do caseless matching as defined in [CaseMap].

5.6.2. Example of Sorting

137 This sort orders first by last name of the author, and then by size, in descending order, so that the largest works appear first.

<d:orderby>
  <d:order>
    <d:prop><r:lastname/></d:prop>
    <d:ascending/>
  </d:order>
  <d:order>
    <d:prop><d:getcontentlength/></d:prop>
    <d:descending/>
  </d:order>
</d:orderby>

5.7. Boolean Operators: DAV:and, DAV:or, and DAV:not

138 The DAV:and operator performs a logical AND operation on the expressions it contains.

139 The DAV:or operator performs a logical OR operation on the values it contains.

140 The DAV:not operator performs a logical NOT operation on the values it contains.

5.8. DAV:eq

 I  JW24c   (type: , status: open)
ejw@ics.uci.edu2000-04-20How do string equality and language tag interact. Cross-language comparison should work at least when the two languages are dialects, e.g. en-us vs en-uk.
julian.reschke@greenbytes.de2002-01-28Proposal: strings match if and only if they match character by character.

141 The DAV:eq operator provides simple equality matching on property values.

142 The DAV:casesensitive attribute may be used with this element.

5.9. DAV:lt, DAV:lte, DAV:gt, DAV:gte

 I  JW16b/JW24a   (type: , status: open)
ejw@ics.uci.edu2000-04-20Define how comparisons on strings work, esp for i18n.
Need policy statement about sort order in various national languages. (JW said "non-Latin" but it's an issue even in languages that use the latin char set.)

143 The DAV:lt, DAV:lte, DAV:gt, and DAV:gte operators provide comparisons on property values, using less-than, less-than or equal, greater-than, and greater-than or equal respectively. The DAV:casesensitive attribute may be used with these elements.

5.10. DAV:literal

 I  DB2/DB7   (type: , status: open)
ejw@ics.uci.edu2000-04-20Dates (HTTPDate in getlastmodified).
ejw@ics.uci.edu2000-04-20Agreement that it is OK to submit isodate to search HTTPDate (i.e., it's a marshalling issue only).
ejw@ics.uci.edu2000-04-20Booleans appear to be underspecified in the specification. How is a boolean tested, and what are the behavior of operators like less than, greater than, etc.
julian.reschke@greenbytes.de2002-01-28I think similar questions apply to booleans. Proposal: allow specification of the literal's type using XML Schema simple types, and declare that "both" WebDAV date types are compatible.
ABabich@filenet.com2002-01-29 The current DASL draft doesn't really have Booleans or any other data type. It's trying to skate on data types. Booleans could be tested using the "eq" and the combination "not eq", if you had well defined literals for TRUE and FALSE. With the current syntax, that is the way you would have to test a Boolean. Generally, Boolean values are not considered to be ordered, so "gt" etc. wouldn't apply. However, if the literal values of a Boolean were 1 and 0 for TRUE and FALSE (using the most commonly used convention of positive logic), then you would have an obvious ordering. 1 and 0 have the advantage of being language independent. You now see a lot of electronic and electro-mechanical devices (air conditioners, computers, etc.) with a "1/0" label on the power switch, "1" meaning "on", and "0" meaning "off".
SQL databases don't have Booleans. SQL doesn't control DASL, of course, but SQL databases are so widely used that they are important. The closest thing in SQL is a bit field. Each bit in a bit field is zero or 1.
So, why not close the issue by saying: DASL doesn't have data types. You can simulate Booleans by an integer data type, using 1 for "TRUE" and 0 for "FALSE".

144 DAV:literal allows literal values to be placed in an expression.

 I  JW14   (type: change, status: closed)
ejw@ics.uci.edu2000-04-20How does xml:space affect DAV:literal.
julian.reschke@greenbytes.de2002-01-28Do we just need an example here?
julian.reschke@greenbytes.de2002-03-01Re-opened: see discussion in DASL mailing list: using xml:space would be inconsistent with WebDAV.

145 Because white space in literal values is significant in comparisons, DAV:literal makes use of the xml:space attribute to identify this significance. The default value of this attribute for DAV:literal is "preserve". Consult section 2.10 of [XML] for more information on the use of this attribute. White space in literal values is significant in comparisons. For consistency with [RFC2518], clients SHOULD NOT specify the attribute "xml:space" (section 2.10 of [XML]) to override this behaviour.

5.11. DAV:is-collection

146 The DAV:is-collection operator allows clients to determine whether a resource is a collection (that is, whether it's DAV:resourcetype element contains the element DAV:collection).

147 Rationale: This operator is provided in lieu of defining generic structure queries, which would suffice for this and for many more powerful queries, but seems inappropriate to standardize at this time.

 I  is-collection   (type: change, status: closed)
julian.reschke@greenbytes.de2002-01-09Update DTD and move up to the other operators.

5.11.1. Example of DAV:is-collection

148 This example shows a search criterion that picks out all and only the resources in the scope that are collections.

<where xmlns="DAV:">
  <is-collection/>
</where>

5.12. DAV:isdefined

149 The DAV:isdefined operator allows clients to determine whether a property is defined on a resource. The meaning of "defined on a resource" is found in Section 5.5.3.

150 Example:

<d:isdefined>
  <d:prop><x:someprop/></d:prop>
</d:isdefined>

151 The DAV:isdefined operator is optional.

5.13. DAV:like

152 The DAV:like is an optional operator intended to give simple wildcard-based pattern matching ability to clients.

153 The operator takes two arguments.

154 The first argument is a DAV:prop element identifying a single property to evaluate.

 I  JW14b   (type: change, status: closed)
ejw@ics.uci.edu2000-04-20The semantics of DAV:literal should not change inside a DAV:like.
julian.reschke@greenbytes.de2002-01-28Does it? Need details.
julian.reschke@greenbytes.de2002-03-03Closed; I think this is clear from the spec.

155 The second argument is a DAV:literal element that gives the pattern matching string.

5.13.1. Syntax for the Literal Pattern

Pattern := [wildcard] 0*( text [wildcard] )
wildcard := exactlyone | zeroormore 
text := 1*( <octet> | escapesequence )
exactlyone : = "?"
zeroormore := "%"
escapechar := "\"
escapesequence := "\" ( exactlyone | zeroormore | escapechar )
Pattern := [wildcard] 0*( text [wildcard] )
wildcard := exactlyone | zeroormore 
text := 1*( <character> | escapesequence )
exactlyone : = "?"
zeroormore := "%"
escapechar := "\"
escapesequence := "\" ( exactlyone | zeroormore | escapechar )
character: see section 2.2 of [XML]
 I  JW15   (type: change, status: closed)
ejw@ics.uci.edu1999-04-26The BNF for a wildcard permits the entry of "</d:literal>" which would confuse parsers. Also, the BNF sequence for text should use characters instead of octets, to better handle multi-octet character set representations (like UTF-16).
julian.reschke@greenbytes.de2002-03-03 Non-issue: the contents of the DAV:literal element is subject to normal XML escaping. Grammar changed to use chars rather than octets.

156 The value for the literal is composed of wildcards separated by segments of text. Wildcards may begin or end the literal. Wildcards may not be adjacent.

157 The "?" wildcard matches exactly one character.

158 The "%" wildcard matches zero or more characters

159 The "\" character is an escape sequence so that the literal can include "?" and "%". To include the "\" character in the pattern, the escape sequence "\\" is used..

5.13.2. Example of DAV:like

160 This example shows how a client might use DAV:like to identify those resources whose content type was a subtype of image.

<D:where>
  <D:like>
    <D:prop><D:getcontenttype/></D:prop>
    <D:literal>image%</D:literal>
  </D:like>
</D:where>

5.14. DAV:contains

 I  JW17/JW24b   (type: , status: open)
ejw@ics.uci.edu2000-04-205.13 should discuss handling of queries when character set differs.
Some text on handling character sets would be helpful.

161 The DAV:contains operator is an optional operator that provides content-based search capability. This operator implicitly searches against the text content of a resource, not against content of properties. The DAV:contains operator is intentionally not overly constrained, in order to allow the server to do the best job it can in performing the search.

162 The DAV:contains operator evaluates to a Boolean value. It evaluates to TRUE if the content of the resource satisfies the search. Otherwise, It evaluates to FALSE.

163 Within the DAV:contains XML element, the client provides a phrase: a single word or whitespace delimited sequence of words. Servers MAY ignore punctuation in a phrase. Case-sensitivity is left to the server.

164 The following things may or may not be done as part of the search: Phonetic methods such as "soundex" may or may not be used. Word stemming may or may not be performed. Thesaurus expansion of words may or may not be done. Right or left truncation may or may not be performed. The search may be case insensitive or case sensitive. The word or words may or may not be interpreted as names. Multiple words may or may not be required to be adjacent or "near" each other. Multiple words may or may not be required to occur in the same order. Multiple words may or may not be treated as a phrase. The search may or may not be interpreted as a request to find documents "similar" to the string operand.

165 The DAV:score property is intended to be useful to rank documents satisfying the DAV:contains operator.

5.14.1. Examples

166 The example below shows a search for the phrase "Peter Forsberg".

167 Depending on its support for content-based searching, a server MAY treat this as a search for documents that contain the words "Peter" and "Forsberg".

<D:where>
  <D:contains>Peter Forsberg</D:contains>
</D:where>

168 The example below shows a search for resources that contain "Peter" and "Forsberg".

<D:where>
  <D:and>
    <D:contains>Peter</D:contains>
    <D:contains>Forsberg</D:contains>
  </D:and>
</D:where>

5.15. The DAV:limit XML Element

<!ELEMENT limit (nresults) >

169 The DAV:limit XML element contains requested limits from the client to limit the size of the reply or amount of effort expended by the server.

5.16. The DAV:nresults XML Element

<!ELEMENT nresults (#PCDATA)> ;only digits
 I  JW5   (type: , status: open)
ejw@ics.uci.edu1999-04-26On the topic of partial search results, DASL currently has no way for a client to request the next chunk of a set of search results. Since *every* search service I've interacted with on the Internet has a feature for returning the next set of search results, I really would expect this feature to be in DASL. An explanation for why this feature isn't present should be in the protocol specification if it is not going to be supported.
Martin.Wallmer@softwareag.com2002-03-08 of course this issue is legitim. However, as basicsearch should be as simple as possible, I tend to say out of scope as well. But perhaps this could be an optional feature (is it that, what you mean by extension to DAV:basicsearch)?
julian.reschke@greenbytes.de2002-03-08 Moved into DAV:basicsearch section, because this is a request for a specific query grammar feature.

170 The DAV:nresults XML element contains a requested maximum number of records to be returned in a reply. The server MAY disregard this limit. The value of this element is an integer.

5.17. The DAV:casesensitive XML attribute

171 

 I  case-insensitivity-name   (type: , status: open)
julian.reschke@greenbytes.de2002-01-09The attribute probably should be renamed to "caseless".
The DAV:casesensitive attribute allows clients to specify case-sensitive or case-insensitive behavior for DAV:basicsearch operators.

172 The possible values for DAV:casesensitive are "1" or "0". The "1" value indicates case-sensitivity. The "0" value indicates case-insensitivity. The default value is server-specified. Case-insensitivity SHOULD implemented using caseless matching as defined in [CaseMap].

173 Support for the DAV:casesensitive is optional. A server should respond with an error 422 if the DAV:casesensitive attribute is used but cannot be supported.

5.18. The DAV:score Property

<!ELEMENT score (#PCDATA)>

174 The DAV:score XML element is a synthetic property whose value is defined only in the context of a query result where the server computes a score, e.g. based on relevance. It may be used in DAV:select or DAV:orderby elements. Servers SHOULD support this property. The value is a string representing the score, an integer from zero to 10000 inclusive, where a higher value indicates a higher score (e.g. more relevant).

175 Clients should note that, in general, it is not meaningful to compare the numeric values of scores from two different query results unless both were executed by the same underlying search system on the same collection of resources.

 I  score-pseudo-property   (type: , status: open)
julian.reschke@greenbytes.de2002-02-28Shouldn't be done using a pseudo-property. Report it as child of DAV:propstat instead?

del-2. The DAV:iscollection Property

<!ELEMENT iscollection  (#PCDATA)>

176 The DAV:iscollection XML element is a synthetic property whose value is defined only in the context of a query.

177 The property is TRUE (the literal string "1") of a resource if and only if a PROPFIND of the DAV:resourcetype property for that resource would contain the DAV:collection XML element. The property is FALSE (the literal string "0") otherwise.

178 Rationale: This property is provided in lieu of defining generic structure queries, which would suffice for this and for many more powerful queries, but seems inappropriate to standardize at this time.

 I  iscollection-operator   (type: change, status: closed)
julian.reschke@greenbytes.de2001-10-09DAV:iscollection should be an operator rather than a pseudo-property. This both reduces special cases in implementations and avoids confusion with real properties.

del-3. Example of DAV:iscollection

179 This example shows a search criterion that picks out all and only the resources in the scope that are collections.

<D:where>
  <D:eq>
    <D:prop><D:iscollection></D:prop>
    <D:literal>1<D:literal>
  </D:eq>
</D:where>

5.19. Query schema for DAV:basicsearch

180 

 I  bsschema-DTD   (type: change, status: closed)
lisa@xythos.com2001-10-17(1) DTD needs to be cleaned up, (2) there should be a way to advertise propdescs for all properties not mentioned otherwise.
The DAV:basicsearch grammar defines a search criteria that is a Boolean-valued expression, and allows for an arbitrary set of properties to be included in the result record. The result set may be sorted on a set of property values. Accordingly the DTD for schema discovery for this grammar allows the server to express:

  1. the set of properties that may be either searched, returned, or used to sort, and a hint about the data type of such properties
  2. the set of optional operators defined by the resource.

5.19.1. DTD for DAV:basicsearch QSD

<!ELEMENT basicsearchschema  (properties, operators)>
<!ELEMENT properties    (propdesc*)>
<!ELEMENT propdesc    (prop, ANY)>
<!ELEMENT operators    (opdesc*)>
<!ELEMENT opdesc        ANY>
<!ELEMENT operand_property      EMPTY>
<!ELEMENT operand_literal       EMPTY>
<!ELEMENT basicsearchschema  (properties, operators)>

<!ELEMENT any-other-property EMPTY>
<!ELEMENT properties         (propdesc*)>
<!ELEMENT propdesc           (prop|any-other-property), datatype?,
                              searchable?, selectable?, sortable?,
                              casesensitive?)>
<!ELEMENT operators          (opdesc*)>
<!ELEMENT opdesc             ANY>
<!ELEMENT operand-literal    EMPTY>
<!ELEMENT operand-property   EMPTY>

184 

 I  naming-of-elements   (type: change, status: closed)
julian.reschke@greenbytes.de2001-10-17To stay consistent with other WebDav specs, I'd prefer to use "-" instead of "_" as separator.
The DAV:properties element holds a list of descriptions of properties.

185 The DAV:operators element describes the optional operators that may be used in a DAV:where element.

5.19.2. DAV:propdesc Element

186 Each instance of a DAV:propdesc element describes the property or properties in the DAV:prop element it contains. All subsequent elements are descriptions that apply to those properties. All descriptions are optional and may appear in any order. Servers SHOULD support all the descriptions defined here, and MAY define others.

187 DASL defines five descriptions. The first, DAV:datatype, provides a hint about the type of the property value, and may be useful to a user interface prompting for a value. The remaining four (DAV:searchable, DAV:selectable, DAV:sortable, and DAV:casesensitive) identify portions of the query (DAV:where, DAV:select, and DAV:orderby, respectively). If a property has a description for a section, then the server MUST allow the property to be used in that section. These descriptions are optional. If a property does not have such a description, or is not described at all, then the server MAY still allow the property to be used in the corresponding section.

5.19.2.1. DAV:any-other-property

188 This element can be used in place of DAV:prop to describe properties of WebDAV properties not mentioned in any other DAV:prop element. For instance, this can be used to indicate that all other properties are searchable and selectable without giving details about their types (a typical scenario for dead properties).

5.19.3. The DAV:datatype Property Description

189 

 I  datatypes   (type: change, status: closed)
julian.reschke@greenbytes.de2001-10-17Should use standard datatypes from XML Schema Part 2 and also allow for user-defined types.
The DAV:datatype element contains a single XML element that provides a hint about the domain of the property, which may be useful to a user interface prompting for a value to be used in a query. The namespace for expressing a DASL defined data type is "urn:uuid:C2F41010-65B3-11d1-A29F-00AA00C14882/". Datatypes are identified by an element name. Where appropriate, a server SHOULD use the simple datatypes defined in [XS2].

<!ELEMENT datatype ANY >

190 Examples from [XS2], section 3:

Qualified name      Example

xs:boolean          true, false, 1, 0
xs:string           Foobar
xs:dateTime         1994-11-05T08:15:5Z
xs:float            .314159265358979E+1
xs:integer          -259, 23

191 DASL defines the following data type elements:

Name                 Example

boolean              1, 0
string               Foobar
dateTime.iso8601tz   1994-11-05T08:15:5Z
float                .314159265358979E+1
int                  -259, 23

192 If the data type of a property is not given, then the data type defaults to xs:string.

5.19.4. The DAV:searchable Property Description

<!ELEMENT searchable EMPTY>

193 If this element is present, then the server MUST allow this property to appear within a DAV:where element where an operator allows a property. Allowing a search does not mean that the property is guaranteed to be defined on every resource in the scope, it only indicates the server's willingness to check.

5.19.5. The DAV:selectable Property Description

<!ELEMENT selectable EMPTY>

194 This element indicates that the property may appear in the DAV:select element.

5.19.6. The DAV:sortable Property Description

195 This element indicates that the property may appear in the DAV:orderby element.

<!ELEMENT sortable EMPTY>

5.19.7. The DAV:casesensitive Property Description

196 This element only applies to properties whose data type is "xs:string" and derived data types as per the DAV:datatype property description. Its presence indicates that compares performed for searches, and the comparisons for ordering results on the string property will be case sensitive. (The default is case insensitive.)

<!ELEMENT casesensitive EMPTY>

5.19.8. The DAV:operators XML Element

197 The DAV:operators element describes every optional operator supported in a query. (Mandatory operators are not listed since they are mandatory and permit no variation in syntax.). All optional operators that are supported MUST be listed in the DAV:operators element. The listing for an operator consists of the operator (as an empty element), followed by one element for each operand. The operand MUST be either DAV:operand_property or DAV:operand_literal, DAV:operand-property or DAV:operand-literal, which indicate that the operand in the corresponding position is a property or a literal value, respectively. If an operator is polymorphic (allows more than one operand syntax) then each permitted syntax MUST be listed separately.

<D:propdesc>
  <D:like/><D:operand_property/><D:operand_literal/>
</D:propdesc>
<operators xmlns='DAV:'>
  <opdesc>
    <like/><operand-property/><operand-literal/>
  </opdesc>
</operators>

5.19.9. Example of Query Schema for DAV:basicsearch

<D:basicsearchschema xmlns:D="DAV:"
  xmlns:t="urn:uuid:C2F41010-65B3-11d1-A29F-00AA00C14882/"
  xmlns:J="http://jennicam.org">
  <D:properties>
    <D:propdesc>
      <D:prop><D:getcontentlength/></D:prop>
      <D:datatype><t:int/></D:datatype>
      <D:searchable/><D:selectable/><D:sortable/>
    </D:propdesc>
    <D:propdesc>
      <D:prop><D:getcontenttype/><D:displayname/></D:prop>
      <D:searchable/><D:selectable/> <D:sortable/>
    </D:propdesc>
    <D:propdesc>
      <D:prop><J:fstop/></D:prop>
      <D:selectable/>
    </D:propdesc>
  </D:properties>
  <D:operators>
    <D:opdesc>
    <D:isdefined/><D:operand_property/>
  </D:opdesc>
   <D:opdesc>
    <D:like/><D:operand_property/><D:operand_literal/>
  </D:opdesc>
  </D:operators>
</D:basicsearchschema>
<D:basicsearchschema xmlns:D="DAV:"
  xmlns:xs="http://www.w3.org/2001/XMLSchema"">
  <D:properties>
    <D:propdesc>
      <D:prop><D:getcontentlength/></D:prop>
      <D:datatype><xs:nonNegativeInteger/></D:datatype>
      <D:searchable/><D:selectable/><D:sortable/>
    </D:propdesc>
    <D:propdesc>
      <D:prop><D:getcontenttype/><D:displayname/></D:prop>
      <D:searchable/><D:selectable/><D:sortable/>
    </D:propdesc>
    <D:propdesc>
      <D:prop><fstop xmlns="http://jennicam.org"/></D:prop>
      <D:selectable/>
    </D:propdesc>
    <D:propdesc>
      <D:any-other-property/>
      <D:searchable/><D:selectable/>
    </D:propdesc>
  </D:properties>
  <D:operators>
    <D:opdesc>
      <D:isdefined/><D:operand-property/>
    </D:opdesc>
    <D:opdesc>
      <D:like/><D:operand-property/><D:operand-literal/>
    </D:opdesc>
  </D:operators>
</D:basicsearchschema>

198 This response lists four properties. The datatype of the last three properties is not given, so it defaults to xs:string. All are selectable, and the first three may be searched. All but the last may be used in a sort. Of the optional DAV operators, DAV:isdefined and DAV:like are supported.

199 Note: The schema discovery defined here does not provide for discovery of supported values of the DAV:casesensitive attribute. This may require that the reply also list the mandatory operators.


6. Internationalization Considerations

200 Clients have the opportunity to tag properties when they are stored in a language. The server SHOULD read this language-tagging by examining the xml:lang attribute on any properties stored on a resource.

201 The xml:lang attribute specifies a nationalized collation sequence when properties are compared.

202 Comparisons when this attribute differs have undefined order.


7. Security Considerations

 I  JW25/JW26   (type: , status: open)
ejw@ics.uci.edu2000-04-20In Security Considerations, copy XML considerations from webDAV spec.
ejw@ics.uci.edu2000-04-20Wouldn't it be better to just cite the XML document, so that if that document is updated, we won't have stale information?
ejw@ics.uci.edu2000-04-20In Security Considerations, mention privacy risks of queries.
julian.reschke@greenbytes.de2002-01-28Is this resolved?

203 This section is provided to detail issues concerning security implications of which DASL applications need to be aware. All of the security considerations of HTTP/1.1 also apply to DASL. In addition, this section will include security risks inherent in searching and retrieval of resource properties and content.

204 A query must not allow one to retrieve information about values or existence of properties that one could not obtain via PROPFIND. (e.g. by use in DAV:orderby, or in expressions on properties.)

205 A server should prepare for denial of service attacks. For example a client may issue a query for which the result set is expensive to calculate or transmit because many resources match or must be evaluated. 7.1 Implications of XML External Entities

206 XML supports a facility known as "external entities", defined in section 4.2.2 of [XML], which instruct an XML processor to retrieve and perform an inline include of XML located at a particular URI. An external XML entity can be used to append or modify the document type declaration (DTD) associated with an XML document. An external XML entity can also be used to include XML within the content of an XML document. For non-validating XML, such as the XML used in this specification, including an external XML entity is not required by [XML]. However, [XML] does state that an XML processor may, at its discretion, include the external XML entity.

207 External XML entities have no inherent trustworthiness and are subject to all the attacks that are endemic to any HTTP GET request. Furthermore, it is possible for an external XML entity to modify the DTD, and hence affect the final form of an XML document, in the worst case significantly modifying its semantics, or exposing the XML processor to the security risks discussed in [RFC3023]. Therefore, implementers must be aware that external XML entities should be treated as untrustworthy.

208 There is also the scalability risk that would accompany a widely deployed application which made use of external XML entities. In this situation, it is possible that there would be significant numbers of requests for one external XML entity, potentially overloading any server which fields requests for the resource containing the external XML entity.


8. Scalability

209 Query grammars are identified by URIs. Applications SHOULD not attempt to retrieve these URIs even if they appear to be retrievable (for example, those that begin with "http://")


9. Authentication

210 Authentication mechanisms defined in WebDAV will also apply to DASL.


10. IANA Considerations

211 This document uses the namespace defined by [RFC2518] for XML elements. All other IANA considerations mentioned in [RFC2518] also applicable to DASL.



12. Intellectual Property

213 To be supplied.


13. References

13.2. Informative References

[CaseMap]
Davis, M., “Case Mappings”, Unicode Techical Reports 21, February 2001, <http://www.unicode.org/unicode/reports/tr21>.
[DASL]
Reddy, S., Lowry, D., Reddy, S., Henderson, R., Davis, J., and A. Babich, “DAV Searching & Locating”, ID draft-dasl-protocol-00, July 1999, <http://www.webdav.org/dasl/protocol/draft-dasl-protocol-00.html>.
[DASLREQ]
Davis, J., Reddy, S., and J. Slein, “Requirements for DAV Searching and Locating”, ID draft-dasl-requirements-01, February 1999, <http://www.webdav.org/dasl/requirements/draft-dasl-requirements-01.html>.
[SQL99]
Milton, J., “Database Language SQL Part 2: Foundation (SQL/Foundation)”, ISO ISO/IEC 9075-2:1999 (E), July 1999.

Appendix A. Three-Valued Logic in DAV:basicsearch

219 ANSI standard three valued logic is used when evaluating the search condition (as defined in the ANSI standard SQL specifications, for example in ANSI X3.135-1992, section 8.12, pp. 188-189, section 8.2, p. 169, General Rule 1)a), etc.).

220 ANSI standard three valued logic is undoubtedly the most widely practiced method of dealing with the issues of properties in the search condition not having a value (e.g., being null or not defined) for the resource under scan, and with undefined expressions in the search condition (e.g., division by zero, etc.). Three valued logic works as follows.

221 Undefined expressions are expressions for which the value of the expression is not defined. Undefined expressions are a completely separate concept >from the truth value UNKNOWN, which is, in fact, well defined. Property names and literal constants are considered expressions for purposes of this section. If a property in the current resource under scan has not been set to a value (either because the property is not defined for the current resource, or because it is null for the current resource), then the value of that property is undefined for the resource under scan. DASL 1.0 has no arithmetic division operator, but if it did, division by zero would be an undefined arithmetic expression.

222 If any subpart of an arithmetic, string, or datetime subexpression is undefined, the whole arithmetic, string, or datetime subexpression is undefined.

223 There are no manifest constants to explicitly represent undefined number, string, or datetime values.

224 Since a Boolean value is ultimately returned by the search condition, arithmetic, string, and datetime expressions are always arguments to other operators. Examples of operators that convert arithmetic, string, and datetime expressions to Boolean values are the six relational operators ("greater than", "less than", "equals", etc.). If either or both operands of a relational operator have undefined values, then the relational operator evaluates to UNKNOWN. Otherwise, the relational operator evaluates to TRUE or FALSE, depending upon the outcome of the comparison.

225 The Boolean operators DAV:and, DAV:or and DAV:not are evaluated according to the following rules:

226 UNKNOWN and UNKNOWN = UNKNOWN

227 UNKNOWN or UNKKNOWN = UNKNOWN

228 not UNKNOWN = UNKNOWN

229 UNKNOWN and TRUE = UNKNOWN

230 UNKNOWN and FALSE = FALSE

231 UNKNOWN and UNKNOWN = UNKNOWN

232 UNKNOWN or TRUE = TRUE

233 UNKNOWN or FALSE = UNKNOWN

234 UNKNOWN or UNKNOWN = UNKNOWN


Appendix B. Change Log

B.1. From draft-davis-dasl-protocol-xxx

Feb 14, 1998
Initial Draft
Feb 28, 1998
Referring to DASL as an extension to HTTP/1.1 rather than DAV.
Added new sections "Notational Conventions", "Protocol Model", "Security Considerations".
Changed section 3 to "Elements of Protocol".
Added some stuff to introduction.
Added "result set" terminology.
Added "IANA Considerations".
Mar 9, 1998
Moved sub-headings of "Elements of Protocol" to first level and removed "Elements of Protocol" Heading.
Added an sentence in introduction explaining that this is a "sketch" of a protocol.
Mar 11, 1998
Added orderby, data typing, three valued logic, query schema property, and element definitions for schema for basicsearch.
April 8, 1998
- made changes based on last week's DASL BOF.
May 8, 1998
Removed most of DAV:searcherror; converted to DAV:searchredirect
Altered DAV:basicsearch grammar to use avoid use of ANY in DTD
June 17, 1998
-Added details on Query Schema Discovery
-Shortened list of data types
June 23, 1998
moved data types before change history
rewrote the data types section
removed the casesensitive element and replace with the casesensitive attribute
added the casesensitive attribute to the DTD for all operations that might work on a string
Jul 20, 1998
A series of changes. See Author's meeting minutes for details.
July 28, 1998
Changes as per author's meeting. QSD uses SEARCH, not PROPFIND.
Moved text around to keep concepts nearby.
Boolean literals are 1 and 0, not T and F.
contains changed to contentspassthrough.
Renamed rank to score.
July 28, 1998
Added Dale Lowry as Author
September 4, 1998
Added 422 as response when query lists unimplemented operators.
DAV:literal declares a default value for xml:space, 'preserve' (see XML spec, section 2.10)
moved to new XML namespace syntax
September 22, 1998
Changed "simplesearch" to "basicsearch"
Changed isnull to isdefined
Defined NULLness as having a 404 or 403 response
used ENTITY syntax in DTD
Added redirect
October 9, 1998
Fixed a series of typographical and formatting errors.
Modified the section of three-valued logic to use a table rather than a text description of the role of UNKNOWN in expressions.
November 2, 1998
Added the DAV:contains operator.
Removed the DAV:contentpassthrough operator.
November 18, 1998
Various author comments for submission
June 3, 1999
Cosmetic and minor editorial changes only. Fix nits reported by Jim Whitehead in email of April 26, 1999. Converted to HTML from Word 97, manually.
April 20, 2000
Removed redirection feature, since 301/302 suffices. Removed Query Schema Discovery (former chapter 4). Everyone agrees this is a useful feature, but it is apparently too difficult to define at this time, and it is not essential for DASL.

Index

D O Q R S


Authors' Addresses

Julian F. Reschke
greenbytes GmbH
Salzmannstrasse 152
Muenster, NW 48159
Germany
Phone: +49 251 2807760
Fax: +49 251 2807761
EMail: julian.reschke@greenbytes.de
URI: http://www.greenbytes.de/tech/webdav/
Surendra Reddy
Oracle Corporation
600 Oracle Parkway, M/S 6op3
Redwoodshores, CA 94065
Phone: +1 650 506 5441
EMail: Surendra.Reddy@oracle.com
Jim Davis
Intelligent Markets
410 Jessie Street 6th floor
San Francisco, CA 94103
EMail: jrd3@alum.mit.edu
Alan Babich
FileNET Corp.
3565 Harbor Blvd.
Costa Mesa, CA 92626
Phone: +1 714 327 3403
EMail: ababich@filenet.com

Full Copyright Statement

Copyright © The Internet Society (2002). All Rights Reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns.

This document and the information contained herein is provided on an “AS IS” basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Intellectual Property

The IETF takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on the IETF's procedures with respect to rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementors or users of this specification can be obtained from the IETF Secretariat.

The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to practice this standard. Please address the information to the IETF Executive Director.