BatchSCP OTD

The Batch Secure SCP OTD (BatchSCP) provides secure data transfer using Secure Copy Protocol with Secure Shell (SSH) as an underlying protocol. SCP is similar to RCP (remote copy), but the file is copied over secure shell (SSH) rather than RSH (remote shell). When files are copied using SCP the data is encrypted during transfer.

For information about configuring external FTP servers, SSH servers, and so forth, refer to the application’s documentation.

BatchSCP OTD Structure

The BatchSCP OTD contains two top-level nodes, Client and Configuration (see the following figure). Expand these nodes to reveal additional sub-nodes.

Figure 1–9 BatchSCP OTD Structure

BatchSCP OTD Node Functions

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

BatchSCP: Represents the OTD’s root node.

Configuration Node

The BatchSCP sub-nodes under the Configuration node correspond to BatchSCP adapter’s Connectivity Map and Environment configuration parameters.

BatchSCP Client Node

The BatchSCP OTD’s Client node includes the following methods:

• connect(): Connects to the SSH server and does authentication as configured.

• disconnect(): Disconnects from the SSH server.

• get(): Copies the file or directory specified by the configuration parameters, Remote Directory and Remote File, to the local, as specified by configuration parameters Local Directory and Local File. If the configuration parameter, Is Copy Recursive, is set to Yes, the copy will be recursive.

• getPayload(): Returns the payload buffer as a byte array.

• getRecursive(): Copies data from remote to local with configuration parameter Recursive set to "Yes".

• isConnected(): Checks whether the client is connected to the SSH server.

• put(): Copies local data (specified by configuration parameters LocalDirectory and LocalFile) to the remote SSH server (specified by configuration parameters RemoteDirectory and RemoteFile).

• putRecursive(): Copies data from local to remote with the configuration parameter Recursive set to "Yes".

• setpayload(byte[] newPayload): Sets the payload.

  ---

  Note –

  See the Batch adapter Javadoc for a list of all exposed SCPClient methods.

  ---