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
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 FTP over SSL OTD (BatchFTPOverSSL) provides secure data transfer using Secure Sockets Layer (SSL) protocol. For information about configuring external FTP servers, SSL servers, and so forth, refer to the application’s documentation.
The BatchFTPOverSSL OTD contains two top-level nodes, Client and Configuration. Expand these nodes to reveal additional sub-nodes.
Figure 4 BatchFTPOverSSL OTD Structure
The following list provides an explanation of various nodes in the BatchFTPOverSSL OTD, including primary functions:
BatchFTPOverSSL: Represents the OTD’s root node.
The BatchFTPOverSSL sub-nodes under the Configuration node correspond to BatchFTPOverSSL Adapter’s Connectivity Map and Environment configuration parameters.
The Client node contains sub-nodes that implement the adapter’s client interface in the OTDs. The BatchFTPOverSSL Client node includes the following methods:
append(): transfers data to the remote in append mode. The source of the data is determined by the configuration parameters Local Directory and Local File. If both are empty, then the data is from pay load.
connect(): connects to the FTP server and does authentication as configured.
deleteDir(String dir): deletes the remote directory as specified by the argument.
deleteFile(String path): deletes the remote file as specified by the argument.
disconnect(): disconnects from the FTP server.
doRawCommands(String commands): specifies the raw commands.
download(): downloads data from the remote (specified in configuration parameters Remote Directory and Remote File) to the local (specified in configuration parameters Local Directory and Local File).
get(): copies the file or directory specified by the configuration parameters Remote Directory and Remote File, to the local directory, as specified by the configuration parameters Local Directory and Local File. If the configuration parameter, Is Copy Recursive, is set to Yes, the copy will be recursive.
getEntry(): gets the index entry in the current entry list.
getEntryCount(): returns the count of directory entries, as the result of invoking listDir or listDirLong.
getLastReply(): gets the FTP response code as a String.
getPayload(): returns the payload.
hasEntry(): returns false if there is more to the entry in the directory listing result list (when the result list is exhausted), and calls resetEntries to reiterate the result list again.
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 FTP server.
listDir(): returns the entry under the remote directory (specified in configuration parameters Remote Directory and Remote File). The entry only contains the name. After this method is invoked, use methods such as hasEntry, nextEntry, getEntry, getEntryCount, and so forth. to iterate the entry information.
listDirLong(): returns the entries under the remote directory (specified in configuration parameters Remote Directory and Remote File). The entry contains details such as name, size, time stamp, is directory or not, and so forth. After this method is invoked, use methods such as hasEntry, nextEntry, getEntry, getEntryCount, and so forth, to iterate the entry information.
mkdir(String dir): creates a directory on the remote. The name of the directory is specified in the configuration parameters.
nextEntry(): returns the next entry in the result list.
put(): same as get, but the data transfer is from local to remote.
renameFile(String newName): renames the file specified by the configuration parameters Remote Directory and Remote File to a new name (arg).
reset(): resets the internal life cycle methods, such as discard payload buffer.
resetEntries(): resets the result list iterator so that it can be iterated again.
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 as specified by the argument.
setResolvedLocalDirectory(String s): sets the resolved local directory name.
setResolvedLocalFile(String s): sets the resolved local file name.
setResolvedRemoteDirectory(String s): sets the resolved remote directory name.
setResolvedRemoteFile(String s): sets the resolved remote file name.
upload(): uploads data from the local (specified in configuration parameters Local Directory and Local File) to the remote (specified in configuration parameters Remote Directory and Remote File).
Note - See the Batch Adapter Javadoc for a list of all exposed FTPOverSSLClient methods.