Module Webdav_client_methods

module Webdav_client_methods: sig .. end

Extension of the Http_client module for submitting WebDAV requests. See RFC 4918 (http://www.ietf.org/rfc/rfc4918.txt)

This definition is incomplete.

Strings are encoded in UTF-8, except where something else is specified. URLs are ASCII.

This module allows it to create method objects that can be passed to HTTP pipelines, e.g.

     let http = new Http_client.pipeline
     
     let propfind_cl = new propfind "http://server/"

     http # add (propfind_cl :> Http_client.http_call);
     http # run();

     (* now look at propfind_cl for response *)
   

Note that the method objects need to be coerced to http_call before being passed to the pipeline. There is no way of coercing them back, so users should keep the object propfind with the original type.

---

Success codes

WebDAV error reporting is complicated: File system conditions are mapped to the HTTP response status codes, which is looks rather weird. Also, many operations can return multistatus responses, with detailed status codes for each affected URL or even each property.

type call_status = [ `Client_error
       | `Http_protocol_error of exn
       | `Multi_status
       | `Redirection
       | `Server_error
       | `Successful
       | `Unserved ] 

val string_of_call_status : call_status -> string

General types and values

type property = Webdav_xml.property 

type prepost_code = Webdav_xml.prepost_code 

class type propstat_t = object .. end

class type response_t = object .. end

class type webdav_call_t = object .. end

URL construction

val url_append : string -> string -> string

PROPFIND

type propfind_request = [ `Allprop of property list
       | `Prop of property list
       | `Propname ] 

val propname_creationdate : property

val propname_displayname : property

val propname_getcontentlanguage : property

val propname_getcontentlength : property

val propname_getcontenttype : property

val propname_getetag : property

val propname_getlastmodified : property

val propname_resourcetype : property

class type propfind_call_t = webdav_call_t

class propfind_call : propfind_call_t

class propfind : ?depth:Webdav_http.depth -> ?propfind_request:propfind_request -> ?strip_prefix:string -> string -> propfind_call_t

Simplified interface for getting file listings

type list_request = [ `Existence | `Standard ] 

class type filelist_t = propfind_call_t

class filelist : ?depth:Webdav_http.depth -> ?strip_prefix:string -> list_request -> string -> filelist_t

PROPPATCH

type proppatch_instruction = [ `Remove of property list
       | `Set of property list ] 

type proppatch_request = proppatch_instruction list 

class type proppatch_call_t = webdav_call_t

class proppatch_call : propfind_call_t

class proppatch : ?strip_prefix:string -> proppatch_request:proppatch_request -> string -> propfind_call_t

MKCOL

MKCOL creates collections (directories)

class type mkcol_call_t = webdav_call_t

class mkcol_call : mkcol_call_t

class mkcol : ?strip_prefix:string -> string -> mkcol_call_t

GET

GET requests a document

class type get_call_t = webdav_call_t

class get_call : get_call_t

class get : ?strip_prefix:string -> string -> get_call_t

DELETE

DELETE collections and documents

class type delete_call_t = webdav_call_t

class delete_call : delete_call_t

class delete : ?strip_prefix:string -> string -> delete_call_t

PUT

Add/replace documents

class type put_call_t = webdav_call_t

class put_call : put_call_t

class put : ?content_type:string -> ?content_length:int64 -> ?expect_handshake:bool -> ?strip_prefix:string -> string -> Netmime.mime_body -> put_call_t

COPY

Copy documents, collections, or subtrees

class type copy_call_t = webdav_call_t

class copy_call : copy_call_t

class copy : ?depth:Webdav_http.depth -> ?overwrite:bool -> ?strip_prefix:string -> string -> string -> copy_call_t

MOVE

Move documents, collections, or subtrees

class type move_call_t = webdav_call_t

class move_call : copy_call_t

class move : ?overwrite:bool -> ?strip_prefix:string -> string -> string -> move_call_t

This web site is published by Informatikbüro Gerd Stolpmann