6.8.3 FTP-adapter runtime-environment property file

(a) Properties that must be specified in a request message or the FTP-adapter runtime-environment property file

You must specify the following properties in a request message or the FTP-adapter runtime-environment property file. If you specify the parameters in both the request message and the FTP-adapter runtime-environment property file, the values in the request message become valid.

ftpadp.host-ipaddr=IP-address-or-host-name-of-FTP-server-to-be-connected-to
ftpadp.ftp-user=login-user-name-of-FTP-server-to-be-connected-to

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.

Important note

To use Windows, specify the real IP address or host name. If you specify a loopback IP address (127.0.0.1 or localhost), an FTP connection might fail.

Associated with FTP settings

ftpadp.ftp-user=login-user-name-of-FTP-server-to-be-connected-to ~ <Character string> ((1 to 80 characters))

Specifies the login user name of the FTP server to be connected to the FTP adapter. The available user names are specified in the FTP adapter account definition file.

You can use halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding), and halfwidth spaces (0x20 in ASCII encoding). The characters are case sensitive. You can use the following halfwidth symbols:

• Exclamation mark (!)

• Double quotation mark (")

• Hash mark (#)

• Dollar sign ($)

• Percent sign (%)

• Ampersand (&)

• Apostrophe mark (')

• Left parenthesis (()

• Right parenthesis ())

• Asterisk (*)

• Plus sign (+)

• Comma (,)

• Hyphen (-)

• Period (.)

• Forward slash (/)

• Colon (:)

• Semicolon (;)

• Left angle bracket (<)

• Right angle bracket (>)

• Equal sign (=)

• Question mark (?)

• At mark (@)

• Left square bracket ([)

• Right square bracket (])

• Yen sign (\)

• Caret (^)

• Underscore (_)

• Grave accent mark (`)

• Left curly bracket ({)

• Right curly bracket (})

• Vertical bar (|)

• Swung dash (~)

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, you need to specify the login user name in the FTP adapter's request message. If you do not specify the login user name, a system exception occurs when the FTP adapter is invoked.

(b) Specifiable properties in a request message and FTP-adapter runtime-environment property file

If necessary, you can specify the following properties in a request message or the FTP-adapter runtime-environment property file. If you specify the properties in both the request message and the FTP-adapter runtime-environment property file, the values in the request message become valid. You can use the FTP-adapter runtime-environment common properties file to reduce the number of definition files managed during operation. In this case, if you want to specify different values for some properties for each request, specify the information in a request message.

ftpadp.host-con-port=port-number-for-control-connection-of-FTP-server-to-be-connected-to
ftpadp.file-name.charset={UTF-8|MS932}
 
ftpadp.ftp-type={A|a|I|i}
ftpadp.ftp-mode={S|s|C|c}
ftpadp.pasvport={PASV|pasv|PORT|port}
 
ftpadp.file-size-check={TRUE|FALSE}
 
ftpadp.ftps.enable={TRUE|FALSE}
ftpadp.ftps.protocol-name={TLS|SSL}
ftpadp.ftps.implicit-mode={TRUE|FALSE}
ftpadp.ftps.data-con-secure={TRUE|FALSE}
ftpadp.ftps.server-authentication={TRUE|FALSE}

Associated with server information

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:

• Information (such as the file name) to be sent and received with a control connection

• Information (file list information) received from the FTP server via a data connection, during the execution of the commands LIST or NLST

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.

• UTF-8

  • UTF-8 will be used as the character set.

• MS932

  • MS932 will be used as the character set.

Associated with FTP settings

ftpadp.ftp-type={A|a|I|i}

Specifies one of the following values as the type of data to be transmitted. The value specified here is used as an argument of the TYPE command.

• A or a

  Data will be transmitted in the ASCII format.

• I or i

  Data will be transmitted in the image (BINARY) format.

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, 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 to compress the data to be transmitted. The value specified here is used as an argument of the MODE command.

• S or s

  The file will be transmitted without being compressed.

• C or c

  The file will be compressed and transmitted.

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.

• PASV or pasv

  The data connection will be set up in the PASV mode.

• PORT or port

  The data connection will be set up in the PORT mode.

Associated with checking of the file size

ftpadp.file-size-check={TRUE|FALSE} ~ <<FALSE>>

Specifies whether to use the function that checks whether the size of the file being sent and being received is correct.

• TRUE

  The file size will be checked.

• FALSE

• The file size will not be checked.

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.

• TRUE

  FTPS will be used for connecting to the FTP server.

  If you select TRUE, the communication for control and data connections is encrypted (not encrypted if you specify settings to control the encryption of the communication for a data connection). However, the destination FTP server must support the FTPS-based connection.

• FALSE

  Normal FTP will be used for connecting to the FTP server.

  If you select FALSE, the communication for control and data connections is not encrypted.

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:

• Value specified in the ftpadp.control-con.connect.timeout property (connection timeout value for control connection)

  If a timeout occurs at this value, the connection is retried for the number of times specified in the ftpadp.control-con.retry.count property, and then the message KDEK30407-E will be displayed.

• Timeout value specified in the destination FTP server

  If a timeout occurs at this value, the message KDEK30428-E will be displayed.

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.

• TLS

  TLS will be used in the security communication protocol.

• SSL

  SSL will be used in the security communication protocol.

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.

• TRUE

  The Implicit mode (mode in which an implicitly encrypted communication is started immediately after connecting to the FTP server) will be used. The mode in which an implicitly encrypted communication is started immediately after connecting to the FTP server will be used.

• FALSE

  The Explicit mode (mode in which an explicitly encrypted communication is started by executing the AUTH command from the FTP client, after connecting to the FTP server) will be used. The mode in which an explicitly encrypted communication is started by executing the AUTH command from the FTP client, after connecting to the FTP server, will be used.

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:

• Value specified in the ftpadp.control-con.connect.timeout property (connection timeout value for control connection)

  If a timeout occurs at this value, the connection is retried for the number of times specified in the ftpadp.control-con.retry.count property, and then the message KDEK30407-E will be displayed.

• Timeout value specified in the destination FTP server

  If a timeout occurs at this value, the message KDEK30428-E will be displayed.

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.

• TRUE

  The communication for data connection will be encrypted.

• FALSE

  The communication for data connection will not be encrypted.

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.

• TRUE

  The server will be authenticated (the certificate will be checked).

  Whether the public key certificate of the FTP server, which is the FTPS destination, is reliable will be checked, and the processing will be executed only if the certificate is reliable.

  To specify TRUE, the trust store-related settings are required. For details on the trust store-related settings, see Appendix H.2 Encryption and authentication using a secure protocol (FTP inbound adapter) in the uCosminexus Service Platform Reception and Adapter Definition Guide.

• FALSE

  The certificate will not be checked.

  The processing continues without checking whether the public key certificate of the FTP server, which is the FTPS destination, is reliable.

(c) Properties that can be specified only in the FTP-adapter runtime-environment property file

The following properties can be specified in the FTP-adapter runtime-environment property file. If you want to reduce the number of definition files managed during operation, use the FTP-adapter runtime-environment common properties file.

ftpadp.client-ipaddr=IP-address-of-HCSC-server
ftpadp.client-con-port.min=minimum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter
ftpadp.client-con-port.max=maximum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter
ftpadp.control-con.retry.count=retry-count-when-control-connection-cannot-be-established
ftpadp.control-con.retry.interval=retry-interval-when-control-connection-cannot-be-established
ftpadp.control-con.connect.timeout=connection-timeout-for-control-connection
 
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
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
ftpadp.data-con.retry.count=retry-count-when-data-connection-cannot-be-established-in-PASV-mode
ftpadp.data-con.retry.interval=retry-interval-when-data-connection-cannot-be-established-in-PASV-mode
ftpadp.data-con.connect.timeout=connection-timeout-for-data-connection
 
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
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
ftpadp.listen-port.reuse={TRUE|FALSE}
ftpadp.listen.timeout=Listen-timeout-value
ftpadp.data-con.read.timeout=receive-buffer-read-timeout-value-for-data-connection-in-passive-mode
 
ftpadp.exptrace.filenum=number-of-exception-log-files
ftpadp.exptrace.filesize=maximum-size-of-one-exception-log-file
ftpadp.ftpprotocoltrace.filenum=number-of-protocol-trace-files
ftpadp.ftpprotocoltrace.filesize=maximum-size-of-one-protocol-trace-file
ftpadp.methodtrace.level={1|2|3|4|5}
ftpadp.methodtrace.filepath=absolute-path-of-directory-to-output-maintenance-log
ftpadp.methodtrace.filenum=number-of-maintenance-log-files
ftpadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file
ftpadp.messagelog.level={0|10|20}
 
ftpadp.account-inf-filepath=absolute-path-of-FTP-adapter-account-definition-file
ftpadp.cscthrough-filepath=absolute-path-of-FTP-command-authorization-list-definition-file
 
ftpadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails
ftpadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails
ftpadp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails
ftpadp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails
 
ftpadp.data-con-put.timeout=timeout-value-for-data-transmission
ftpadp.data-con-get.timeout=timeout-value-for-data-acquisition
 
ftpadp.ftp-command-reply.timeout=reply-timeout-value
 
ftpadp.put-client-buffer.size=client-buffer-size-for-file-transmission-(sending)
ftpadp.get-client-buffer.size=client-buffer-size-for-file-transmission-(receiving)

Associated with client information (basic settings)

ftpadp.client-ipaddr=IP-address-of-HCSC-server

Specifies the IP address of the HCSC server. The IP address specified here is used for control connections and data connections.

If you omit this property, the system automatically assigns any IP address. Among the batch of IP addresses acquired by using the java.net.NetworkInterface class, the first real IP address found is allocated. If a real IP does not exist, a loopback IP address is allocated.

Important note

To use Windows, specify a real IP address. If you specify a loopback IP address, an FTP connection might fail.

ftpadp.client-con-port.min=minimum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter ~ <Numeric character> ((1024 to 65535))

Specifies the minimum value for the range of control connection port numbers of the FTP-adapter.

You can specify the following values:

• Values that are equal to or less than the value of the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

• Values that do not overlap with the range specified by the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV) and the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

• Values that do not overlap with the range specified by the ftpadp.listen-port.min property (minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT) and the ftpadp.listen-port.max property (maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

Do not specify this property if you omit the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter). 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.client-con-port.max=maximum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter ~ <Numeric character> ((1024 to 65535))

Specifies the maximum value for the range of control connection port numbers of the FTP adapter.

You can specify the following values:

• Values that are equal to or more than the value specified for the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter)

• Values that do not overlap with the range specified by the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV) and the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

• Values that do not overlap with the range specified by the ftpadp.listen-port.min property (minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT) and the ftpadp.listen-port.max property (maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

Do not specify this property if you omit the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter). 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.

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, in seconds, the retry interval when a control connection cannot be established. 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, in seconds, the connection timeout value for a control connection.

Associated with client information (when the data connection mode is PASV)

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:

• Values that are equal to or less than the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

• Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

Do not specify this property if you omit the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV). 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.

For the port number, specify a value in the range from the value of this property to the value of the ftpadp.client-pasv-port.max property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If an attempt to establish a data connection without specifying this property failed or if all of the values in the range cannot be used for the data connection port number, the KDEK30409-E message is output.

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:

• Values that are equal to or more than the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

• Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

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 or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

If you omit the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV), omit this property as well. 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.

For the port number, specify a value in the range from the value of this property to the value of the ftpadp.client-pasv-port.min property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If an attempt to establish a data connection without specifying this property failed or if all of the values in the range cannot be used for the data connection port number, the KDEK30409-E message is output.

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.

When the connection is retried, the KDEK30410-W message is output. If the retry count exceeds the value of this property, the KDEK30409-E message is output.

ftpadp.data-con.retry.interval=retry-interval-when-data-connection-cannot-be-established-in-PASV-mode ~ <Numeric character> ((0 to 86400)) <<2>>

Specifies, in seconds, the retry interval when a data connection cannot be established in the PASV mode. 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, in seconds, the connection timeout value for a data connection in the PASV mode.

Associated with client information (when the data connection mode is PORT)

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)) <<49152>>

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.

This property is valid only when the data connection mode is PORT.

You can specify the following values:

• Values that are equal to or less than the ftpadp.listen-port.max property (maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

• Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

For the port number used to wait for a data connection, specify a value in the range from the value of this property to the value of the ftpadp.listen-port.max property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If all the values in the range cannot be used for the wait port number, the KDEK30409-E message is output.

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)) <<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.

This property is valid only when the data connection mode is PORT.

You can specify the following values:

• Values that are equal to or more than the ftpadp.listen-port.min property (minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

• Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

For the port number used to wait for a data connection, specify a value in the range from the value of this property to the value specified for the ftpadp.listen-port.min property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If all of the values in the range cannot be used for the wait port number, the KDEK30409-E message is output.

Associated with the reuse of ports

ftpadp.listen-port.reuse={TRUE|FALSE} ~ <<TRUE>>

Specifies whether to reuse ports in the TIME_WAIT status when the OS is Linux or AIX and the data connection mode is the PORT mode. If the data connection mode is other than the PORT mode, the value specified in this property is ignored.

You can reuse 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.

• TRUE

  Ports in the TIME_WAIT status will be reused.

  In addition, SO_REUSEADDR is enabled.

  TRUE is also assumed when you omit this property or if you specify only the property name.

  Important note

  Depending on whether port numbers used in the PASV mode (in the range from the value of ftpadp.client-pasv-port.min to the value of ftpadp.client-pasv-port.max) are specified, make sure that the port numbers are not duplicated as follows. If port numbers are duplicated, operations are not guaranteed.

  • If port numbers for use in the PASV mode are specified

    Make sure that the port numbers are not in the range of the port numbers used in the PORT mode (the range from the value specified for ftpadp.listen-port.min to the value specified for ftpadp.listen-port.max).

  • If port numbers for use in the PASV mode are not specified

    Make sure that the available range of OS dynamic ports do not overlap with the range of port numbers used in the PORT mode (the range from the value specified for ftpadp.listen-port.min to the value specified for ftpadp.listen-port.max).

• FALSE

  Ports in the TIME_WAIT status will not be reused.

  In addition, SO_REUSEADDR is disabled.

If you specify this property in Windows, an error occurs when an FTP adapter starts.

Important note

When you specify this property in Linux or AIX, specify the same value for all FTP adapters in the PORT mode on the HCSC server. If you do not specify the same value, operations are not guaranteed.

Associated with Listen timeout

ftpadp.listen.timeout=Listen-timeout-value ~ <Numeric character> ((1 to 3600)) <<60>>

Specifies, in seconds, the monitoring time for the Listen status after a reply is received from the PORT command in the PORT mode. If there is no data connection request from the server when the specified time has elapsed, an exception (error) occurs.

Associated with data read timeout

ftpadp.data-con.read.timeout=receive-buffer-read-timeout-value-for-data-connection-in-passive-mode ~ <Numeric character> ((0 to 3600)) <<0>>

Specifies, in seconds, the timeout value for reading data from the receive buffer for a data connection in passive mode.

If you specify 0, timeouts do not occur.

Associated with exception logs

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.

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.

Associated with maintenance logs

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 output levels.

Output information	Output level
	1	2	3	4	5
Error information (cause of an exception)	Y	Y	Y	Y	Y
Entrance and exit information for the requestor 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 a component (class name, method name, argument, return value)	N	N	N	Y	Y
Debug information (such as information of 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 the absolute path to the directory to output the maintenance log.

directory-to-output-J2EE-server-log is specified in ejb.server.log.directory of usrconf.cfg (option definition file for the J2EE server).

A directory having the specified service ID is created directly under the specified path, and then the maintenance log is created in this directory.

Note that a maintenance log is created with the name cscftpadpmtd_HCSC-server-name_number-of-files.log.

If you specify a non-existent directory or if the directory having the service ID cannot be created, the KDEK20903-W message is output and the maintenance log is output to the default output destination directory.

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.

Associated with message logs

ftpadp.messagelog.level={0|10|20} ~ <<10>>

Specifies the output level for the message log. The following table lists the output information and output levels:

Output information	Output level
	0	10	20
Error information Cause of an exception or an error	Y	Y	Y
Warning information Information such as a problem that occurred	N	Y	Y
Information Contents of messages and arguments Change in the HCSC-Messaging status (when starting or stopping) Command reception and completion of execution Event notification	N	N	Y

Associated with paths

ftpadp.account-inf-filepath=absolute-path-of-FTP-adapter-account-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies the absolute path to the FTP adapter account definition file.

ftpadp.cscthrough-filepath=absolute-path-of-FTP-command-authorization-list-definition-file-(for-FTP-adapters) ~ <Character strings (including two-byte characters) and spaces>

Specifies the absolute path to 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.

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, in seconds, the retry interval when a shared lock of the files in the common folder fails.

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, in seconds, the retry interval when a dedicated lock of the files in the common folder fails.

Associated with data transmission or acquisition timeout

ftpadp.data-con-put.timeout=timeout-value-for-data-transmission ~ <Numeric character> ((1 to 86400)) <<60>>

Specifies, in seconds, the monitoring time until the transmission of the entire file is completed when sending data. If the sending process is not completed even after the specified time has elapsed, an exception (error) occurs.

ftpadp.data-con-get.timeout=timeout-value-for-data-acquisition ~ <Numeric character> ((1 to 86400)) <<60>>

Specifies, in seconds, the monitoring time until the reception of the entire file is completed when receiving data. If the receiving process is not completed even after the specified time has elapsed, an exception (error) occurs.

Associated with FTP command reply timeout

ftpadp.ftp-command-reply.timeout=reply-timeout-value ~ <Numeric character> ((1 to 3600)) <<60>>

Specifies, in seconds, the monitoring time until a reply is received after an FTP command is issued. If there is no reply for the command even after the specified time has elapsed, an exception (error) occurs.

Associated with the buffer size

ftpadp.put-client-buffer.size=client-buffer-size-for-file-transmission-(sending) ~ <Numeric character> ((512 to 262144)) <<40960>>

Specifies the size of client buffer memory in bytes for file transmission (sending).

Change this value when the memory is limited or if you want to improve the transmission efficiency. Note that the transmission efficiency varies depending on the line speed, line usage, and CPU performance.

ftpadp.get-client-buffer.size=client-buffer-size-for-file-transmission-(receiving) ~ <Numeric character> ((512 to 262144)) <<40960>>

Specifies the size of client buffer memory in bytes for file transmission (receiving).

Change this value when the memory is limited or if you want to improve the transmission efficiency. Note that the transmission efficiency varies depending on the line speed, line usage, and CPU performance.