webdavPut

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

Module

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

Syntax

URI

active:webdavPut

Argument	Rules	Description
path	Mandatory	the uri of the resource to update.
data	Mandatory	the uri of the source of the data to update the resource with or a literal document.

Example Usage

DPML

<instr>
  <type>webdavPut</type>
  <path>http://webdav.example.com/aCollection/resource2.update</path>
  <data>
    <info>
      <level1>This is some new content for the resource</level1>
    </info>
  </data>
  <target>var:putResponse</target>
</instr>

NetKernel Foundation API

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

Purpose

webdavPut stores the supplied data at the location specified by the path. An existing resource will have its representation replaced by the contents of the data and a new resource will be created at the location if one did not exist prior to this command being executed and the location has an existing parent collection. If the parent collection does not exist the command will fail with a 409 (Conflict) status code.

The specified data can be an uri as well as a literal document, e.g. <data>file:/resource/2update.from</data>. In this case the updated resource will be a copy of the contents of this source uri.

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

References

Apache Jakarta Slide Homepage

Result document

Example result document:

<result>
  <method>putMethod</method>
  <path>http://webdav.example.com/aCollection/resource2.update</path>
  <success>true</success>
  <statusCode>204</statusCode>
  <statusText>No content (204)</statusText>
  <displayName>resource2.update</displayName>
  <contentLength>3762</contentLength>
  <contentType>text/plain</contentType>
  <lastModified>6/02/2004 10: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 updated resource.
<contentLength> will always be 0 when creating a collection.
<contentType> the HTTP Content-Type (MIME type) of the updated resource as reported by WebDav.
<lastModified> contains the date that the resource was last modified in the default date/time format for your timezone.