WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:File List
Description:Accessor to provide a directory listing of the filesystem
Id:layer1.FLS
Category:accessor
Identifier Syntax

File List is an accessor using Active URI syntax with the following base identifiers:

Base
active:fls

and the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
operator
Mandatory
Representation (java.lang.Object)Configuration document
Request Verbs

The following verb is supported:

Verb
SOURCE
Response

The response representation of this accessor for SOURCE requests is unknown.

This accessor throws no documented exceptions.

Import Requirements

To use File List accessor you must import the module urn:com:1060research:www3:

<import>
  <uri>urn:com:1060research:www3</uri>
</import>

The File List (FLS) accessor generates a directory listing of the filesystem It generates an XML fragment containing a directory listing of the host operating system's filesystem. The listing is generated as the accessor walks the filesystem starting at a specified root location. While processing the request, resources whose complete path match a regular expression filter are added to the listing.

The resulting document is hierarchical tree representation of the real filesystem tree. The structure of the returned document is as follows

<fls> ...
  <dir>home
    <res>mydoc.doc
      <uri>file:///home/mydoc.doc</uri>
    </res>
  </dir> ...
</fls>

operator

Parameters that guide fls are passed in an XML document identified as the operator argument.

The operator document fragment has the following form and elements:

  • root - The base directory URI. eg file:///C:/some/path/
  • filter - Filter. Regular Expression on complete file path
  • recursive -Recurse the tree
  • uri -Include the full URI of the resource
  • age -Include age in ms
  • length -Include length of file in bytes
  • lastmodified -Include last modified in ms
  • keepEmptyDir - don't trim empty directories

<fls>
  <root>file:///home/foo/bar/</root>
  <filter>.*xml</filter>
  <recursive />
  <uri />
  <keepEmptyDir />
</fls>