Sun Adapter for Batch User's Guide

BatchFTPOverSSL Adapter Environment Properties

This section describes the configuration properties for the BatchFTPOverSSL OTD, accessed from the Environment Explorer.

The BatchFTPOverSSL Adapter Environment properties include the following sections:

FTP and SSL Settings (BatchFTPOverSSL Environment)

The FTP and SSL Settings section of the BatchFTPOverSSL Environment properties contains the top-level parameters displayed in this table.

Table 21 Environment - BatchFTPOverSSL - FTP and SSL Settings


Name	Description	Required Value
FTP Host	Specifies the FTP server host name or IP address.	The FTP server host name or IP address. The configured default is localhost.
Explicit port for FTP over SSL	Specifies the FTP port for explicit SSL. default is 21 (data port 20).	The FTP port number for explicit SSL. The configured default is 21 (data port 20).
Implicit port for FTP over SSL	Specifies the FTP port for implicit SSL.	The FTP port for implicit SSL The configured default is 990 (data port 989).
User ID	Specifies the user login for FTP server.	The user login name for FTP server.
Password	Specifies the password for the FTP server user login.	The password for the FTP server user login.
Key Store Location	Specifies the path to the keystore that contains the trusted CA certificates required for server authentication.	The fully qualified path to the keystore file.
Key Store Password	Specifies the password to access the keystore file.	The password for the keystore.
Key Store Type	Specifies the keystore format type. Selections include JKS or other. Note – JKS is currently the only supported keystore type. If “other” is selected as the value, an exception is thrown when the OTD is initialized, with the error message, “Unknown type key store”.	Select JKS. JKS is currently the only supported keystore type, and the configured default.

Firewall Settings (BatchFTPOverSSL Environment)

The Firewall Settings section of the BatchFTPOverSSL Environment properties contains the top-level parameters displayed in this table.

Table 22 Environment - BatchFTPOverSSL - Firewall Settings


Name	Description	Required Value
Firewall Host	Specifies the proxy server host name or IP.	The proxy server host name or IP address.
Firewall Port	Specifies the proxy server port.	The proxy server port number.
User ID	Specifies the user login on the proxy server.	User login ID.
Password	Specifies the password for the user login.	The user password.

General Settings (BatchFTPOverSSL Environment)

The General Settings section of the BatchFTPOverSSL Environment properties contains the top-level parameters displayed in this table.

Table 23 Environment - BatchFTPOverSSL - General Settings


Name	Description	Required Value
Connection Mode	Specifies whether a physical connection is established when an external connection is instantiated. Options are: Automatic: Establishes a physical connection when an external connection is instantiated. Manual: Does not automatically establish a physical connection when an external connection is instantiated. If a physical connection is not automatically established, a physical connection must be established from the Collaboration (for example, by calling the `connect()` method). If BatchFTPOverSSL Connection Mode is set to Automatic, the following Environment parameters must be set with valid values: FTP and SSL Settings ⇒ FTP Host FTP and SSL Settings ⇒ Explicit port for FTP over SSL (this must be set if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Secure Mode is set to Explicit SSL) FTP and SSL Settings ⇒ Implicit port for FTP over SSL (this must be set if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Secure Mode is set to Implicit SSL) FTP and SSL Settings ⇒ User ID FTP and SSL Settings ⇒ Password FTP and SSL Settings ⇒ Key Store Location (this must be set if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Require Server Authentication is set to Yes, or if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Distinguished Name for User contains a value, indicating that client authentication is required) FTP and SSL Settings ⇒ Key Store Password (this must be set if Key Store Location is set) Also, if a firewall is enabled and the Connectivity Map property, Firewall Settings ⇒ Use Firewall, is set to Yes, the following Environment parameters must be set with valid values: Firewall Settings ⇒ Firewall Host Firewall Settings ⇒ Firewall Port Firewall Settings ⇒ User Firewall Settings ⇒ Password	Select Automatic or Manual. The default is Automatic.
Temp Dir	Specifies a working directory for storing intermediary results. Options include: Leave value blank: BatchFTPOverSSL will use a default location as the temporary directory. Specify a path to a local file system folder with read/write permissions.	A working directory with read/write permissions, or leave blank (no value) to accept a default directory.

Connection Pool Settings (BatchFTPOverSSL Environment)

The Connection Pool Settings section of the BatchFTPOverSSL Environment properties contains the top-level parameters displayed in this table.

Table 24 Environment - BatchFTPOverSSL - Connection Pool Settings


Name	Description	Required Value
Steady pool size	Specifies the minimum number of physical connections the pool keeps available at all times.	An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed. The configured default is 2.
Maximum pool size	Specifies the maximum number of physical connections the pool contains. 0 (zero) indicates that there is no maximum.	An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum. The configured default is 10.
Max Idle Timeout In Seconds	Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the amount of time a connection can remain idle in the pool.	An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0, the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely. The configured default is 300 (5 minutes).

Connection Retry Settings (BatchFTPOverSSL Environment)

The Connection Retry Settings section of the BatchFTPOverSSL Environment Map properties contains the top-level parameters displayed in this table.

Table 25 Environment - BatchFTPOverSSL - Connection Retry Settings


Name	Description	Required Value
Connection Retries	Specifies the number of retries to establish a connection upon failure to acquire a connection.	An integer indicating the maximum number of retries to establish a connection upon failure to acquire a connection. The default value is 0.
Connection Retry Interval	Specifies the length of the pause (in milliseconds) between each reattempt to access the destination file. Used in conjunction with the Connection Retries setting.	An integer indicating length of the pause (in milliseconds). The default value is 1000 (1 second).