mls

Home > Books > NetKernel API and Services Reference > Accessor Listing > Kernel Management and Development APIs > mls

Module

The mls accessor is exported by the urn:org:ten60:netkernel:ext:kernel module. Import this module to gain access to the accessor.

Syntax

URI

active:mls

Argument	Rules	Description
operator	Mandatory	required a document specifying properties for the directory listing

Example Usage

DPML

<instr>
  <type>mls</type>
  <operator>
    <mls>
      <module-uri>module urn</module-uri>
      <filter>.*xml</filter>
      <uri />
    </mls>
  </operator>
  <target>this:response</target>
</instr>

NetKernel Foundation API

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

Purpose

The mls accessor lists resources within a NetKernel module to generate an xml document representing the tree structure. Each sub-directory is an element with resources listed within.

The resources that are matched are selected based upon a set a regular expression filter applied to the resource URI. The resource filter is provided as the operator.

The structure of the returned document is as follows:

<mls>
...

  <dir>accessor
        
    <res>schematronAccessor.idoc
            
      <uri>ffcpl:/org/ten60/netkernel/xml/accessor/schematronAccessor.idoc</uri>
      <module>urn:org:ten60:netkernel:ext:xml</module>
    </res>
  </dir>
...

</mls>

Operator Syntax

The mls accessor requires some properties to specify what to include in the listing. These are passed in by the operator in a <mls> property document.

<mls>
  <filter>.*\.xml</filter>
  <uri />
  <age />
  <lastmodified />
  <length />
</mls>

<module-uri> If specified, this is the modules that will be the subject of the listing. Otherwise the module requesting use of the accessor will be the subject.
<filter> Filter. Regular Expression on the absolute URI of the resource (starting ffcpl:/)
<uri> Include the full ffcpl: URI of the resource
<age> Include the number of milliseconds since the resource was last modified
<lastmodified> Include the timestamp when the resource was last modified
<length> Include the length in bytes of the resource