Parameter

Description

autoConnect

Controls if connection is established automatically after applet is loaded using hostname, username, password and connectionType applet parameters.

Default: false

Valid values: true, false

hostname

The fully qualified hostname or IP address of the FTP server.  If connectionType is webdav then this should be the URL of the WebDav server.

Default: ""

Valid values: a valid hostname, IP address or WebDAV URL

port

The remote port that the FTP server is listening on.

Default: 21

Valid values: 1-65535

passive

Enables / disables passive FTP data transfer.

Default: true

Valid values: true, false

timeout

The amount of time measured in milliseconds to wait for a FTP server response. Exceeding timeout will result in the display of an error dialog indicating that the connection has been lost and allowing you to reconnect.

Default: 20000 (20 seconds)

Valid values: any positive integer

username

The username that you use to login to the FTP server. For an anonymous connection this is the username anonymous.

Default: ""

Valid values: a valid username

password

The password that you use to login to the FTP server. For an anonymous connection FTP servers generally request your email address.

Default: ""

Valid values: a valid password

connectionType

The type of connection FTP, SFTP (FTP over SSH), FTPS (FTP over SSL)  or WebDAV to use by default when using autoConnect parameter or when displaying Connect dialog.

Default: ftp

Valid values: ftp, sftp, ftps, ftps-implicit, webdav

ccc

If the connectionType is ftps and this property is enabled then the CCC command will be issued after authentication succeeds, clearning the control channel.

Default: false

Valid values: true, false

cccClose

If the connectionType is ftps and the ccc property is enabled then the SSL connection will be closed based on this setting. 

Default: true

Valid values: true, false

encrypt

This option should be used if the username and password applet parameters are encoded to prevent from being displayed in the HTML source. This is not to be confused with the connectionType applet parameter which determines if the connection is established using standard FTP or encrypted using SFTP/SSH.

If set to "true" then you must BASE64 encode the username and password parameters. Secure FTP Applet will then decode these values prior to establishing a connection to the FTP server.

Default: false

Valid values: true, false

mode

The transfer mode to be used after a connection to the FTP server has been established.

Default: ascii

Valid values: ascii, binary

localDir

The local directory to change to upon startup.

Default: system root directory

Valid values: a valid local path e.g. c:\documents

For Windows and Mac clients you may optionally specify the value "user.desktop". This will specify the users local directory as their desktop directory.

localFilter

The file extension filters to apply to the local directory. Multiple extensions may be provided with each file extension separated by a comma.

Default: ""

Valid values: a comma delimited list of file extensions. E.g. ".gif, .jpg"

remoteDir

The remote directory to change to upon successful login to the FTP server.

Default: ""

Valid values: a valid remote directory path

remoteFilter

The file extension filters to apply to the remote directory. Multiple extensions may be provided with each file extension separated by a comma.

Default: ""

Valid values: a comma delimited list of file extensions. E.g. ".gif, .jpg"

restrictRemoteDir

If set to "true" then the user may only see files at and below the remote directory specified in the remoteDir parameter. If user attempts to access any directories above the level of the remotedir parameter then an error dialog will be displayed. Note: remoteDir MUST begin with a forward slash "/".

Default: false

Valid values: true, false

restrictLoginDir

If set to "true" then the user may only see files at and below the directory the user is placed in by default after login. If user attempts to access any directories above the level of the default login directory then an error dialog will be displayed.

Default: false

Valid values: true, false

remoteDirs

Comma delimited list of remote directories to be included remote directory listing, all other directories are excluded. This filter is applied to the remote directory listing each time it is refreshed.

Default: ""

Valid values: a comma delimited list of named remote directories

excludeRemoteDirs

Comma delimited list of remote directories to be excluded from remote directory listing, all other directories are included. This filter is applied to the remote directory listing each time it is refreshed.

Default: ""

Valid values: a comma delimited list of named remote directories

createRemoteDir

The full path of the directory to create upon establishing a connection with the FTP server. This directory will be created prior to changing to the remote directory provided in the remoteDir applet parameter.

Default: ""

Valid values: a valid remote directory path

language

The language properties file to use when initializing the applet.

Default: ""

Valid values: a valid language code represented by a language properties file. E.g. "fr" where language_fr.properties file exists relative to the applet.

showProxy

Enables the display of the SOCKS proxy fields in the connect dialog.

Default: false

Valid values: true, false

proxyType

The type of proxy to connect with.

Default: SOCKS5

Valid values: HTTP or SOCKS5

proxyHostname

The hostname or IP address of the proxy to connect to.

Default: ""

Valid values: a valid hostname or IP address

proxyPort

The port that the proxy server is listening on.

Default: 1080

Valid values: 1-65535

proxyUser

The username of proxy server.

Default: ""

Valid values: a valid proxy username

proxyPassword

The password of proxy server.

Default: ""

Valid values: a valid proxy password

loginErrorUrl

The web address to redirect user to in the event that a bad username or password is submitted during login.

Default: ""

Valid values: a valid web address e.g. http://www.jscape.com

retryLimit

The number of times to retry transferring a file if an error occurs.

Default: 0

Valid values: Any numeric value greater than or equal to 0.

performChecksum

Whether or not to perform a checksum after transferring files using FTP/S protocols.  The XCRC command must be supported by the FTP server.

Default: false

Valid values: true, false

tempExtension

The temporary extension to use when uploading files.  After file has completed upload file will be renamed to original filename.  For example, when using tempExtension of .tmp the source file test.txt would be uploaded as test.txt.tmp prior to being renamed to test.txt once upload is complete.

Default: ""

Valid values: Any valid string extension.

natAddress

NAT address to use when communicating using FTP/S protocols.

Default: ""

Valid values: a valid IP address

enableCompression

Enables / disables ZIP compression when performing file transfers and directory listings.  Server must support MODE Z command.

Default: false

Valid values: true, false

showSftpAuth

Enables / disables whether SFTP public-key authentication options are displayed.

Default: false

Valid values: true, false

useSftpPassword

Enables / disables whether SFTP private key is password protected when using public-key authentication.

Default: true

Valid values: true, false

useSftpPrivateKey

Enables / disables whether public-key authentication should be used when connecting to SFTP Server.

Default: false

Valid values: true, false

sftpPrivateKey

Defines path for private key when using public-key authentication with SFTP server.

Default: ""

Valid values: a valid file path.

sftpPrivatePassPhrase

Defines passphrase for private key when using public-key authentication with SFTP server.

Default: ""

Valid values: a valid passphrase

transferEncoding

Defines character encoding to be used for filenames.

Default: null

Valid values: UTF8

useExtendedDirectoryListing

Enables / disables whether LIST -a command is used when retrieving directory listing from server or whether standard LIST command is used.

Default: false

Valid values: true, false