3.2.3 Setting up the FTP inbound adapter

(a) Setup procedure

1. Obtain the attributes from the RAR file of the FTP inbound adapter, and create the property file.

   The execution format for creating the property file from the RAR file of the FTP inbound adapter is as follows:

   <Service Platform installation directory>\CC\admin\bin\jgetrarprop <J2EE server name> -resname FTP_Inbound_Resource_Adapter -c <file path of the property file>

   For details on the cjgetrarprop command, see "2.4 Resource operation commands used with J2EE servers" in "Application Server Command Reference Guide".

2. Edit the property file.

   For details on the property file, see "(b) Contents of the property file".

3. The values specified in the property file in which the definition items were edited, are applied to the RAR file of the FTP inbound adapter.

   The execution format for applying the property file to the FTP inbound adapter is as follows:

   <Service Platform installation directory>\CC\admin\bin\cjsetrarprop <J2EE server name> -resname FTP_Inbound_Resource_Adapter -c <file path of the property file>

For details on the cjsetrarprop command, see "2.4 Resource operation commands used with J2EE servers" in "Application Server Command Reference Guide".

(b)  Contents of the property file

Property file definitions

The definition tags in the property file are as follows:

<hitachi-connector-property>
 <resourceadapter>
 <config-property>
 <config-property-name> : Definition name
 <config-property-type> : Definition type
 <config-property-value> : Definition value
 </config-property>
 <config-property>
 <config-property-name> : Definition name
 <config-property-type> : Definition type
 <config-property-value> : Definition value
 </config-property>
 :
(Repeated for the existing number of definitions)
 :

To edit a definition, search for the "Definition name" you want to edit, and rewrite the corresponding "Definition value". For details on the items that can be edited, see "Property file definition items".

Note the following when you edit the property file:

• Rewrite only the values of the definition items listed in the "definition items". Do not change the other items and values.

• Do not specify the contents of the property file in the application property file (cosminexus.xml).

• Do not change the resource adapter name in the <display-name> tag existing in the property file.

• In the log output related settings, if you change the file size per log file, and the number of backup log files for each type of log, make a backup of the log files before you start the FTP inbound adapter.

Property file definition locations

The following figure shows the definition locations for the property files.

Figure 3‒8:  Locations where the property file contents and definitions are set up

Property file definition items

The following table describes and lists the property file definition items for each setup content.

Table 3‒22:  Lists of property file definition items (Settings related to transmit control)

Definition items	Definition name	Range of values	Default value	Supplementary information
Maximum number of concurrent connections	server_maxLogins	1 to 1024	10	--
Use of character set UTF-8	server_charset_UTF8	ON or OFF	ON	If ON is specified, UTF-8 is used as the character code. If OFF is specified, MS932 is used as the character code. Note that if the character set is specified with the FTP command, that setting is enabled.
Compatibility of FTP response termination character	server_endOfLineCompatible	true or false	false (CRLF becomes the default termination code)	If true is specified, an OS-dependent linefeed code (In Windows: CRLF, In UNIX: LF) is used as the FTP response termination character. If false is specified, CRLF is used as the FTP response termination character.
Local IP address	nioListener_localAddress	0.0.0.0 to 255.255.255.255 0:0:0:0:0:0:0:0-FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF	All available (If the host executing the FTP inbound adapter has multiple IP addresses, the requests from the FTP client are received on all the IP addresses)	--
Port number	nioListener_port	1 to 65535	21	--
Local IP address when the data connection is established	nioListener_dataConnection_active_localAddress	0.0.0.0 to 255.255.255.255 0:0:0:0:0:0:0:0-FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF	Any available (If the host that runs the FTP inbound adapter has multiple IP addresses, the same IP address that is assigned to the control connection used in the same session is assigned.)	In PASV mode, independent of the setting of this property, the same IP address that is assigned to the control connection used in the same session is assigned to the data connection.
Port number when the data connection is established	nioListener_dataConnection_active_localPort	1 to 65535	Any available (The port number that is free in the host executing the FTP inbound adapter is allocated)	Do not specify a port number that is already in use. If specified, the data connection cannot be established.
Listen backlog count	nioListener_listenBacklog	1 to 2147483647	50	--
Data connection buffer size	nioListener_dataConnection_socketBufferSize	1 to 65536	16384	(Unit: bytes)

Legend:

-: None in particular

Table 3‒23:  List of property file definition items (Settings related to timeout)

