Skip Navigation Links | |
Exit Print View | |
Oracle Java CAPS Adapter for Batch User's Guide Java CAPS Documentation |
Oracle Java CAPS Adapter for Batch User's Guide
Additional Licensing Considerations
Batch Adapter System Requirements
Installing Adapter Enterprise Manager plug-ins
Creating and Configuring Batch Adapters
Selecting a Batch External Application
Modifying the Adapter Properties
BatchFTP Adapter Connectivity Map Properties
Pre Transfer (BatchFTP Connectivity Map)
SOCKS (BatchFTP Connectivity Map)
FTP (BatchFTP Connectivity Map)
FTP Raw Commands (BatchFTP Connectivity Map)
Sequence Numbering (BatchFTP Connectivity Map)
Post Transfer (BatchFTP Connectivity Map)
Target Location (BatchFTP Connectivity Map)
SSH Tunneling (BatchFTP Connectivity Map)
Additional SSH-supporting Software
General Settings (BatchFTP Connectivity Map)
BatchFTP Adapter Environment Properties
General Settings (BatchFTP Environment)
SSH Tunneling (BatchFTP Environment)
Connection Pool Settings (BatchFTP Environment)
Connection Retry Settings (BatchFTP Environment)
BatchFTPOverSSL Adapter Connectivity Map Properties
Pre Transfer (BatchFTPOverSSL Connectivity Map)
FTP and SSL Settings (BatchFTPOverSSL Connectivity Map)
Post Transfer (BatchFTPOverSSL Connectivity Map)
Firewall Settings (BatchFTPOverSSL Connectivity Map)
Synchronization (BatchFTPOverSSL Connectivity Map)
BatchFTPOverSSL Adapter Environment Properties
FTP and SSL Settings (BatchFTPOverSSL Environment)
Firewall Settings (BatchFTPOverSSL Environment)
General Settings (BatchFTPOverSSL Environment)
Connection Pool Settings (BatchFTPOverSSL Environment)
Connection Retry Settings (BatchFTPOverSSL Environment)
BatchSCP Adapter Connectivity Map Properties
SCP Settings (BatchSCP Connectivity Map)
Firewall Settings (BatchSCP Connectivity Map)
Synchronization (BatchSCP Connectivity Map)
BatchSCP Adapter Environment Properties
SSH Settings (BatchSCP Environment)
Firewall Settings (BatchSCP Environment)
General Settings (BatchSCP Environment)
Connection Pool Settings (BatchSCP Environment)
Connection Retry Settings (BatchSCP Environment)
BatchSFTP Adapter Connectivity Map Properties
Pre Transfer (BatchSFTP Connectivity Map)
SFTP Settings (BatchSFTP Connectivity Map)
Post Transfer (BatchSFTP Connectivity Map)
Firewall Settings (BatchSFTP Connectivity Map)
Synchronization (BatchSFTP Connectivity Map)
BatchSFTP Adapter Environment Properties
SFTP Settings (BatchSFTP Environment)
Firewall Settings (BatchSFTP Environment)
General Settings (BatchSFTP Environment)
Connection Pool Settings (BatchSFTP Environment)
Connection Retry Settings (BatchSFTP Environment)
BatchLocalFile Connectivity Map Properties
Pre Transfer (BatchLocalFile Connectivity Map)
Sequence Numbering (BatchLocalFile Connectivity Map)
Post Transfer (BatchLocalFile Connectivity Map)
General Settings (BatchLocalFile Connectivity Map)
Target Location (BatchLocalFile Connectivity Map)
BatchLocalFile Environment Properties
General Settings (BatchLocalFile Environment)
Connection Pool Settings (BatchLocalFile Environment)
BatchRecord Connectivity Map Properties
General Settings (BatchRecord Connectivity Map)
Record (BatchRecord Connectivity Map)
BatchRecord Environment Properties
Connection Pool Settings (BatchRecord Environment)
BatchInbound Connectivity Map Properties
Settings (BatchInbound Connectivity Map)
BatchInbound Environment Properties
MDB Settings (BatchInbound Environment)
IBM IP Stack Required for MVS Sequential, MVS GDG, and MVS PD
Creating User Defined Heuristic Directory Listing Styles
Heuristics Configuration File Format
FTP Heuristics Configuration Parameters
Commands Supported by FTP Server
Header Indication Regex Expression
Trailer Indication Regex Expression
Directory Indication Regex Expression
File Link Indication Regex Expression
File Link Symbol Regex Expression
Valid File Line Minimum Position
Special Envelope For Absolute Path Name
Listing Directory Yields Absolute Path Names
Absolute Path Name Delimiter Set
Change Directory Before Listing
Directory Name Requires Terminator
FTP Configuration Requirements for AS400 UNIX (UFS)
Dynamic Configurable Parameters for Secure FTP OTDs
Configuration Parameters that Accept Integer Values
Understanding Batch Adapter OTDs
Code Conversion and Generation
Type Conversion Troubleshooting
Essential BatchFTP OTD Methods
Additional FTP File Transfer Commands
BatchFTPOverSSL OTD Node Functions
BatchLocalFile OTD Node Functions
BatchLocalFile Specific Features
Pre/Post File Transfer Commands
Essential BatchLocalFile OTD Methods
Operation Without Resume Reading Enabled
To Avoid Storing a Resume Reading State
Generating Multiple Files with Sequence Numbering
Example 1: Parsing a Large File
Example 2: Slow, Complex Query
Record-processing OTD Node Functions
Using the Record-processing OTD
Choosing the Parse or Create Mode
Using Record Processing with Data Streaming
Regular Expressions and the Adapter
Rules for Directory Regular Expressions
Restrictions for Using Regular Expressions as Directory Names
Regular Expression Directory Name Examples
Additional Batch Adapter Features
Streaming Data Between Components
Introduction to Data Streaming
Overcoming Large-file Limitations
Data Streaming Versus Payload Data Transfer
SOCKS Configuration Properties
Additional Software Requirements
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.
The BatchSFTP OTD contains two top-level nodes, Client and Configuration. Expand these nodes to reveal additional sub-nodes.
Figure 5 BatchSFTP OTD Structure
The following list provides an explanation of various nodes in the BatchSFTP OTD, including primary functions:
BatchSFTP: Represents the OTD’s root node.
The BatchSFTP sub-nodes under the Configuration node correspond to the BatchSFTP Adapter’s Connectivity Map and Environment configuration parameters.
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 - Note that 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 - Note that 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.