webdavCopy

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

Module

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

Syntax

URI

active:webdavCopy

Argument	Rules	Description
path	Mandatory	the uri of the source of the copy.
destination	Mandatory	the uri of the destination of the copy.

Example Usage

DPML

<instr>
  <type>webdavCopy</type>
  <path>http://webdav.example.com/aCollection/resource.2copy</path>
  <destination>http://webdav.example.com/anotherCollection/copy.of.resource</destination>
  <target>var:copyResponse</target>
</instr>

NetKernel Foundation API

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

Purpose

webdavCopy creates a duplicate of a source resource, identified by the path, at the location identitified in the destination. If the resource identified by the destination already exists then the request will fail (note this behaviour can be overriden but is not yet supported). webdavCopy will also copy a collection and in doing so will copy all sub-collections and resources that exist in the source.

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

References

Apache Jakarta Slide Homepage

Result document

Example result document:

<result>
  <method>copyMethod</method>
  <path>http://webdav.example.com/aCollection/resource.2copy</path>
  <success>true</success>
  <statusCode>201</statusCode>
  <statusText>Created (201)</statusText>
  <displayName>resource.2copy</displayName>
  <contentLength>389</contentLength>
  <contentType>text/html</contentType>
  <lastModified>6/02/2004 19: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 source.
<contentLength> will always be 0 when copying a collection, otherwise it will be the length of the copied contents.
<contentType> the HTTP Content-Type (MIME type) of the resource. For a copied collection Apache WebDav always returns httpd/unix-directory.
<lastModified> contains the date that the source was last modified in the default date/time format for your timezone.