Connection parameters

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 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 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: 60000*5 (5 minutes)

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),  WebDAV, Amazon S3 (HTTP), Amazon S3 (HTTPS) and AFTP to use by default when using autoConnect parameter or when displaying Connect dialog.

Default: ftp

Valid values: ftp, sftp, ftps, ftps-implicit, webdav, s3-http, s3-https, aftp

ccc

If the connectionType is ftps and this property is enabled then the CCC command will be issued after authentication succeeds, clearing 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 plain FTP or encrypted using SFTP/SSH.

If set to "true" then you must BASE64 encode the username and password parameters. The applet will then decode these values prior to establishing a connection to the 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.  For Windows and Mac clients you may optionally specify the value "user.desktop". This will specify the users local directory as their desktop directory.

Default: system root directory

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

localFilter

A regular expression file filters to apply to the local directory.  Files matching filter will be excluded from local directory listing.  You may use the invertLocalFilter parameter to invert this regular expression i.e. display only files matching filter.

Default: ""

Valid values: a regular expression. e.g. ".*\.gif"

remoteDir

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

Default: ""

Valid values: a valid remote directory path

remoteFilter

A regular expression file filters to apply to the remote directory.   Files matching filter will be excluded from remote directory listing.  You may use the invertRemoteFilter parameter to invert this regular expression i.e. display only files matching filter.

Default: ""

Valid values: a regular expression. E.g. ".*\.gif"

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: true

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: true

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

maxTransferThreads

Specifies the maximum number of transfer threads to use in case of multiple file transfers.

Default: 3

Valid values: any integer value greater than zero.

enableRemoteDirectoryCache

Specifies whether to use remote directory caching to improve applet performance.

Default: false

Valid values: true, false

maxReconnectAttempts

Specify the maximum number reconnect attempts in case the applet loses connection to the server. e.g. a timeout.

Default: 3

Valid values: any positive integer.

reconnectAttemptInterval

Specify the wait interval between successive reconnect attempts.

Default: 3

Valid values: any positive integer.

sftpReceiveBufferSize

Controls SFTP receive TCP buffer size.

Default: 262144 bytes.

sftpSendBufferSize

Controls SFTP send TCP buffer size.

Default: 262144 bytes.

sftpUploadBlockSize

Controls SFTP upload block size.

Default: 262144 bytes.

sftpDownloadBlockSize

Controls SFTP download block size.

Default: 262144 bytes.

webdavBlockTransferSize

Controls WebDAV transfer block size.

Default: 262144 bytes.

showAftpSecurityTypeOptions

Controls whether to display AFTP security type options.

Default: true

enableAftpSecurityTypeOptions

Controls whether to enable AFTP security type options.

Default: true

headerAlign

Controls horizontal alignment of local header & remote header labels.

Default: left

Valid values: 1) left 2) center 3) right

valueAlign

Controls horizontal alignment of local & remote values

Default: left

Valid values: 1) left 2) center 3) right

showUploadButton

Controls whether to display upload button.

Default: true

showDownloadButton

Controls whether to display download button.

Default: true

iconSize

Controls size of icons to used on the main applet interface.

Default: 16x16

Valid values: 1) 16x16 2) 24x24

dateTimeFormat

Controls the date format of the local and remote files.

Default: MMM dd yyyy HH:mm aa

Valid values: Any value as prescribed by Java, see this link.

theme

Controls the applet theme

Default: default

Valid values: default, system, acid, bedouin, glass

autoDetectIpv6

Controls whether to autodetect Ipv6 addresses.

Default: true

Valid values: true, false

useEPRT

Controls whether to use FTP EPRT command.

Default: false

Valid values: true, false

useEPSV

Controls whether to use FTP EPSV command.

Default: false

Valid values: true, false

debugAreaHeight

Controls the height of the debug area on the applet GUI.

Default: 175 pixels.

Valid values: An positive integer

paneBorderColor

Controls the color of the rounded panel

