webdavMkCol

Home > Books > NetKernel API and Services Reference > Accessor Listing > WebDav Client > webdavMkCol

Module

The webdavMkCol accessor is exported by the urn:org:ten60:netkernel:mod:webdav module. Import this module to gain access to the accessor.

Syntax

URI

active:webdavMkCol

Argument	Rules	Description
path	Mandatory	the uri of the collection to create. (Note - the uri must end in a trailing slash to be considered a valid collection uri by WebDav).

Example Usage

DPML

<instr>
  <type>webdavMkCol</type>
  <path>http://webdav.example.com/newCollection/</path>
  <target>var:mkColResponse</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:webdavMkCol");
req.addArgument("path", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

webdavMkCol creates a new collection resource at the location specified by the path. If the resource identified by the path already exists then the request will fail. When the operation attempts to create a new collection resource, all ancestors must already exist, or the method will fail with a 409 (Conflict) status code. For example, if a request to create collection /a/b/c/d/ is made, and neither /a/b/ nor /a/b/c/ exists, the request must fail.

Note that the ability to specify a message body which contains details of members, bodies of members, sub-collections, etc is not yet supported by this URA.

The webdavMkCol URA uses the WebDav client library from the Jakarta Slide project.

References

Apache Jakarta Slide Homepage

Result document

Example result document:

<result>
  <method>mkcolMethod</method>
  <path>http://webdav.example.com/newCollection/</path>
  <success>true</success>
  <statusCode>201</statusCode>
  <statusText>Created (201)</statusText>
  <displayName>newCollection</displayName>
  <contentLength>0</contentLength>
  <contentType>httpd/unix-directory</contentType>
  <lastModified>6/02/2004 09:51:18</lastModified>
</result>

<method> contains the name of the underlying WebDav client method that was called.
<path> contains the full uri of the target of the requested operation.
<success> contains a boolean indicator of the success of the request.
<statusCode> contains the HTTP status code returned by the server.
<statusText> contains the HTTP status message returned by the server.
<displayName> contains the name to use when displaying a reference to the created collection.
<contentLength> will always be 0 when creating a collection.
<contentType> the HTTP Content-Type (MIME type) of the new collection. Apache WebDav always returns httpd/unix-directory.
<lastModified> contains the date that the collection was last modified, i.e. was created in the default date/time format for your timezone.