FTP-adapter runtime-environment property file
Format
ftpadp.host-ipaddr=IP-address-or-host-name-of-FTP-server-to-be-connected-to-to |
Function
Specifies the configuration information for each FTP adapter.
Create the FTP-adapter runtime-environment property file with the name service-ID.properties.
File storage location
Service-platform-installation-directory\CSC\custom-adapter\FTP\config\service-ID.properties
Specifiable properties
(1) Associated with server information
ftpadp.host-ipaddr=IP-address-or-host-name-of-FTP-server-to-be-connected-to
Specifies the IP address or the host name of the FTP server to be connected to.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
ftpadp.host-con-port=port-number-for-control-connection-of-FTP-server-to-be-connected-to ~ <Numeric character> ((1 to 65535)) <<21>>
Specifies the control connection port number for the FTP server to be connected to.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
ftpadp.file-name.charset={UTF-8|MS932} ~ <<UTF-8>>
Specifies the name of the character set to be used when the following information is sent and received between FTP servers:
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
You can specify the following values. The characters are not case sensitive.
(2) Associated with FTPS
ftpadp.ftps.enable={TRUE|FALSE} ~ <<FALSE>>
Specifies whether FTPS will be used for connecting to the FTP server.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
If you specify FALSE when the destination FTP server is operating in the Implicit mode of FTPS, the system might wait after connecting to the FTP server and until a timeout occurs. The shorter time period from among the following timeout values is applied as the timeout value:
ftpadp.ftps.protocol-name={TLS|SSL} ~ <<TLS>>
Specifies the security communication protocol to be prepared for using FTPS for connecting to the FTP server. This specification is valid only when FTPS is used for connecting to the FTP server.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
ftpadp.ftps.implicit-mode={TRUE|FALSE} ~ <<FALSE>>
Specifies whether the Implicit mode of FTPS will be used when FTPS is used for connecting to the FTP server. This specification is valid only when FTPS is used for connecting to the FTP server.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
If you specify FALSE when the destination FTP server is operating in the Implicit mode of FTPS, the system might wait after connecting to the FTP server and until a timeout occurs. The shorter time period from among the following timeout values is applied as the timeout value:
ftpadp.ftps.data-con-secure={TRUE|FALSE} ~ <<TRUE>>
Specifies whether the communication for data connection when FTPS is used for connecting to the FTP server, will be encrypted. This specification is valid only when FTPS is used for connecting to the FTP server.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
ftpadp.ftps.server-authentication={TRUE|FALSE} ~ <<FALSE>>
Specifies whether the FTP server when FTPS is used for connecting to the FTP server, will be authenticated. This specification is valid only when FTPS is used for connecting to the FTP server.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
(3) Associated with client information
ftpadp.client-ipaddr=IP-address-of-FTP-client
Specifies the IP address of the FTP client. The IP address that is specified here is used with the control and data connections.
If you omit this property, the system automatically assigns any IP address.
ftpadp.client-con-port.min=minimum-value-for-the-range-of-control-connection-port-numbers-of-FTP-client ~ <Numeric character> ((1024 to 65535))
Specifies the minimum value for the range of control connection port numbers of the FTP client.
You can specify the following values:
If you specify any other value, an error occurs when the FTP adapter starts.
If you omit this property, the system automatically sets up any port number.
ftpadp.client-con-port.max=maximum-value-for-the-range-of-control-connection-port-numbers-of-FTP-client ~ <Numeric character> ((1024 to 65535))
Specifies the maximum value for the range of control connection port numbers of the FTP client.
You can specify the following values:
If you specify any other value, an error occurs when the FTP adapter starts.
If you omit this property, the system automatically sets up any port number.
ftpadp.client-pasv-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV ~ <Numeric character> ((1024 to 65535))
Specifies the minimum value for the range of port numbers where the FTP adapter establishes a data connection, when the data connection mode is PASV. This property is valid only when the data connection mode is PASV.
You can specify the following values:
If you specify any other value, an error occurs when the FTP adapter starts.
If you omit this property, the system automatically sets up any port number.
ftpadp.client-pasv-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV ~ <Numeric character> ((1024 to 65535))
Specifies the maximum value for the range of port numbers where the FTP adapter establishes a data connection, when the data connection mode is PASV. This property is valid only when the data connection mode is PASV.
You can specify the following values:
If you specify any other value, an error occurs when the FTP adapter starts.
Omit this property in the following case. If you specify this property, an error occurs when the FTP adapter starts.
If you omit this property, the system automatically sets up any port number.
ftpadp.listen-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT ~ <Numeric character> ((1024 to 65535))
Specifies the minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT. Make sure that you specify this property when the data connection mode is PORT. If you omit this property, an error occurs when the FTP adapter starts.
This property is valid only when the data connection mode is PORT. You need not set this property when the data connection mode is PASV.
You can specify the following values:
If you specify any other value, an error occurs when the FTP adapter starts.
ftpadp.listen-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT ~ <Numeric character> ((1024 to 65535))
Specifies the maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT. Make sure that you specify this property when the data connection mode is PORT. If you omit this property, an error occurs when the FTP adapter starts.
This property is valid only when the data connection mode is PORT. You need not set this property when the data connection mode is PASV.
You can specify the following values:
If you specify any other value, an error occurs when the FTP adapter starts.
(4) Associated with FTP settings
ftpadp.ftp-user=login-user-name-of-FTP-server-to-be-connected-to ~ <Character string> ((1-80 characters))
Specifies the login user name of the FTP server to be connected to. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are as follows:
The login user name to be specified must have the permissions to execute file operations. The value specified here is used as an argument of the USER command.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
If you omit this property, make sure that you specify the login user name in a request message of the FTP adapter. If you do not specify the login user name, a system exception occurs when you invoke the FTP adapter.
ftpadp.ftp-type={A|a|I|i}
Specifies one of the following as the type of the data to be transmitted. The value specified here is used as an argument of the TYPE command.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
If you omit this property, the data is transmitted in the ASCII format in accordance with the FTP protocol specifications (RFC959).
ftpadp.ftp-mode={S|s|C|c} ~ <<S>>
Specifies whether the data to be transmitted will be compressed. The value specified here is used as an argument of the MODE command.
You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.
ftpadp.pasvport={PASV|pasv|PORT|port} ~ <<PASV>>
Specifies one of the following as the data connection mode:
(5) Associated with checking of the file size
ftpadp.file-size-check={TRUE|FALSE} ~ <<FALSE>>
Specifies whether the function to check whether the size of the file being sent and being received is correct, is executed
(6) Associated with maintenance log
ftpadp.methodtrace.level={1|2|3|4|5} ~ <<3>>
Specifies the output level for the maintenance log. The following table lists the output information and the output levels:
Output information | Output level | ||||
---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | |
Error information (cause of exception) | Y | Y | Y | Y | Y |
Entrance and exit information for the requester service method (class name, method name, argument, return value) | N | Y | Y | Y | Y |
Entrance and exit information for the external (such as BP) interfaces (class name, method name, argument, return value) | N | N | Y | Y | Y |
Entrance and exit information for the interfaces within the components (class name, method name, argument, return value) | N | N | N | Y | Y |
Debug information (information such as the branching of processing) | N | N | N | N | Y |
ftpadp.methodtrace.filepath=absolute-path-of-directory-to-output-maintenance-log ~ <Character strings (including two-byte characters) and spaces> <<Directory-to-output-J2EE-server-log\CSCADP\FTPADP\maintenance\service-ID>>
Specifies an absolute path for the directory to output the maintenance log. If you specify a non-existent directory, the log is output to the default output destination directory.
Specify directory-to-output-J2EE-server-log in ejb.server.log.directory of usrconf.cfg (option definition file for J2EE servers).
Note that the maintenance log is created with the name cscftpadpmtd_HCSC-server-name_number-of-files.log.
ftpadp.methodtrace.filenum=number-of-maintenance-log-files ~ <Numeric character> ((1 to 16)) <<8>>
Specifies the number of maintenance log files.
ftpadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one maintenance log file in bytes.
(7) Associated with FTP protocol trace
ftpadp.ftpprotocoltrace.filenum=number-of-protocol-trace-files ~ <Numeric character> ((1 to 16)) <<8>>
Specifies the number of protocol trace files.
ftpadp.ftpprotocoltrace.filesize=maximum-size-of-one-protocol-trace-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one protocol trace file in bytes.
(8) Associated with message log
ftpadp.messagelog.level={0|10|20} ~ <<10>>
Specifies the output level for the message log. The following table lists the output information and the output levels:
Output information | Output level | ||
---|---|---|---|
0 | 10 | 20 | |
Error information
| Y | Y | Y |
Warning information
| N | Y | Y |
Information
| N | N | Y |
(9) Associated with paths
ftpadp.account-inf-filepath=absolute-path-for-FTP-adapter-account-definition-file ~ <Character strings (including two-byte characters) and spaces>
Specifies an absolute path for the FTP adapter account definition file.
ftpadp.cscthrough-filepath=absolute-path-for-FTP-command-authorization-list-definition-file-(for-FTP-adapters) ~ <Character strings (including two-byte characters) and spaces>
Specifies an absolute path for the FTP command authorization list definition file (for FTP adapters). If you omit this property, the user-specified FTP commands cannot be executed before and after the transmission and before and after the execution of list commands.
(10) Associated with control connection timeout
ftpadp.control-con.retry.count=retry-count-when-control-connection-cannot-be-established ~ <Numeric character> ((0 to 10000)) <<5>>
Specifies the retry count when a control connection cannot be established. If you specify 0, the connection will not be retried.
ftpadp.control-con.retry.interval=retry-interval-when-control-connection-cannot-be-established ~ <Numeric character> ((0 to 86400)) <<2>>
Specifies the retry interval when a control connection cannot be established, in seconds. If you specify 0, the connection will be retried without an interval.
ftpadp.control-con.connect.timeout=connection-timeout-for-control-connection ~ <Numeric character> ((1 to 3600)) <<10>>
Specifies the connection timeout value for a control connection in seconds.
(11) Associated with data connection timeout
ftpadp.data-con.retry.count=retry-count-when-data-connection-cannot-be-established-in-PASV-mode ~ <Numeric character> ((0 to 10000)) <<5>>
Specifies the retry count when a data connection cannot be established in the PASV mode. If you specify 0, the connection will not be retried.
ftpadp.data-con.retry.interval=retry-interval-when-data-connection-cannot-be-established-in-PASV-mode ~ <Numeric character> ((0 to 86400)) <<2>>
Specifies the retry interval when a data connection cannot be established in the passive mode, in seconds. If you specify 0, the connection will be retried without an interval.
ftpadp.data-con.connect.timeout=connection-timeout-for-data-connection ~ <Numeric character> ((1 to 3600)) <<10>>
Specifies the connection timeout value for a data connection in the passive mode, in seconds.
(12) Associated with lock acquisition timeout
ftpadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>
Specifies the retry count when a shared lock of the files in the common folder fails.
ftpadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>
Specifies the retry interval when a shared lock of the files in the common folder fails, in seconds.
ftpadp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>
Specifies the retry count when a dedicated lock of the files in the common folder fails.
ftpadp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>
Specifies the retry interval when a dedicated lock of the files in the common folder fails, in seconds.
(13) Associated with data transmission acquisition timeout
ftpadp.data-con-put.timeout=timeout-value-for-data-transmission ~ <Numeric character> ((1 to 86400)) <<60>>
Specifies the monitoring time for a file to be sent completely while sending the data, in seconds. An exception (error) occurs when the sending process is not completed even after the lapse of the specified time.
ftpadp.data-con-get.timeout=timeout-value-for-data-acquisition ~ <Numeric character> ((1 to 86400)) <<60>>
Specifies the monitoring time for a file to be received completely while receving the data, in seconds. An exception (error) occurs when the receiving process is not completed even after the lapse of the specified time.
(14) Associated with FTP command reply timeout
ftpadp.ftp-command-reply.timeout=reply-timeout-value ~ <Numeric character> ((1 to 3600)) <<60>>
Specifies the monitoring time until a reply is received after issuing an FTP command, in seconds. An exception (error) occurs when there is no reply from the command even after the lapse of the specified time.
(15) Associated with Listen timeout
ftpadp.listen.timeout=Listen-timeout-value ~ <Numeric character> ((1 to 3600)) <<60>>
Specifies the monitoring time for the Listen status after a reply is received from the PORT command in the PORT mode, in seconds. An exception (error) occurs when there is no data connection request from the server even after the lapse of the specified time.
(16) Associated with buffer size
ftpadp.put-client-buffer.size=client-buffer-size-for-file-transmission-(sending) ~ <Numeric character> ((512 to 262144)) <<40960>>
Specifies the client buffer memory size for file transmission (sending) in bytes.
Change this value in the cases such as when the memory is limited or when you want to improve the transmission efficiency. Note that the transmission efficiency changes due to the speed and the usage of the circuit and the CPU performance.
ftpadp.get-client-buffer.size=client-buffer-size-for-file-transmission-(receiving) ~ <Numeric character> ((512 to 262144)) <<40960>>
Specifies the client buffer memory size for file transmission (receiving) in bytes.
Change this value in the cases such as when the memory is limited or when you want to improve the transmission efficiency. Note that the transmission efficiency changes due to the speed and the usage of the circuit and the CPU performance.
(17) Associated with exception log
ftpadp.exptrace.filenum=number-of-exception-log-files ~ <Numeric character> ((1 to 16)) <<8>>
Specifies the number of exception log files.
ftpadp.exptrace.filesize=maximum-size-of-one-exception-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>
Specifies the maximum size of one exception log file in bytes.
(18) Associated with the reuse of ports
ftpadp.listen-port.reuse={TRUE|FALSE} ~ <<TRUE>>
Specifies whether to reuse ports in the TIME_WAIT status if the OS is Linux or AIX and the data connection mode is PORT mode. If the data connection mode is other than the PORT mode, the value specified in this property is ignored.
The ports having port numbers in the range from the value specified for ftpadp.listen-port.min to the value specified for ftpadp.listen-port.max can be reused.
This property is ignored if specified in HP-UX. If you specify this property in Windows, an error occurs when an FTP adapter starts.