Definition items	Definition name	Range of values	Default value	Supplementary information
Idle timeout	nioListener_idleTimeout	0 to 7200	300	If 0 is specified, the timeout is not monitored. (Unit: seconds)
Data connection retry count	nioListener_dataConnection_active_connectRetryCount	0 to 50	5	If 0 is specified, connection is not retried.
Data connection monitoring time	nioListener_dataConnection_active_connectRetryInterval	0 to 1800	10	If 0 is specified, the timeout is not monitored. (Unit: seconds)
Data sending and data receiving timeout	nioListener_dataConnection_idleTimeout	0 to 1800	10	If 0 is specified, the timeout is not monitored. (Unit: seconds)

For the FTPS-related settings in the property file definition items, see "Appendix H.3 Property file definition items during setup (FTP inbound adapter)" in "Service Platform Reception and Adapter Definition Guide".

Table 3‒24:  List of property file definition items (Settings related to log output)

Classification	Definition items	Definition name	Range of values	default value	Supplementary information
Message log	Output level	server_message_logLevel	debug, or info	info	info: This level outputs information that is used for normal operations and is necessary for operations. debug: This level is used for investigation when test or error occurs, and outputs the debug information in addition to the information output in "info".
	Size per log file	server_message_maxFileSize	1MB to 2048MB	10MB	Specify the character string for the unit as well. (Unit: MB)
	Number of backup log files	server_message_maxBackupIndex	1 to 16	4	--
Maintenance log	Log output level	server_maintenance_logLevel	debug, or info	info	The meaning of "info" and "debug" is the same as the "log output level" of the message log.
	Size per log file	server_maintenance_maxFileSize	1MB to 2048MB	5MB	Specify the character string for the unit as well. (Unit: MB)
	Number of backup log files	server_maintenance_maxBackupIndex	1 to 16	4	--
Protocol trace log	Log output level	server_protocol_logLevel	debug, or info	info	The meaning of "info" and "debug" is the same as the "log output level" of the message log.
	Size per log file	server_protocol_maxFileSize	1MB to 2048MB	20MB	Specify the character string for the unit as well. (Unit: MB)
	Number of backup log files	server_protocol_maxBackupIndex	1 to 16	4	--
Transmit history log	Log output level	server_history_logLevel	debug, or info	info	The meaning of "info" and "debug" is the same as the "log output level" of the message log.
	Size per log file	server_history_maxFileSize	1MB to 2048MB	12MB	Specify the character string for the unit as well. (Unit: MB)
	Number of backup log files	server_history_maxBackupIndex	1	1	--
Common log between resource adapters	Log output level	server_common_logLevel	debug, or info	info	The meaning of "info" and "debug" is the same as the "log output level" of the message log.
	Size per log file	server_common_maxFileSize	1MB to 2048MB	5MB	Specify the character string for the unit as well. (Unit: MB)
	Number of backup log files	server_common_maxBackupIndex	1 to 16	4	--

Legend:

--: None in particular

(a) Operation commands for authentication information

The following table describes the operation commands for authentication information.

Table 3‒25:  Operation commands for authentication information

Operation commands	Contents
csmftpaddusr (Command for registering or updating a user in the FTP inbound adapter)	Registers a user. Also, updates the password of a user that is already registered.
csmftpdelusr (Command for deleting a user in the FTP inbound adapter)	Deletes the authentication information of the registered users.
csmftplsusr (Command for displaying the users of the FTP inbound adapter)	Displays the authentication information of the registered users.

For details on the operation commands, see the description in "5. Commands (Operating and Execution Environments)" in "Service Platform Reference Guide".

Note the following when you execute the operation commands:

• Execute the operation commands when the FTP inbound adapter is in a stopped state.

• While an operation command is being executed, you cannot execute another operation command. Execute the other operation command after the operation command executed first terminates.

The execution format of operation commands is as follows:

• Registering or updating users in the FTP inbound adapter

  The execution format for registering or updating a user in the FTP inbound adapter is as follows:

  csmftpaddusr -usr <user name> -pass <password of the user>

  For details, see "csmftpaddusr (Registering and updating FTP inbound adapter users)" in "Service Platform Reference Guide".

• Deleting users in the FTP inbound adapter

  The execution format for deleting users in the FTP inbound adapter is as follows:

  csmftpdelusr -usr <user name>

  For details, see "csmftpdelusr (Deleting FTP inbound adapter users)" in "Service Platform Reference Guide".

• Displaying the users of the FTP inbound adapter

  The execution format for displaying the users of the FTP inbound adapter is as follows:

  csmftplsusr

  For details, see "csmftplsusr (Displaying the FTP inbound adapter users)" in "Service Platform Reference Guide".

(b) Permission to access the authentication information

To grant the permission to access the authentication information, before the operations start, the operator must set up the update or reference permission for the authentication information file only for the Administrator who executes the operation commands.

Note that if the access permission is set up for the Administrator, the Administrator becomes the owner of the authentication information file.