Class Parameters

Before transferring a file by using a Java applet, you must set the class parameters using set methods.

The following table lists the class parameters:

Parameter Description
fileTransferServletURL The URL used to contact the file transfer servlet, for example, https://server:port/cfcc/control?view=servlet/fileTransfer.

This parameter is required.

transferDirection This parameter should be set to SEND if the applet is used to sending a file, and should be set to RECEIVE if the applet is used to receive a file. The default value is RECEIVE.
Note: This parameter must be set based on the value in the file record.
fileID This parameter represents the transfer record to be transferred.
Note: This parameter must be set based on the value in the file record.
localFileName The path and name of the local file to be transferred.

This parameter is required.

serverFileName The name of server file to be downloaded for a directory transfer.

This parameter is only used when receiving a file from a directory file record.

Note: For directory download, you must set this parameter.
sessionID The ID of the current session.

This parameter is required.

Note: you can get the value from previous SOAP call of getSession().
compression This parameter defines whether to compress the file being transferred.
The valid values are as follows:
  • YES: compress the file being transferred. This is the default value.
  • NO: do not compress the file being transferred.
traceLevel This parameter defines the level of trace to use.

This parameter is optional.

user id The user ID to be used in an HTTP request requiring BASIC authentication.

This parameter is a required.

password The password to be used in an HTTP request requiring BASIC authentication.

This is a required parameter.

restartTransfer This parameter defines whether to restart the transfer.
The valid values are as follows:
  • YES: restart the transfer.
  • NO: do not restart the transfer.

This parameter is optional.

Note: RestartTransfer=Yes will be ignored unless the transfer definition is defined with ChkptRestartFlag=Yes.
checkpointInterval This parameter defines the number of seconds between checkpoints.
Note: You must also set this parameter when the restartTransfer parameter is set.
synchronize This parameter defines the synchronization level if you initiate multiple transfers at the same time.
The valid values are as follows:
  • Yes: the transfers will execute one at a time.
  • No: the transfers will execute concurrently.