BatchSFTP OTD

The Batch Secure SFTP OTD (BatchSFTP) provides secure data transfer using SSH File Transfer Protocol or SFTP. SFTP provides a range of operations on remote files, such as resuming interrupted transfers, directory listings, and remote file removal.

SFTP is one means of securely transferring computer files between a local and a remote host or between two remote hosts, using the Secure Shell (SSH) protocol. The BatchSFTP OTD uses SFTP to copy a file to or from a remote host.

BatchSFTP OTD Structure

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

Figure 1–8 BatchSFTP OTD Structure

BatchSFTP OTD Node Functions

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

BatchSFTP: Represents the OTD’s root node.

Configuration Node

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

BatchSFTP Client Node

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

• cd(String dir): Changes the remote current directory to the specified path.

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

• delete(): Deletes remote files specified by configuration parameters RemoteDirectory and RemoteFile.

• delete(String file): Deletes remote files specified by file.

• disconnect(): Disconnects the client from the remote SSH server.

• get(): Copies data from a remote SSH server (specified by configuration parameters RemoteDirectory and RemoteFile) to the local machine. Depending on the current status of the configuration, the remote data can be stored into the payload (in memory buffer) or a local file specified by configuration parameters LocalDirectory and LocalFile.

  ---

  Note –

  The remote could be a folder. In this case, if the configuration parameter Recursive is "Yes", the folder hierarchy is copied to the local destination.

  ---

• getEntry(int index): Gets the index entry in the current entry list.

• getEntryCount(): Returns the number of entries in the current entry list.

• getPayload(): Returns the payload.

  ---

  Note –

  If you call getPayload() when using the BatchSFTP OTD, and the Local Directory and Local Filename are set, getPayload()returns null, even if a file has been retrieved.

  ---

• getResolvedLocalDirectory(): Returns the resolved local directory name.

• getResolvedLocalFile(): Returns the resolved local file name.

• getResolvedRemoteDirectory(): Returns the resolved remote directory name.

• getResolvedRemoteFile(): Returns the resolved remote file name.

• hasEntry(): Returns whether the current entry list has entries.

• isConnected(): Determines if the Java Integration Suite is connected to the SSH server.

• lcd(String dir): Changes the local current directory.

• listDir(): Lists all the entries under remote current directory.

• lpwd(): Returns the local current path.

• mkdir(): Creates a directory on the remote. The name of the directory is specified in the properties.

• mkdir(String dir): Creates a directory on the remote using the name specified in the configuration parameters, Remote Directory and Remote File.

• nextEntry(): Returns the next entry in the current entry list.

• put(): Copies local data (specified by configuration parameters LocalDirectory and LocalFile) to the remote SSH server (specified by configuration parameters RemoteDirectory and RemoteFile). Depending on the current status of the configuration, the local data can be from either a payload or local file.

  ---

  Note –

  The local could be a folder. In this case, if the configuration parameter Recursive is "Yes", the folder hierarchy is copied to the remote destination.

  ---

• pwd(): Returns the remote current path.

• rename(String newPath): Renames the file or directory specified by the old name (first argument), to new name (second argument).

• rename(String oldPath, String newPath): Renames the file or directory specified by configuration parameters, Remote Directory and Remote File, to new name (argument).

• reset(): Resets the internal life cycle methods, such as discard payload buffer.

• resetEntries(): Resets the current entry list so that next call to nextEntry() will return the first entry in the list.

• resolveLocalAsDestination(): Resolves the local directory name and local file name if they are patterns (used to generate real directory and file name for data transfer destination), upon the success of the resolution.

• resolveLocalAsSource(): Resolves the local directory and file if they are regular expressions (filters for data transfer source); upon the success of the resolution.

• resolveRemoteAsDestination(): Resolves the remote directory name and remote file name if they are patterns (used to generate real directory and file name for data transfer destination), upon the success of the resolution.

• resolveRemoteAsSource(): Resolves the remote directory and file if they are regular expressions (filters for data transfer source); upon the success of the resolution.

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

• setResolvedLocalDirectory(String s): Sets the current resolved local directory name.

• setResolvedLocalFile(String s): Sets the current local file name to s, should not be invoked directly from user Collaboration.

• setResolvedRemoteDirectory(String s): Sets the current resolved remote directory name.

• setResolvedRemoteFile(String s): Sets the current resolved remote file name.

  ---

  Note –

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

  ---