Class Parameters
The following table lists the class parameters that must be set using set methods:
| Parameter | Description |
|---|---|
| fileTransferServletURL | The URL used to contact the file transfer servlet.
For example, https://server:port/cfcc/control?view=servlet/fileTransfer. The user must set this parameter before doing a transfer. |
| transferDirection | This parameter defines that the applet is sending or receiving.
The value of SEND indicates that the applet is sending. The value of RECEIVE indicates that the applet is receiving. The parameter must be set based on the value in the file record. The default value is RECEIVE. |
| fileID | The file ID of the transfer record to be transferred.
This parameter must be the same as what is in the file record. |
| localFileName | The path and name of local file to be transferred.
This parameter is required. |
| serverFileName | The name of server file to be downloaded for a directory transfer.
Only to be used when receiving a file from a directory file record. |
| sessionID | The ID of the current session.
This parameter is required. Got the value from previous SOAP call of getSession(). |
| compression | This parameter defines whether the compression is used
The value of YES indicates that the compression is used. The value of NO indicates that the compression is not used. The default value is YES. Must set this parameter based on the value in the file record. |
| traceLevel | The level of trace to use.
This parameter is optional. |
| user id | The user ID to be used in an HTTP request requiring the BASIC authentication.
This parameter is required. |
| password | The password to be used in an HTTP request requiring the BASIC authentication.
This parameter is required. |
| restartTransfer | This parameter defines whether the transfer is to be restarted.
The value of YES indicates that transfer is to be restarted. The value of NO indicates that transfer is not to be restarted. The default value is NO. This parameter is optional. If it is set, must be based on the value in the file record. |
| checkpointInterval | The interval in seconds between checkpoints.
This parameter is required. if transfer is to be restarted. |
| synchronize | The value of
YES indicates that multiple instantiated applets are to wait to perform transfer one at a time.
The value of NO indicates that all applets are to perform the transfer at the earliest chance. The default value is YES. This parameter is optional. |