BatchFTP OTD Node Functions

The following list provides an explanation of various nodes in the BatchFTP OTD, including primary functions:

• BatchFTP: Represents the OTD’s root node.

• Configuration: Each field sub-node within this node corresponds to an adapter configuration parameter and contains settings information.

  • InputStreamAdapter and OutputStreamAdapter: Allow you to use and control the OTD’s data-streaming features.

    ---

    Note –

    This OTD has configuration parameters that can be regular expressions. See Using Regular Expressions With the Batch Adapter for details.

    ---

• Client: This node contains the following sub-nodes, which implement the adapter’s client interface in the OTD (FtpFileClient):

  • Payload: An in-memory buffer that contains the payload or message data you want to transfer by FTP, in the form of a byte array.

  • UserProperties: Only used if you have provided a user-defined implementation of the FtpFileClient interface; in such cases, the node represents the properties specified in the configuration.

    ---

    Note –

    You can transfer data using the Payload node or by using data streaming (InputStreamAdapter and OutputStreamAdapter nodes), but you cannot use both methods in the same OTD.

    ---

  • ResolvedNamesForGet and ResolvedNamesForPut: Allow you to get the real file or directory name used during a transfer and perform an operation with it. For example, you could do a file transfer, with get() or put(), using the real name. You are able to retrieve the real file or directory name, even if these names have been expressed using regular expressions or special characters.

    These nodes contain sub-nodes that allow you to resolve file and directory names for target destinations, as well as names for pre- and post-transfer commands. See the Pre/Post File Transfer Commands, Resolving Names for more information on these nodes. Also see Using Regular Expressions With the Batch Adapter for more information on regular expressions.

  • get(), put(), reset(), connect(), disconnect(), and isConnected(): See Essential BatchFTP OTD Methods.

• Provider: The sub-nodes contained in this node are methods that implement the adapter’s provider interface in this OTD (FtpFileProvider). These methods allow you to do the general FTP operations that can be performed using the OTD.