webdavListChildren

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

Module

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

Syntax

URI

active:webdavListChildren

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

Example Usage

DPML

<instr>
  <type>webdavListChildren</type>
  <path>http://webdav.example.com/interestingCollection/</path>
  <target>var:listChildrenResponse</target>
</instr>

NetKernel Foundation API

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

Purpose

webdavListChildren returns the names of all resources contained in the collection at the location specified by the path.

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

References

Apache Jakarta Slide Homepage

Result document

Example result document:

<result>
  <method>listMethod</method>
  <path>http://webdav.example.com/anInterestingCollection/</path>
  <success>true</success>
  <statusCode>200</statusCode>
  <statusText>OK (200)</statusText>
  <displayName>anInterestingCollection</displayName>
  <contentLength>0</contentLength>
  <contentType>httpd/unix-directory</contentType>
  <lastModified>6/02/2004 09:51:18</lastModified>
  <data>
    <resource>First child resource name</resource>
    <resource>Second child resource name</resource>
    <resource>Third child resource name</resource>
  </data>
</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 collection.
<contentLength> will always be 0 when listing a collection.
<contentType> the HTTP Content-Type (MIME type) of the collection. Apache WebDav always returns httpd/unix-directory.
<lastModified> contains the date that the collection was last modified in the default date/time format for your timezone.
<data> contains the list of resources contained in the collection, the name of each resource is contained in a <resource> element.