File Directory Contents Service (com.ibi.agents.XDFileDirListAgent)

Syntax:

com.ibi.agents.XDFileDirListAgent

iIT Service Object:

file: File Directory Contents

Description:

This service lists the contents of a file directory that is accessible through the file system. You may select to view files, subdirectories, or both.

Parameters:

Parameter	Description
Directory	The directory to be listed. This service does not descend directories.
Include	Determines what items should be included in the listing. Select one of the following options from the drop-down list: Files (default) Subdirectories All
Selection Expression	If present, this is a Java regular expression used for selection of the file or subdirectory. For example, to select only .xml files, you might use ".\.xml" as the pattern (the quotes are not included in the pattern). Note: The expression, .\.xml is deconstructed as follows. The leading dot means any character, and the asterisk means any number of them, until a suffix of .xml is reached. The problem with the .xml is that the dot would mean any character, so it is escaped. Because this is not iFL syntax, the backslash does not need to be escaped.
Pattern Type	If the Selection Expression is supplied, indicate whether it should be interpreted as a regular expression (regex) or a DOS style wildcard (wildcard).
Call at EOS?	In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. The default value is false.

The resulting document contains information on each entry in the directory.

Entry	Description
type	Identifies whether this is a file or a directory entry.
lastmod	An integer value of the time the file was last modified. This is the last-modified time, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).
lastmodstr	The last modified time as a string.

The following is an example of a generated document:

<dir base="c:\iway70" count="9">
   <item type="directory" lastmod="1254257984133" lastmodstr="29 Sep 2009 20:59:44 GMT">bin</item>
   <item type="directory" lastmod="1256932227299" lastmodstr="30 Oct 2009 19:50:27 GMT">config</item>
   <item type="directory" lastmod="1254257982321" lastmodstr="29 Sep 2009 20:59:42 GMT">etc</item>
   <item type="file" lastmod="1256738729576" lastmodstr="28 Oct 2009 14:05:29 GMT">failagent_repro.zip</item>
   <item type="file" lastmod="1254256456000" lastmodstr="29 Sep 2009 20:34:16 GMT">iway70.cmd</item>
   <item type="directory" lastmod="1254846509643" lastmodstr="6 Oct 2009 16:28:29 GMT">lib</item>
   <item type="file" lastmod="1254258028321" lastmodstr="29 Sep 2009 21:00:28 GMT">license.xml</item>
   <item type="directory" lastmod="1254257973414" lastmodstr="29 Sep 2009 20:59:33 GMT">tools</item>
   <item type="file" lastmod="1254257983852" lastmodstr="29 Sep 2009 20:59:43 GMT">uninstall.exe</item>
</dir>

Edges:

The following table lists the available line edges for the File Directory Contents Service (com.ibi.agents.XDFileDirListAgent).

Line Edge	Description
OnError	Error
OnSuccess	Success: the directory document was produced.
OnFailure	Failure
OnCustom	OnError OnSuccess OnFailure fail_notfound: The directory to be listed was not found. fail_operation: The directory to be listed was not reachable. This can come about if a relative directory cannot be resolved or the directory was not specified. Access permissions will also produce this edge.