Configuring
Batch Adapter BatchFTP Environment Properties
This topic describes the configuration properties for the BatchFTP OTD
accessed from the Environment Explorer tree.
The BatchFTP Environment Explorer properties include the following sections:
SOCKS (BatchFTP Environment)
This topic provides information
for configuring the SOCKS properties (accessed from the Environment Explorer).
The BatchFTP Adapter supports the negotiation methods, No-authentication and
User/password.
The SOCKS section of the BatchFTP Environment properties contains the
top-level parameters displayed in the following table.
Table 30 Environment - BatchFTP - SOCKS
Name
|
Description
|
Required Value
|
Socks Host Name
|
Specifies the SOCKS server (host) name. If you are communicating with
a SOCKS server enter the SOCKS server name in this parameter.
|
The name of the SOCKS server.
|
Socks Server Port
|
Specifies
the port number to use on the SOCKS server, when connecting to it.
|
An integer from 1 to 65,535.
The configured default is 1080.
|
Socks User Name
|
Specifies
the user name to use (together with the password specified under the Socks
Password parameter) for authentication with a SOCKS5 server, if necessary.
This parameter is used for the user/password negotiation method.
|
A valid SOCKS5 user name.
|
Socks Password
|
Specifies
the password to use (together with the user name specified under the Socks
User Name parameter) for authentication with a SOCKS5 server, if necessary.
This parameter is used for the user/password negotiation method.
Note –
The corresponding Java accessors are getSocksPassword(), setSocksPassword(java.lang.String p) and setSocksEncryptedPassword(java.lang.String
p).
|
A valid SOCKS5 password.
|
FTP (BatchFTP Environment)
The FTP section of the BatchFTP Environment properties contains the
top-level parameters displayed in the following table.
Table 31 Environment - BatchFTP - FTP
Name
|
Description
|
Required Value
|
Host Name
|
Specifies
the name of the external system that the Adapter connects to.
-
If the parameter SSH Tunneling Enabled under the SSH Tunneling
configuration settings is set to Yes, the parameters Host Name and Server
Port, under the FTP settings, are ignored. In this case, the FTP host name
is determined by an SSH option, according to the following model:
ssh -L ListenPort:FtpServerHost:FtpServerPort SSHServer
In the previous example, the FTP feature communicates with the FTP server FtpServerHost:FtpServerPort using an existing SSH tunnel. See SSH Tunneling (BatchFTP Connectivity Map) for details.
-
If the parameter Socks Enabled under the SOCKS configuration
parameters is set to Yes, the host name under the FTP configuration could
fail to resolve some names, for example, localhost or 127.0.0.1 correctly.
Use real IP or machine names to represent the hosts. See SOCKS (BatchFTP
Connectivity Map) for details.
|
The host name.
|
Server Port
|
Specifies
the port number to use on the FTP server when connecting to it.
If the parameter SSH Tunneling Enabled under the SSH Tunneling configuration
is set to Yes, the parameters Host Name and Server Port under the FTP configuration
are ignored. In this case, the FTP server port number is determined by an
SSH option, according to the following model:
ssh -L ListenPort:FtpServerHost:FtpServerPort
SSHServer
In the previous example, the FTP feature communicates with the FTP server FtpServerHost:FtpServerPort using an existing SSH tunnel. See SSH Tunneling (BatchFTP Connectivity Map) for details.
|
The server port number.
|
User Name
|
Specifies
the user name used to log onto the external system, when required.
|
A user name that provides access to the external system.
|
Password
|
If a password
is required to log on to an external system, enter the password that corresponds
to the user name.
The corresponding Java accessor methods are getPassword(), setPassword(), and setEncryptedPassword().
|
The password.
|
User Defined Heuristics Configura-tion
File
|
Specifies the name and location of the user defined FTP heuristics configuration
file. The format of the files content must be in the same form as that of
the FTPHeuristics.cfg file. See To
Create a Custom Heuristics Configuration File in Configuring
Java CAPS Project Components for Communication Adapters for
more details.
This property works in conjunction with the User Defined Directory Listing
Style property.
Note –
The BatchFTP OTD will generate an exception if a selected User
Defined Directory Listing Style or the User Defined Heuristics Configuration
File path is not defined correctly. If a User Defined Directory Listing Style
is specified, a corresponding value must also be provided for the User Defined
Heuristics Configuration File property.
|
The location and name of the user defined FTP heuristics configuration
file on the local host.
|
General Settings (BatchFTP Environment)
The General Settings section of the BatchFTP Environment properties
contains the top-level parameters displayed in the following table.
Table 32 Environment - BatchFTP - General Settings
Name
|
Description
|
Required Value
|
State Persistence Base Location
|
Specifies a working directory for storing intermediary results.
The options are:
-
Leave value blank: BatchFTP will use a default folder as the
working directory.
-
Specify a path to a local file system folder with read/write
permissions.
Note –
See Deploying an EAR File if you are deploying
the project to another application server.
|
A working directory with read/write permissions, or leave blank (no
value) to accept a default directory.
|
Connection Mode
|
Specifies whether a physical connection is established when an external
connection is instantiated. The 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).
|
Select Automatic or Manual.
The configured default is Automatic.
|
SSH Tunneling (BatchFTP Environment)
This topic provides information
for configuring the SSH Tunneling properties (accessed from the Environment
Explorer). If Secure FTP (FTP over SSH or FTP over SSL) is required, use the
Secure FTP OTDs (BatchFTPOverSSL, BatchSFTP, and BatchSCP). SSH Tunneling
is supported for compatibility purposes.
The SSH Tunneling section of the BatchFTP Environment properties contains
the top-level parameters displayed in the following table.
Table 33 Environment - BatchFTP - SSH Tunneling
Name
|
Description
|
Required Value
|
SSH Listen Host
|
Specifies
the name of the host where the SSH support software runs, and to which the
host listens. This parameter is required when and only when SSH Channel Established
is set to Yes. The reason for this is, if you choose No this Listen Host will
always be localhost because the SSH client will always be started from localhost.
For optimum security, it is recommended that you use localhost as your choice.
The connection to the corresponding port number on this host is forwarded
to the FTP server through an SSH-secure channel.
On the listen host, the SSH support software must be configured and
started with the Port-Forwarding option.
The FTP command connection is forwarded through the secure tunnel. The
corresponding SSH command uses the following model:
ssh -L ListenPort:FtpServerHost:FtpServerPort -o
BatchMode=yes SSHServer
If this host name is not localhost, the data transport between the local
host and the SSH listen host is not secure. Also, your SSH support software
should be configured to allow connections to other hosts (for some SSH clients,
it is an option -g).
For example, on an SSH listen host, you could issue a command, such
as:
ssh -L 4567:apple:21 -o BatchMode=yes apple
or
ssh -L 5678:orange: 21 -o BatchMode=yes apple
Regardless, the transport between the SSH listen host and the FTP server
is still secure.
|
The SSH listen host name.
The configured default is localhost.
|
SSH Listen Port
|
Specifies
the port number that the SSH-tunneling support software uses to check for
incoming connections. This port number can be any unused port number on the
SSH listen host.
The connection to this port is forwarded to the FTP server through an
SSH-secure channel. This parameter is required and it must be exactly same
as the ListenPort value in the SSH command you issue either
inside or outside the Sun Enterprise Service Bus system. The corresponding
SSH command line uses the following model:
ssh -L ListenPort:FtpServerHost:FtpServerPort -o
BatchMode=yes SSHServer Required Values
|
An integer from 1 to 65535.
|
SSH User Name
|
Specifies
an SSH user name. This parameter can be required when the setting for the
SSH Channel Established parameter is No.
This parameter is required only if the SSH support software is started
from within the Adapter (refer to the corresponding SSH command line). Even
then, it is only required if your SSH implementation executes in an interactive
way that requires you to enter a user name. Again, this requirement depends
on how you specify the SSH command line and how your SSH environment is configured.
|
The SSH user name.
|
SSH Password
|
Specifies
an SSH password corresponding to the user name entered under SSH User Name.
This parameter can be required only when the setting for the SSH Channel Established
parameter is No. For more information, see SSH User Name.
|
The SSH password.
|
Connection Pool Settings (BatchFTP Environment)
The Connection Pool Settings section of the BatchFTP Environment properties
contains the top-level parameters displayed in the following table.
Table 34 Environment - BatchFTP - Connection
Pool Settings
Name
|
Description
|
Required Value
|
Steady pool size
|
Specifies the minimum number of physical EIS connections that 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 EIS connections the pool contains.
|
An integer indicating the maximum number of connections allowed. A value
of 0 (zero) indicates that there is no maximum.
The default value is 10.
|
Max Idle Timeout In Second
|
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 maximum amount of time that a connection can remain in the pool.
|
An integer indicating the maximum idle timeout in seconds. When this
is set to a number greater than 0 (zero), 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 (BatchFTP Environment)
The Connection Retry Settings section The Connection Pool Settings section
of the BatchFTP Environment properties contains the top-level parameters displayed
in the following table.
Table 35 Environment - BatchFTP - 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 Configured default value is 0.
|
Connection Retry Interval
|
Specifies the length of time (in milliseconds) between each reattempt
to access the destination file. This is used in conjunction with the Connection
Retries setting.
|
An integer indicating length of the pause (in milliseconds).
The configured default value is 1000 (1
second).
|