FTP Applet Documentation
This document provides information on how to configure FTP Applet.
If you have any questions regarding FTP Applet
please contact technical support.
Introduction
Target audience
General features
Version History
Deploying to a web server
Minimum System Requirements
User Interface
Connecting to a FTP server
Directory navigation
Selecting files and directories
Deleting files and directories
Renaming files and directories
Transferring files and
directories
Creating a directory
Setting transfer mode
Setting runtime properties
Connection parameters
User Interface parameters
Internationalization
parameters
Disabling the "For Evaluation Only "
text banner
Hiding applet parameters from view in HTML source
Specifying location of custom parameters file
Hiding Connect, Disconnect,
Help and About buttons
Hiding the message
window
Hiding the transfer mode
options
Hiding the local and
remote directory buttons
Hiding "hidden" files
Hiding the current remote directory
Performing automatic login
Creating a directory after
login
Excluding directories from remote directory listing
Limiting directories displayed in remote directory listing
Setting remote directory
after login
Restricting user to
remote directory
Restricting user to default login directory
Using remote file filters
Using local file filters
Encrypting username and password
applet parameters
Disabling the
ability to rename remote files
Disabling the
ability to delete remote files
Disabling the
ability to create remote directories
Disabling the ability
to download files
Disabling the ability
to upload files
Disabling the ability to modify hostname
Disabling the ability to select anonymous
connection
Disabling the ability to select passive
connection
Setting custom help file location
Redirecting to a web address upon bad login
Frequently
Asked Questions
FTP Applet is a FTP client component that runs within your web
browser. It is designed to let non-technical users exchange data
with an FTP server. Using FTP Applet you can easily transfer multiple
files and directories, delete files, rename files, create directories
and so on all within your browser and without installing any software.
FTP Applet is highly customizable to meet your development needs
and can be easily embedded in any web based application. Check out
a live demonstration
of FTP Applet.
This document is intended to serve as a guide to using and deploying
FTP Applet. If you are responsible for deployment a basic understanding
of HTML and FTP is helpful but not required.
- Clientless installation - No installation required virtually
eliminates system administration.
- Cross platform - Written in Java 1.1 FTP Applet is capable of
running within virtually any web browser equipped with a Java
runtime to include but not limited to Microsoft Internet Explorer
and Netscape Navigator.
- Firewall support - Default passive data transfer mode allows
you to easily connect to any FTP server from behind a firewall.
- Transfer mode support - Transfer files using either ASCII or
Binary transfer mode.
- Multiple file transfer - Powerful feature allows you to upload
entire directories with ease.
- Multilingual support - Customize the text elements used in FTP
Applet to match your locale.
- Look and feel support - Customize the look and feel of FTP Applet
to match your web site palette.
- Transfer status monitor - Progress dialog monitors the status
of file transfers allowing you to cancel a transfer at anytime.
- Lost connection detection - Automatically detects lost connections
due to network time-out offering you the ability to reconnect.
- No plug-ins required - Written in Java 1.1 FTP Applet runs without
any plug-in required when using Microsoft Internet Explorer for
both Windows and Mac platforms. Netscape Navigator requires installation
of Java Plug-In 1.3 or above.
- Digitally signed - The FTP Applet is digitally signed using
a code signing certificate issued by Thawte a trusted certificate
authority.
- Small footprint - The footprint of FTP Applet is very lightweight
(~100K) for quick download.
- Local and remote file filters - Limit what files users can see
in directory listings based on file extension.
- Username password encryption - Encrypt username and password
applet parameters to prevent from discovery in HTML source.
- Remote directory restrictions - Limit the directories that a
user can access.
- Create directory on connect - Automatically creates a remote
directory upon successful login to FTP server.
Apr. 14 , 2005
Enhancement - Added abilty to specify location of parameters file. See params applet parameter.
Sep. 8 , 2004
Enhancement - Added special user.desktop value that may be passed to localDir applet parameter in order to specify the local directory as the desktop.
Aug. 23, 2004
Enhancement - Added showCurrentRemoteDir applet parameter allowing you to hide the current remote directory path.
Jun. 9, 2004
Enhancement - Added ability to define runtime properties in a file, hiding applet parameters from view in HTML source.
May. 13, 2004
Enhancement - Added support to browse local volumes.
Enhancement - Added support to browse recent local remote directories.
Apr. 20, 2004
Enhancement - Added support for Mac Classic platforms (OS 9).
Enhancement - Local directory listings are now sorted alphabetically.
Enhancement - Added loginErrorUrl parameter to specify page to redirect to in the event of a login error.
Apr. 07, 2004
Enhancement - Added SOCKS proxy support.
Enhancement - Added ability to exclude remote directories from display. See remoteDirs applet parameter.
Enhancement - Added ability to limit remote directories displayed. See remoteDirs applet parameter.
Feb. 24, 2004
Enhancement - Added support for symbolic links.
Enhancement - Added ability to delete remote directories recursively.
Enhancement - Added ability to hide hidden files. See showHiddenFiles
applet parameter.
Enhancement - Added ability to restrict users to their login directory.
See restrictLoginDir applet parameter.
Oct. 15, 2003
Enhancement - Improved CPU utilization
Enhancement - Transfer Status dialog is no longer displayed when
switching between applications.
Sep. 26th, 2003
Enhancment - Added ability to communicate with VMS servers.
Enhancment - Added ability to control display of Connect, Disconnect,
Help and About buttons individually.
Enhancment - Added ability to disable host, passive and anonymous
controls in connect dialog.
Enhancment - Added ability to define custom help file location to
be used when clicking on Help button.
Initial release
- Extract the contents of ftpapplet.zip to your local hard drive
using any zip archive extraction utility. If you do not have a
zip archive extraction utility you may obtain one for free at
http://www.winzip.com
- Create a directory on your web server that can be accessed
from your web root. For example /ftpapplet
- Upload all files extracted in Step 1. to the directory you
created on the web server in Step 2. Important:
When uploading files make sure that you upload files in BINARY
mode.
- Go to test page located at the URL http://server/dir/index.html
where the server portion of the URL is replaced with the IP address
or domain name of your web server and dir portion of the URL is
replaced with the relative path of the directory you created in
Step 2. Example: http://www.jscape.com/ftpapplet/index.html
The minimum system requirements for using FTP Applet are as follows:
Operating Systems: Windows 98/2000/XP/ME or Mac OS 9.2 (with MRJ 2.2.5), Mac OS X
Browser: Internet Explorer or Netscape Navigator
Browser Java VM: Java 1.1 or above enabled
FTP server (must be accessible from your machine)
Below is a screenshot of the FTP Applet user interface. Your display
may vary slightly based on your operating system, browser used and
any customized look and feel parameters you may have provided to
the applet. A description of each component is provided below.
- Current local directory - Displays the full path of your current
local directory.
- Local directory - Displays files and child folders in your
current local directory.
- Local directory commands - Buttons for performing actions on
your local directory.
- Current remote directory - Displays the path of your current
remote directory.
- Remote directory - Displays files and child folders in your
current remote directory.
- Remote directory commands - Buttons for performing actions on
your remote directory.
- Transfer mode - Switch between ASCII and Binary transfer modes
- Message window - Displays messages sent to and received from
the FTP server.
- Upload / Download - Buttons for uploading and downloading files.
- General commands - Buttons for connecting to FTP server, disconnecting
from FTP server and accessing help and information about the applet.
To load the applet use your web browser to open the test page you
uploaded during installation. See Deploying to a web server. Upon
loading the FTP applet a dialog will be presented similar to the
one shown below asking you to confirm that you trust the certificate
used to sign the applet. You must accept this dialog for the applet
to continue loading. To avoid this dialog from being displayed each
time you connect click on the "Always trust content from JSCAPE
L.L.C." checkbox.
Once you have accepted the certificate dialog the applet will continue
loading. Depending on how FTP Applet was configured (See Configuring
FTP Applet) you may be connected automatically.
To connect manually click on the "Connect" button. The
following dialog will be displayed prompting you for hostname, port,
username and password information. If you wish to use an anonymous
connection click on the "Anonymous" checkbox to generate
an anonymous username and password. Click on the "OK"
button to establish a connection to the FTP server.
Once a connection has been established the remote directory will
be populated with the files and directories accessible on the FTP
server.
The directory listing displays your current working directory (remote
or local) along with a listing of child directories and files. Each
directory listing contains a link to it's parent directory identified
by the parent folder icon  .
The parent folder icon is always the first entry shown in a directory
listing followed by child directories and then individual files.
Each child directory is identified by the folder icon 
and files are identified by the file icon  .
To see the contents of a child directory double click on the folder
icon. Alternatively you may type in the absolute path of the directory
you want to navigate to in the current directory text field and
press your systems "Return" key.
To select a file or directory click on the item in the directory
listing using your mouse. You may select multiple items by holding
down the SHIFT key and using your systems PGUP (page up) or PGDN
(page down) keys. Alternatively you may select multiple items by
holding the CTRL key and selecting each item using your mouse.
To delete one or more items in a directory listing select those
items that you wish to delete and click on the Delete button or
press the delete key on your keyboard. A confirmation dialog will
be displayed asking you to confirm this action. Click OK to confirm
or Cancel to abort this operation.
Note: A directory that contains files and or child directories
may not be deleted.
To rename one or more files or directories select those items that
you wish to rename and click the Rename button. For each item selected
a dialog will be presented with the current name highlighted. Type
in the new name and click OK to confirm or Cancel to abort this
operation.
To transfer files and or directories select the items you wish
to transfer and check that the proper transfer mode is selected.
(See Setting transfer mode).
To upload selected items from your local directory listing click
on the upload button. To download selected items from your remote
directory listing click on the download button. When transferring
a directory the directory and its contents will be transferred recursively.
A progress dialog will be displayed indicating your transfer status.
To cancel a transfer click on the "Cancel" button. This will cancel
the current file being transferred as well as any other files or
directories that were selected for transfer.
To create a directory click on the Mkdir button. A dialog will
be displayed prompting you for the name of the directory to create.
Click the OK button to create the directory or Cancel to abort this
operation.
The transfer mode may be controlled using the by toggling between
the ASCII and Binary transfer mode options available in the user
interface. See User interface. The default transfer mode setting
is ASCII.
Alternatively the file transfer mode may be set by providing the
mode parameter when initializing the applet. (See Connection
parameters). There are two possible transfer modes (ASCII and
binary). In ASCII mode any line feeds will be converted from the
source system format to the destination system format. In Binary
mode data is transmitted without any data conversion.
In general ASCII should be used for text files and Binary should
be used for images and program executables. If you are unsure or
are transferring a directory that contains both text and binary
data then it is recommended that Binary transfer mode be used.
The appearance and behaviour of FTP Applet may be controlled using a number of runtime properties. These runtime properties may be passed into FTP Applet by providing them as applet parameters or defined in the params.txt file included with FTP Applet or in a custom parameters file that you define. See Specifying location of custom parameters file
Example applet parameter
<param name="hostname" value="ftp.myserver.com">
Example params.txt file parameter
hostname = ftp.myserver.com
For a list of runtime properties available see the sections titled Connection parameters, User Interface parameters and Internationalization parameters.
The connection parameters control properties of the FTP session
such as login and remote startup directory. Each of these parameters
may be provided to the applet in the HTML source file.
| autoConnect |
Controls if connection is established automatically after
applet is loaded using hostname, username and password applet
parameters.
Default: false
Valid values: true, false
|
| hostname |
The fully qualified hostname or IP address of the FTP server.
Default: ""
Valid values: a valid hostname or IP address
|
| 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
|
encrypt
|
If set to "true" then you must BASE64 encode the username
and password parameters. 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
Since 2.6
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
since version 2.0
|
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
|
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
|
remoteDirs
since version 2.1
|
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
since version 2.1
|
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
|
| 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.txt
file exists relative to the applet.
|
showProxy
since version 2.1 |
Enables the display of the SOCKS proxy fields in the connect dialog.
Default: false
Valid values: true, false
|
proxyHostname
since version 2.1 |
The hostname or IP address of the SOCKS proxy to connect to.
Default: ""
Valid values: a valid hostname or IP address |
proxyPort
since version 2.1 |
The port that the SOCKS proxy server is listening on.
Default: 1080
Valid values: 1-65535
|
loginErrorUrl
Since version 2.2
|
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 |
The user interface parameters control the look and feel of the
applet allowing you to define the colors used for elements such
as buttons and text fields Each of these parameters may be provided
to the applet in the HTML source file.
| showButtons |
Controls whether the Connect, Disconnect, Help and About
buttons are displayed.
Default: true
Valid values: true, false
|
showConnectButton
since version 1.1
|
Controls whether the Connect button is displayed.
Default: true
Valid values: true, false
|
showDisconnectButton
since version 1.1
|
Controls whether the Disconnect button is displayed.
Default: true
Valid values: true, false
|
showHelpButton
since version 1.1
|
Controls whether the Help button is displayed.
Default: true
Valid values: true, false
|
showAboutButton
since version 1.1
|
Controls whether the About button is displayed.
Default: true
Valid values: true, false
|
showMsgWindow
|
Controls whether the message window is displayed.
Default: true
Valid values: true, false
|
showMode
|
Controls whether the transfer mode options (ASCII, Binary)
are displayed
Default: true
Valid values: true, false
|
showDirButtons
|
Controls whether the local and remote directory buttons (Mkdir,
Rename, Delete, Refresh) are displayed.
Default: true
Valid values: true, false
|
showHiddenFiles
since version 2.0
|
Controls whether hidden files (those whose name are prefixed
with a period) are shown in remote directory.
Default: depends on FTP server
Valid value: true, false
Note: Providing value of true does not guarantee that FTP
server will return hidden files in directory listing.
|
enableRemoteRename
|
Controls whether the remote Rename button is enabled.
Default: true
Valid values: true, false
|
enableRemoteDelete
|
Controls whether the remote Delete button is enabled.
Default: true
Valid values: true, false
|
enableRemoteCreateDir
|
Controls whether the remote Mkdir button is enabled.
Default: true
Valid values: true, false
|
enableDownload
|
Controls whether the download "<<" button
is enabled.
Default: true
Valid values: true, false
|
enableUpload
|
Controls whether the upload ">>" button is
enabled.
Default: true
Valid values: true, false
|
enableHost
since version 1.1
|
Controls whether the host field in Connect dialog is enabled.
Default: true
Valid values: true, false
|
enableAnonymous
since version 1.1
|
Controls whether the anonymous option in Connect dialog is
enabled.
Default: true
Valid values: true, false
|
enablePassive
since version 1.1
|
Controls whether the passive option in Connect dialog is
enabled.
Default: true
Valid values: true, false
|
helpUrl
since version 1.1
|
Controls the location of the help file displayed when clicking
on the "Help" button.
Default: http://www.jscape.com/ftpapplet/docs.html
Valid values: Any valid web address
|
| bgColor |
Controls the background color of the applet.
Default: CCCCCC (grey)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| textColor |
Controls the text color used in the applet window.
Default: 000000 (black)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| dirColor |
Controls the background color of the local and remote directory
listings.
Default: FFFFFF (white)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| dirNodeColor |
Controls the color of the folder and file icons in the local
and remote directory listings.
Default: CCDD66 (dark yellow)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| dirTextColor |
Controls the text color used for displaying the names of
items in the local and remote directory listings.
Default: 000000 (black)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| dirWidth |
Controls the width of the local and remote current working
directory text box represented in columns. (1 column is approximately
1 character) Setting this value will automatically scale all
other components in the applet window to fit.
Default: operating system dependent
Valid values: positive integer
|
| selectedNodeColor |
Controls the color of selected nodes in the local and remote
directory listings.
Default: 0000FF (blue)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| buttonColor |
Controls the background color for all buttons including those
found in any dialogs.
Default: operating system default
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| buttonTextColor |
Controls the text color used for all button labels including
those found in any dialogs.
Default: 000000 (black)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| msgColor |
Controls the background color used in the message window.
Default: operating system dependent
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| msgTextColor |
Controls the text color used in the message window.
Default: 000000 (black)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| textFieldColor |
Controls the background color of all text fields.
Default: operating system dependent
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| textFieldTextColor |
Controls the text color used when entering data into a text
field.
Default: 000000 (black)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| dialogColor |
Controls the background color of any dialogs.
Default: operating system dependent
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| dialogTextColor |
Controls the text color used in any dialogs.
Default: 000000 (black)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| progressBarColor |
Controls the color of the progress bar used in the Transfer
status dialog.
Default: 0000FF (blue)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
| progressBarTextColor |
Controls the color of the percentage complete text label
for the progress bar used in the Transfer Status dialog.
Default: FFFFFF (white)
Valid values: any valid 6 character hexidecimal value e.g.
FF0000 (red)
|
The internationalization parameters allow you to customize the
text elements used in the applet. This can be accomplished by modifying
the text elements provided in the language.txt file. Alternatively
if you wish to provide support for multiple languages you may create
a separate properties file for each language you wish to support.
Using this method you can dynamically load the language file based
on the "language" parameter provided to the applet.
For example, if you wish to create a properties file that contains
the text elements for the French language then perform the following:
- Copy the language.txt file to a new file named language_fr.txt
- Update the text element values in language_fr.txt providing
the French equivalents.
- Add a language parameter to the applet with the value of "fr".
- Upload the language_fr.txt file to the web server directory
that contains the language.txt file.
Note: If no language parameter is provided then the default language.txt
file is used.
| connectBtn |
Controls the text displayed on the connect button.
Default: Connect
|
| disconnectBtn |
Controls the text displayed on the disconnect button.
Default: Disconnect
|
| helpBtn |
Controls the text displayed on the help button.
Default: Help
|
| aboutBtn |
Controls the text displayed on the about button.
Default: About
|
| mkDirBtn |
Controls the text displayed on the local and remote create
directory buttons.
Default: Mkdir
|
| renameBtn |
Controls the text displayed on the local and remote rename
file buttons.
Default: Rename
|
| deleteBtn |
Controls the text displayed on the local and remote delete
file buttons.
Default: Delete
|
| refreshBtn |
Controls the text displayed on the local and remote refresh
directory buttons.
Default: Refresh
|
| uploadBtn |
Controls the text displayed on the upload button.
Default: >>
|
| downloadBtn |
Controls the text displayed on the download button.
Default: <<
|
| okBtn |
Controls the text displayed on all OK buttons.
Default: OK
|
| cancelBtn |
Controls the text displayed on all Cancel buttons.
Default: Cancel
|
| localSystemLbl |
Controls the text displayed above the local working directory
text field.
Default: Local System
|
| remoteSystemLbl |
Controls the text displayed above the remote working directory
text field.
Default: Remote System
|
| deleteLocalFileTitle |
Controls the title for the Delete local file dialog.
Default: Delete local file
|
| deleteRemoteFileTitle |
Controls the title for the Delete remote file dialog.
Default: Delete remote file
|
| deleteFileLbl |
Controls the text displayed in the delete local and delete
remote file dialogs.
Default: Are you sure you want to delete the selected file(s)?
|
| createLocalDirTitle |
Controls the title for the Create local directory dialog.
Default: Create local directory
|
| createRemoteDirTitle |
Controls the title for the Create remote directory dialog.
Default: Create remote directory
|
| createDirLbl |
Controls the text displayed in the create local directory
and create remote directory dialogs.
Default: Enter directory name:
|
| renameLocalFileTitle |
Controls the title for the Rename local file dialog.
Default: Rename local file
|
| renameRemoteFileTitle |
Controls the title for the Rename remote file dialog.
Default: Rename remote file
|
| renameFileLbl |
Controls the text displayed in the rename local file and
rename remote file dialogs.
Default: Enter new name:
|
| transferStatusTitle |
Controls the title for the Transfer status dialog.
Default: Transfer status
|
| errTitle |
Controls the title for error dialogs.
Default: Error
|
| errDeleteLbl |
Controls the error text displayed when unable to delete a
file.
Default: Unable to delete one or more file(s).
|
| errRenameLbl |
Controls the error text displayed when unable to rename a
file.
Default: Unable to rename one or more file(s).
|
| errSetDirLbl |
Controls the error text displayed when unable to change to
a specified directory.
Default: Unable to access the specified directory.
|
| errCreateDir |
Controls the error text displayed when unable to create the
specified directory.
Default: Unable to create the specified directory.
|
| errConnection |
Controls the error text displayed when unable to establish
a connection with FTP server.
Default: Unable to connect to FTP server. Try again?
|
| errConnectionDrop |
Controls the error text displayed when a connection is dropped
due to timeout or other network related issues.
Default: Connection terminated. Reconnect?
|
| errLogin |
Controls the error text displayed when connection fails due
to invalid FTP username or password.
Default: Invalid FTP username or password.
|
| errDownloadLbl |
Controls the error text displayed when download fails.
Default: Unable to download one or more file(s).
|
| errUploadLbl |
Controls the error text displayed when upload fails.
Default: Unable to upload one or more file(s).
|
| errPermissions |
Controls the error text displayed when user attempts to access
a directory for which they do not have permissions as defined
by the remotedir and restrictremotedir applet parameters.
Default: Access denied.
|
| connectTitle |
Controls the title for the Connect dialog.
Default: Connect
|
| connectUsernameLbl |
Controls the username text in the Connect dialog.
Default: Username
|
| connectPasswordLbl |
Controls the password text in the Connect dialog.
Default: Password
|
| connectHostLbl |
Controls the host text in the Connect dialog.
Default: Host
|
| connectAnonymousLbl |
Controls the anonymous text in the Connect dialog.
Default: Anonymous
|
| connectPassiveLbl |
Controls the passive text in the Connect dialog.
Default: Passive
|
connectProxyHostLbl
since version 2.1
|
Controls the proxy host text in the Connect dialog.
Default: Host |
connectEnableProxyLbl
since version 2.1 |
Controls the enable SOCKS proxy checkbox text in the Connect dialog.
Default: SOCKS proxy |
To remove the For Evaluation Only text banner we ask that you purchase a registered
copy of FTP Applet Professional Edition.
For pricing on FTP Applet Professional Edition go to http://www.jscape.com/ftpapplet/pricing.html
You may define the applet runtime properties in the params.txt file. This will prevent users from seeing applet parameters when viewing HTML source.
For more information see Setting runtime properties
In some cases it may be desirable to specify a custom location for parameters other than in the default params.txt. You may do this using the params applet parameter.
For example:
<param name="params" value="gui/params/jsmith.txt">
The above code would load applet parameters from the path gui/params/jsmith.txt which is relative to the location of the applet files. You may also specify absolute URL's.
For example:
<param name="params" value="http://www.domain.com/ftpapplet/gui/params/jsmith.txt">
You may hide the Connect, Disconnect, Help and About buttons by
passing the showButtons applet parameter to the applet with a value
of false. Hiding these buttons is recommended when you are performing
automatic login based on predefined hostname, username and password
values. See Performing
automatic login
Example (using applet parameters):
<param name="showButtons" value="false">
Example (using params.txt file):
showButtons = false
You may hide the message window by passing the showMsgWindow applet
parameter to the applet with a value of false.
Example (using applet parameters):
<param name="showMsgWindow" value="false">
Example (using params.txt file):
showMsgWindow = false
You may hide the transfer mode options (ASCII, Binary) by passing
the showMode applet parameter to the applet with a value of false.
Example (using applet parameters):
<param name="showMode" value="false">
Example (using params.txt file):
showMode = false
You may hide the local and remote directory buttons (Mkdir, Rename,
Delete, Refresh) by passing the showDirButtons applet parameter
with a value of false.
Example (using applet parameters):
<param name="showDirButtons" value="false">
Example (using params.txt file):
showDirButtons = false
Since version 2.0
You may hide "hidden" files (those whose name are prefixed
with a period) in the remote directory by passing showHiddenFiles
applet parameter with a value of false.
Example (using applet parameters):
<param name="showHiddenFiles" value="false">
Example (using params.txt file):
showHiddenFiles = false
Since version 2.5
You may hide the current remote directory by passing the showCurrentRemoteDir applet parameter with a value of false.
Example (using applet parameters):
<param name="showCurrentRemoteDir" value="false">
Example (using params.txt file):
showCurrentRemoteDir = false
You may login to an FTP server automatically by passing the autoConnect
applet parameter to the applet with a value of true. You must also
provide the necessary hostname, username and password applet parameters.
Under these conditions it is recommended that you hide the Connect,
Disconnect, Help and About buttons. See Hiding
Connect, Disconnect, Help and About buttons.
Example (using applet parameters):
<param name="autoConnect" value="true">
<param name="hostname" value="ftp.myhost.com">
<param name="username" value="jsmith">
<param name="password" value="secret">
<param name="showButtons" value="false">
Example (using params.txt file):
autoConnect = true
hostname = ftp.myhost.com
username = jsmith
password = secret
showButtons = false
You may create a directory after successful login by passing the
createRemoteDir applet parameter to the applet with a value equal
to the full path of the directory to create. Note: If you are using
the remoteDir applet parameter the order of execution is that the
directory is created first and then the directory is set using the
remoteDir parameter. See Setting
remote directory after login.
Example (using applet parameters):
<param name="createRemoteDir" value="/home/user/jsmith/temp">
Example (using params.txt file):
createRemoteDir = /home/user/jsmith/temp
Since version 2.1
You may exclude one or more directories from the remote directory listing by passing the excludeRemoteDirs applet parameter to the applet with a value equal to a comma delimited list of remote directory names to exclude. The excludeRemoteDirs filter will be used each time the remote directory is refreshed and will be compared against all directories in the current remote directory.
Example (using applet parameters):
<param name="excludeRemoteDirs" value="tmp,temp,debug">
Example (using params.txt file):
excludeRemoteDirs = tmp,temp,debug
Since version 2.1
You may limit the directories displayed in the remote directory listing by passing the remoteDirs applet paramter to the applet with a value equal to a comma delimited list of remote directory names to include. The remoteDirs filter will be used each time the remote directory is refreshed and will be compared against all directories in the current remote directory.
Example (using applet parameters):
<param name="remoteDirs" value="work,tmp">
Example (using params.txt file):
remoteDirs = work,tmp
You may set the remote directory after successful login by passing
the remoteDir applet parameter to the applet with a value equal
to the full path of the directory to change to. Note: If you are
using the createRemoteDir applet parameter the order of execution
is that the directory is created first using the createRemoteDir
parameter and then the directory is set using the remoteDir parameter.
See Creating a directory
after login
Example (using applet parameters):
<param name="remoteDir" value="/home/user/jsmith/uploads">
Example (using params.txt file):
remoteDir = home/user/jsmith/uploads
You may restrict a user to a remote directory by passing the restrictRemoteDir
applet parameter to the applet with a value of true. This applet
parameter works in conjunction with the remoteDir applet parameter.
When used together the user will be restricted from accessing directories
above the directory path provided in the remoteDir applet parameter. Note: When using the restrictRemoteDir parameter the remoteDir value MUST begin with a "/".
Example (using applet parameters):
<param name="remoteDir" value="/home/user/jsmith/uploads">
<param name="restrictRemoteDir" value="true">
Example (using params.txt file):
remoteDir = /home/user/jsmith/uploads
restrictRemoteDir =true
Since version 2.0
You may restrict a user to the default login directory by passing
the restrictLoginDir applet parameter to the applet with a value
of true. The user will be restricted from accessing directories
above the default login directory.
Example (using applet parameters):
<param name="restrictLoginDir" value="true">
Example (using params.txt file):
restrictLoginDir = true
You may limit the types of files returned in a remote directory
listing by passing the remoteFilter applet parameter to the applet
with a value equal to a comma-delimited list of file extensions.
Example (using applet parameters):
<param name="remoteFilter" value=".jpg,
.gif, .png">
Example (using params.txt file):
remoteFilter = .jpg,.gif,.png
You may limit the types of files returned in a local directory
listing by passing the localFilter applet parameter to the applet
with a value equal to a comma-delimited list of file extensions.
Example (using applet parameters):
<param name="localFilter" value=".jpg,
.gif, .png">
Example (using params.txt file):
localFilter =.jpg,.gif,.png
You may encrypt the username and password parameters by passing
the encrypt applet parameter with a value of true and the BASE64
encoded versions of the username and password parameters to the
applet.
Example (using applet parameters):
<param name="encrypt" value="true>
<param name="username" value="anNtaXRo">
<param name="password" value="c2VjcmV0">
Example (using params.txt file):
encrypt = true
username = anNtaXRo
password = c2VjcmV0
To get the BASE64 encoded value for a String invoke the static getBase64Encoded
method found in the FtpApplet class.
Example:
String encodedUser = com.jscape.ftpapplet.FtpApplet.getBase64Encoded("jsmith");
You may disable the ability to rename remote files by passing the
enableRemoteRename applet parameter to the applet with a value of
false.
Example (using applet parameters):
<param name="enableRemoteRename" value="false">
Example (using params.txt file):
enableRemoteRename = false
You may disable the ability to delete remote files by passing the
enableRemoteDelete applet parameter to the applet with a value of
false.
Example (using applet parameters):
<param name="enableRemoteDelete" value="false">
Example (using params.txt file):
enableRemoteDelete = false
You may disable the ability to create remote directories by passing
the enableRemoteCreateDir applet parameter to the applet with a
value of false.
Example (using applet parameters):
<param name="enableRemoteCreateDir" value="false">
Example (using params.txt file):
enableRemoteCreateDir = false
You may disable the ability to download files by passing the enableDownload
applet parameter to the applet with a value of false.
Example (using applet parameters):
<param name="enableDownload" value="false">
Example (using params.txt file):
enableDownload = false
You may disable the ability to upload files by passing the enableUpload
applet parameter to the applet with a value of false.
Example (using applet parameters):
<param name="enableUpload" value="false">
Example (using params.txt file):
enableUpload = false
Since version 1.1
You may disable the ability to modify the hostname in the connection
dialog by passing the enableHost applet parameter to the applet
with a value of false.
Example (using applet parameters):
<param name="enableHost" value="false">
Example (using params.txt file):
enableHost = false
Since version 1.1
You may disable the ability to check / uncheck the anonymous option
in the connection dialog by passing the enableAnonymous applet parameter
to the applet with a value of false.
Example (using applet parameters):
<param name="enableAnonymous" value="false">
Example (using params.txt file):
enableAnonymous = false
Since version 1.1
You may disable the ability to check / uncheck the anonymous option
in the connection dialog by passing the enablePassive applet parameter
to the applet with a value of false.
Example (using applet parameters):
<param name="enablePassive" value="false">
Example (using params.txt file):
enablePassive = false
Since version 1.1
You may define a custom help file to be used when clicking on the
"Help" button by passing the helpUrl applet parameter
with a value of the URL to the help file contents.
Example (using applet parameters):
<param name="helpUrl" value="http://www.jscape.com/ftpapplet/docs.html">
Example (using params.txt file):
helpUrl = http://www.jscape.com/ftpapplet/docs.html
Since version 2.2
You may redirect the user to a web address in the event of a bad username or password during login.
Example (using applet parameters):
<param name="loginErrorUrl" value="http://www.jscape.com/error.html">
Example (using params.txt file):
loginErrorUrl = http://www.jscape.com/error.html
|