Default: Light gray color as determined by Java Runtime Environment.

Valid values: HTML rgb color values. e.g. values :

#FF0000

#00FF00

#0000FF

transferMessageWindowWidth

Controls the width of the transfer panel window.

Default: 600 pixels.

Valid values: A positive integer, Recommended values are 500 or above.

persistLocalDirValue

Controls whether the local directory value will be reset after disconnect.

Default: false

Valid values: true, false

clearDebugAreaOnDisconnect

Controls whether to clear the file transfers in the debug area after disconnect.

Default: true

Valid values: true, false

showRemoteConnectionStatus

Controls whether to show connection status message on the remote pane.

Consult the following two values in language.txt to control the actual text that is displayed :

remoteSystemLblConnectedStatus = (Connected)

remoteSystemLblDisconnectedStatus = (Not Connected)

Default: false

Valid values: true, false

invertLocalFilter

Controls whether to negate the local regex expression filter

Default: false

Valid values: true, false

invertRemoteFilter

Controls whether to negate the remote regex expression filter

Default: false

Valid values: true, false

useMlsdFtpDirectoryListing

Controls whether to perform machine listing using the MLSD command for FTP and FTPS protocols.

Default value : true

Valid values: true, false

showMenu

Controls whether to show applet frame menu.

Default: false

Valid values: true, false

siteUrlCookie

A comma delimited list of cookie key pair values.

Default: N/A

Valid value : key0=value0;key1=value1,key2=value=2

siteUrl

A XML file url to load the site data from.

Default: N/A

Valid value : a valid URL e.g. http://www.ftpserver.com/site.xml

minAftpCompressionSize

Minimum filesize for performing AFTP compression.

Default: 10485760 bytes

Valid value : A valid integer value

excludeAftpFilesWithExtension

A comma delimited list of file extensions. This list is excluded from AFTP compression.

Default:  .bz2,.F,.gz,.lz,.lzma,.lzo,.rz,.sfark,.xz,.z,.Z,.infl,.7z,.s7z,.ace,.afa,.alz,.apk,.arc,.arj,.ba,.bh,.cab,.cfs,.cpt,.dar,.dd,.dgc,.dmg,.gca,.ha,.hki

Valid value : A comma delimited list of extensions.

showPGPOptions

Controls whether the PGP tab is displayed in the Connection Panel.

Default: true

Valid values: true, false

enablePGPDecryption

Enable PGP decryption

Default: false

Valid values: true, false

deleteSourceAfterPGPDecryption

Delete source file after PGP decryption has concluded.

Default: false

Valid values: true, false

pgpPrivateKeyPassword

The PGP private key password to use when decrypting PGP encrypted files.

Default: N/A

Valid value : A valid String expression.

pgpPrivateKeyPath

The PGP private key to use when decrypting PGP encrypted files.

Default: N/A

Valid value : An absolute path pointing to the public key.

pgpPublicKeyPath

The PGP public key to use when decrypting PGP encrypted files.

Default: N/A

Valid value : An absolute path pointing to the public key.

pgpExtension

The PGP filename regex to use when decrypting PGP encrypted files.

Default: .*\.(pgp|gpg)

Valid values: A valid Java regular expression.

preferIpv4Stack

Controls whether JVM gives preference to IPv4 stack trace. This is required for Java 1.7 and Windows systems.

Default = true

showOptionsPanel

Controls whether the Options panel is displayed when managing sites using site manager.

Default: true

Valid values: true, false

enableClientCertAuth

Controls whether client certificate authentication is used in FTPS and WebDAVS protocols.

Default: false

Valid values: true, false

clientCertFilePath

The absolute path of private key file used in client certificate authentication for FTPS and WebDAVS protocols.

Default: N/A

Valid values: A valid absolute file path

clientCertPassword

The password used to decrypt a password protected private key for use in client certificate authentication in FTPS and WebDAVS protocols.

Default: N/A

Valid values: The password used to protect private key