Parameters |
Description and sample
|
Mandatory |
url |
Web server URL that will process the upload. It
could be the URL of JSP, PHP, CGI, CFM, ASP ...
server-side script.
For instance, http://www.mycompany.com/upload.jsp |
yes |
mode |
This parameter allows to select transport protocol.
For HTTP upload it must be "http". |
yes |
paramfile |
This parameter matches to input file HTML form
field needed for upload. Default is "uploadfile".
Check out server-side script to know if you need
to modify this parameter. |
yes |
maxsize |
This parameter allows to limit upload size (in
bytes). For instance, to avoid end-user to send
more than 1MB file, use maxsize=1048576. Default
maxsize is -1. It means unlimited upload size. Note
that 1MB=1024*1024=1048576 bytes. |
no |
maxfiles |
This parameter allows to limit number of files
to upload. Default maxfiles is -1. It means unlimited
files.
|
no |
whitelist |
This parameter allows to filter filenames to upload
(*.doc, *.exe, *.gif, *.pdf ...). For instance,
to allow end-user to upload microsoft excel files
only, use whitelist="*.xls". For both gif and jpeg use whilelist="*.gif,*.jpg,*.jpeg". |
no |
policy |
This parameter allows to modify jClientUpload
behavior when a file to upload does not match to
whitelist or maxsize. Default value is "abort",
it means that upload won't proceed. "ignore"
value means upload will proceed and unmatching files
will be ignored.
|
no |
folderdepth |
This parameter allows to set a max depth for directories
and subdirectories uploads. Default is 0, it means
to not recurse subdirectories, -1 means unlimited.
|
no |
resume |
This parameter allows to resume broken uploads. Values could be "false", "true", "crc", "md5". Default is false. An upload is considered broken if remote file already exists and remote file size < local file size. Additional control could be added :
"crc" : Check if remote file CRC checksum equals local file CRC.
"md5" : Check if remote file MD5 hash equals local file MD5.
See FAQ to learn how it works. |
no |
overwrite |
This parameter allows to define overwrite policy for duplicate file on remote server. Values could be :
"true": Allow overwrite.
"false": Return an error message for duplicate uploads.
"indexrename": Rename duplicate upload such as file_1.zip, ...
"timerename": Rename duplicate upload such as file_mstime.zip
Default value is true. See FAQ to learn how it works. |
no |
hiddenfile |
This parameter allows to "accept" or
"deny" hidden files for upload. Default
value is "accept".
|
no |
template |
This parameter allows to rename files to upload with a given template. Value could be any combination of :
":filename:" => Selected filename.
":name:" => Selected name.
":extension:" => Selected extension.
":timestamp:" => Unix-like (epoch) timestamp.
For instance, template="test_:timestamp:_:name::extension:" |
no |
ziponfly |
This parameter allows to zip file on-fly before
uploading. It reduces bandwidth usage but it could
affect client performance because of compression
process. ".zip" extension will be appended
to uploaded filename. Default value is "false".
Learn more in FAQ.
|
no |
username |
This parameter allows to pass www-authenticate username.
|
no |
password |
This parameter allows to pass www-authenticate password. |
no |
chunksize |
This parameter allows to split file in chunks
before uploading. It is required for more than 2GB
uploads. Default is -1, it means to not split file
to upload. Server-side script that processes upload
need to recompose file from chunks. We recommend
UploadBean
and LargeUpload.jsp script that provides this feature.
|
no |
encoding |
This parameter allows to modify request encoding.
Default is ISO-8859-1. |
no |
forward |
This parameter allows to redirect to another URL
once upload is completed. You could select the target
frame through forwardtarget parameter (see below).
|
no |
forwardtarget |
When forward parameter is enabled, this parameter
allows to redirect URL to a given browser frame.
Use _blank for new window.
|
no |
forwardparameters |
When this parameter is set to true, jClientUpload
appends uploaded filenames to redirect URL. For
instance, "?filename1=foo1.txt&filename2=foo2.zip
..."
|
no |
post |
This parameter allows to send HTTP POST request
once upload is completed. See FAQ to learn how it works. |
no |
postparameters |
This parameter allows to pass filenames uploaded
in POST request above.
"true" means "filename1=foo1.txt&filename2=foo2.zip..."
"long" means "filename1=/home/usr1/foo1.txt&filename2=..." |
no |
timeout |
This advanced parameter allows to modify underlying
socket timeout in milliseconds. |
no |
socksproxyhost |
This advanced parameter allows to setup SOCKS
proxy host.
|
no |
socksproxyport |
This advanced parameter allows to setup SOCKS
proxy port. |
no |
resources |
This advanced parameter allows to select a custom
properties file including all resources (messages,
errors, menu, items, colors) to be displayed. See
internationalization section in FAQ
to learn more. |
no |
Extra
parameters |
Description and sample
|
Mandatory |
paramX and valueX
pair |
While
uploading, up to 16 additional HTTP parameters could
be passed to server-side through paramX, valueX
(with X in [1,16]). For instance if you want to
pass username=johndoe parameter with on each HTTP
upload then you have to setup param1=username and
value1=johndoe.
Note that extra parameters below are reserved. |
no. |
relativefilename |
When this parameter is set ot true, jClientUpload
sends relative pathname of file to upload. For instance,
when you upload all files and subfolders from c:\tmp\
then the file foo.txt under c:\tmp\sub1\sub2\foo.txt
will be uploaded with and additional relativefilename
HTTP parameter whose value is sub1\sub2. This parameter
is useful to allow server-side script to create
folders and subfolders structure when uploading
directories and subdirectories. Default value is
"false". Learn more in FAQ. |
no |
cookiename |
This parameter allows to pass a cookie to server-side.
For instance paramX="cookiename" and valueX="JSESSIONID". |
no |
cookievalue |
This parameter allows to pass a cookie to server-side.
For instance paramY="cookievalue" valueY="21554AED616984".
|
no |
cookiepath |
This advanced parameter allows to pass a cookie
to server-side. Default cookiepath is "/".
Do not modify it if you don't know what is a path
for a cookie. |
no |
mimetypes |
This advanced parameter allows to add/overwrite
content-types. For instance : paramX="mimetypes"
and valueX= "application/msword:.doc;application/vnd.ms-excel:.xls" |
no |
errorheader |
This parameter allows to pass custom error message from upload script to applet frond-end. See FAQ to learn more. |
no |
httpmethod |
This parameter enables HTTP PUT instead of HTTP POST multipart request through paramX="httpmethod" and valueX="put". Note that a "filename" HTTP header is included. |
no |
httpproxyhost |
This parameter allows to setup HTTP proxy host.
|
no |
httpproxyport |
This parameter allows to setup HTTP proxy port. |
no |
httpproxyusername |
This parameter allows to setup HTTP proxy username.
|
no |
httpproxypassword |
This parameter allows to setup HTTP proxy password. |
no |
Front-end
parameters |
Description and sample
|
Mandatory |
hidebar |
This parameter allows to enable or disable top
menu bar with 'open file' and 'about' items. Default
value is false. |
no |
resetprogressbar |
This parameter allows to reset progress bar(s) when upload failed or is cancelled. Default value is false. |
no |
colors and
others
resources |
See internationalization section in FAQ
to modify colors or resources (messages, errors,
menu items, fonts, image) in your custom i18n.properties
file.
|
no |