Overview
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
I
J
K
L
M
N
P
R
S
T
U
Z
A
add(Config)
- Method in class javazoom.download.util.
Repository
Add a new config.
addDownload()
- Method in class javazoom.download.util.
FileInfo
Increases total download counter.
addIncompleteDownload()
- Method in class javazoom.download.util.
FileInfo
Increases total incomplete download counter.
addListener(DownloadListener)
- Method in class javazoom.download.util.
Config
B
BLACKLIST
- Static variable in class javazoom.download.util.
Keys
Characters blacklist for secured filename :
BUFFERSIZE
- Static variable in class javazoom.download.
DownloadDatabaseSource
Buffer size to read file from database inputstream and write to user's outputstream.
BUFFERSIZE
- Static variable in class javazoom.download.
DownloadFolderSource
Buffer size to read file from disk and write to user's outputstream.
BUFFERSIZE
- Static variable in class javazoom.download.
DownloadZipSource
Buffer size to read zip archive content from disk and write to user's outputstream.
Base64
- class javazoom.download.util.
Base64
.
Base64 encoding/decoding implementation as described in section (6.8.) of RFC 2045.
Base64()
- Constructor for class javazoom.download.util.
Base64
C
CUSTOMPARAMETER
- Static variable in class javazoom.download.util.
Keys
Parameter name for custom field : Default is custom
Config
- class javazoom.download.util.
Config
.
This class defines the a contract for Download4J configurations.
Config()
- Constructor for class javazoom.download.util.
Config
ConfigHandler
- class javazoom.download.util.
ConfigHandler
.
This class implements a SAX2 handler to read Download4J XML configuration file.
ConfigHandler(String)
- Constructor for class javazoom.download.util.
ConfigHandler
Contructs the Config handler.
characters(char[], int, int)
- Method in class javazoom.download.util.
MimeHandler
SAX2 - characters callback.
checkAuth(String, FileInfo)
- Method in class javazoom.download.
DownloadImpl
Checks WWW authentication for FileInfo.
checkAuth(String, String, String)
- Method in class javazoom.download.
DownloadImpl
Checks WWW authentication for input login/password.
checkFilename(String)
- Method in class javazoom.download.
DownloadServlet
Removes UnSafe characters in URL (for instance %2E%2E/ means ../) An Download4J malicious user could try to download files outside the downloadRoot.
checkLogin(String)
- Method in class javazoom.download.util.
FileInfo
Checks login for the file.
checkPassword(String)
- Method in class javazoom.download.util.
FileInfo
Checks password for the file.
close()
- Method in class javazoom.download.util.
Debug
Flushes and closes the output.
D
DATABASE
- Static variable in class javazoom.download.util.
Keys
DATEFORMAT
- Static variable in class javazoom.download.util.
Debug
Date format for traces : Default is yyyy/MM/dd HH:mm
DBPASSWORD
- Static variable in class javazoom.download.util.
Keys
DBPASSWORD key for database credentials properties : Default is password
DBUSER
- Static variable in class javazoom.download.util.
Keys
DBUSER key for database credentials properties : Default is user
DEBUG
- Static variable in class javazoom.download.util.
Debug
DEFAULTCONTENTDISPOSITION
- Static variable in class javazoom.download.util.
Keys
Default content-disposition : ""
DEFAULTCONTENTTYPE
- Static variable in class javazoom.download.util.
Keys
Default content-type for unknown extensions : application/unknown
DEFAULTFOLDERDOWNLOADROOT
- Static variable in class javazoom.download.util.
Keys
Default DownloadRoot path (WEB-INF subfolder) : downloadroot
DEFAULTIMPL
- Static variable in class javazoom.download.util.
Keys
Default DownloadSource implementation for database.
DEFAULTMIMESTYPE
- Static variable in class javazoom.download.util.
Keys
DEFAULTZIPDOWNLOADROOT
- Static variable in class javazoom.download.util.
Keys
Default ZIP archive (WEB-INF subfolder) : downloadroot.zip
DatabaseConfig
- class javazoom.download.util.
DatabaseConfig
.
This class implements a Config for Database.
DatabaseConfig()
- Constructor for class javazoom.download.util.
DatabaseConfig
Debug
- class javazoom.download.util.
Debug
.
This class implements simple trace for Download4J.
DownloadBean
- class javazoom.download.
DownloadBean
.
This class allows to read FileInfo of downloaded files.
DownloadBean()
- Constructor for class javazoom.download.
DownloadBean
DownloadDatabaseSource
- class javazoom.download.
DownloadDatabaseSource
.
This class implements a DownloadSource for database.
DownloadDatabaseSource(Properties)
- Constructor for class javazoom.download.
DownloadDatabaseSource
Contructs DownloadDatabaseSource and loads JDBC driver.
DownloadFolderSource
- class javazoom.download.
DownloadFolderSource
.
This class implements a DownloadSource for folder.
DownloadFolderSource(Properties)
- Constructor for class javazoom.download.
DownloadFolderSource
DownloadImpl
- class javazoom.download.
DownloadImpl
.
This class is the core of Download4J.
DownloadImpl(String, String)
- Constructor for class javazoom.download.
DownloadImpl
Constructs and initializes Download4J.
DownloadListener
- interface javazoom.download.
DownloadListener
.
This interface defines the DownloadListener contract.
DownloadServlet
- class javazoom.download.
DownloadServlet
.
This class implements a servlet to download files through DownloadImpl.
DownloadServlet()
- Constructor for class javazoom.download.
DownloadServlet
DownloadSource
- class javazoom.download.
DownloadSource
.
This class defines the API a DownloadSource extended class must implement.
DownloadSource(Properties)
- Constructor for class javazoom.download.
DownloadSource
DownloadZipSource
- class javazoom.download.
DownloadZipSource
.
This class implements a DownloadSource for ZIP archive.
DownloadZipSource(Properties)
- Constructor for class javazoom.download.
DownloadZipSource
decode(String)
- Static method in class javazoom.download.util.
Base64
Decodes Base64 formatted byte array or string into a char array.
decode(char[])
- Static method in class javazoom.download.util.
Base64
Decodes Base64 formatted byte array or string into a char array.
decode(char)
- Static method in class javazoom.download.util.
Base64
Decodes a Base64 character into its 6-bit value (0..63).
decodeToByteArray(String)
- Static method in class javazoom.download.util.
Base64
decodeToByteArray(char[])
- Static method in class javazoom.download.util.
Base64
destroy()
- Method in class javazoom.download.
DownloadServlet
Clean up resources.
doGet(HttpServletRequest, HttpServletResponse)
- Method in class javazoom.download.
DownloadServlet
Processes HTTP Get.
doPost(HttpServletRequest, HttpServletResponse)
- Method in class javazoom.download.
DownloadServlet
Processes HTTP Post.
download(FileInfo, OutputStream)
- Method in class javazoom.download.
DownloadDatabaseSource
Sends file to download (binary) to end-user.
download(FileInfo, OutputStream)
- Method in class javazoom.download.
DownloadFolderSource
Sends file to download (binary) to end-user.
download(FileInfo, OutputStream, Config)
- Method in class javazoom.download.
DownloadImpl
Downloads file (in the incoming thread) and sends binary data to user's outputstream.
download(FileInfo, OutputStream)
- Method in class javazoom.download.
DownloadSource
Sends file to download (binary) to end-user.
download(FileInfo, OutputStream)
- Method in class javazoom.download.
DownloadZipSource
Sends file to download (binary) to end-user.
E
encode(String)
- Method in class javazoom.download.
DownloadBean
Encode URL.
encode(String)
- Static method in class javazoom.download.util.
Base64
Encode string to Base64 formatted char array.
encode(char[])
- Static method in class javazoom.download.util.
Base64
Encode char array to Base64 formatted char array.
encode(int)
- Static method in class javazoom.download.util.
Base64
Encodes a 6-bit value (0..63) into a Base64 character.
endDocument()
- Method in class javazoom.download.util.
ConfigHandler
SAX2 - endDocument.
endDocument()
- Method in class javazoom.download.util.
MimeHandler
SAX2 - endDocument callback.
endElement(String, String, String)
- Method in class javazoom.download.util.
ConfigHandler
SAX2 - endElement
endElement(String, String, String)
- Method in class javazoom.download.util.
MimeHandler
SAX2 - endElement callback.
F
FILENAMEPARAMETER
- Static variable in class javazoom.download.util.
Keys
Parameter name for download : Default is name
FOLDER
- Static variable in class javazoom.download.util.
Keys
FileInfo
- class javazoom.download.util.
FileInfo
.
This class provides information about downloaded and downloadable files.
FileInfo(String, String, String, String, String, boolean, int, String, String, String)
- Constructor for class javazoom.download.util.
FileInfo
Construts a FileInfo.
FolderConfig
- class javazoom.download.util.
FolderConfig
.
This class implements a Config for Folder.
FolderConfig()
- Constructor for class javazoom.download.util.
FolderConfig
G
get(String)
- Method in class javazoom.download.util.
Repository
Return a Config instance given an id.
getAll()
- Method in class javazoom.download.util.
Repository
Return all Config from the repository such as "id1", Config1, ...
getConfig()
- Method in class javazoom.download.
DownloadBean
Return underlying Config.
getConfig2()
- Method in class javazoom.download.util.
ConfigHandler
Deprecated.
return last Config read from XML.
getConfigPath()
- Method in class javazoom.download.util.
ConfigHandler
Returns path to XML configuration file.
getContentDisposition()
- Method in class javazoom.download.util.
FileInfo
Gets Content-Disposition for the file
getContentDispositionHeader()
- Method in class javazoom.download.util.
FileInfo
Gets Content-Disposition HTTP header.
getContentType()
- Method in class javazoom.download.util.
FileInfo
Gets Content-Type for the file
getCredentials()
- Method in class javazoom.download.util.
DatabaseConfig
Gets credentials to connect the database.
getCustomField()
- Method in class javazoom.download.util.
FileInfo
Gets custom field passed from the download URL or the XML file.
getDataLength(FileInfo)
- Method in class javazoom.download.
DownloadDatabaseSource
Returns file length or -1 if file is not found or not readable.
getDataLength(FileInfo)
- Method in class javazoom.download.
DownloadFolderSource
Returns file length or -1 if file is not found or not readable.
getDataLength(FileInfo, Config)
- Method in class javazoom.download.
DownloadImpl
Checks if data available are for download.
getDataLength(FileInfo)
- Method in class javazoom.download.
DownloadSource
Returns file length or -1 if file is not found or not readable.
getDataLength(FileInfo)
- Method in class javazoom.download.
DownloadZipSource
Returns file length or -1 if file is not found or not readable.
getDefaultMimes()
- Method in class javazoom.download.util.
Repository
Return default mimes types loaded from javazoom/download/resource/
getDescription()
- Method in class javazoom.download.util.
Config
Return description.
getDownloadLink(String)
- Method in class javazoom.download.
DownloadBean
Return encoded URL for download link.
getDownloadSource()
- Method in class javazoom.download.util.
Config
Return download source instance.
getDriver()
- Method in class javazoom.download.util.
DatabaseConfig
Returns database driver classname.
getExtension(String)
- Static method in class javazoom.download.util.
FileInfo
Gets file extension for any filename.
getFileInfo(String)
- Method in class javazoom.download.
DownloadBean
Returns FileInfo instance for filename.
getFilename()
- Method in class javazoom.download.util.
FileInfo
Gets full filename (including relative path for subfolders).
getFilenameExtension()
- Method in class javazoom.download.util.
FileInfo
Gets file extension without ".".
getFiles()
- Method in class javazoom.download.util.
Config
Returns Download4J FileInfo.
getFirstId()
- Method in class javazoom.download.util.
Repository
Return first Config id.
getId()
- Method in class javazoom.download.util.
Config
Return id.
getImplementation()
- Method in class javazoom.download.util.
DatabaseConfig
Returns DownloadSource implementation.
getInstance()
- Static method in class javazoom.download.util.
Debug
Gets the Debug instance for traces.
getInstance()
- Static method in class javazoom.download.util.
Repository
Return instance of Repository (singleton).
getListeners()
- Method in class javazoom.download.util.
Config
getLogFolder()
- Method in class javazoom.download.util.
ConfigHandler
Gets log folder (Default is null)
getLogLevel()
- Method in class javazoom.download.util.
ConfigHandler
Gets log level (Default is 0).
getLogLevel()
- Method in class javazoom.download.util.
Debug
Gets level of traces.
getLogin()
- Method in class javazoom.download.util.
FileInfo
Gets login that protects file.
getMaxDownload(String)
- Method in class javazoom.download.
DownloadBean
Returns max number of downloads for filename.
getMaxDownload()
- Method in class javazoom.download.util.
FileInfo
Gets maximum download hits allowed for the file.
getMeta()
- Method in class javazoom.download.
DownloadSource
getMimes()
- Method in class javazoom.download.util.
Config
Return mimes types.
getMimes()
- Method in class javazoom.download.util.
MimeHandler
Returns Mime types.
getMimes(String)
- Method in class javazoom.download.util.
Repository
Load mimes types from an XML file.
getPassword()
- Method in class javazoom.download.util.
FileInfo
Gets password that protects file.
getPath()
- Method in class javazoom.download.util.
FileInfo
Gets path to filename.
getPath()
- Method in class javazoom.download.util.
FolderConfig
Return folder's path.
getPath()
- Method in class javazoom.download.util.
ZipConfig
Returns ZIP archive path.
getProperties()
- Method in class javazoom.download.util.
Config
Returns Download4J properties.
getRelativeFilename()
- Method in class javazoom.download.util.
FileInfo
Return relative filename without subfolders (if any).
getRelativePath()
- Method in class javazoom.download.util.
FileInfo
Return relative path for subfolders (if any).
getRepository()
- Method in class javazoom.download.util.
ConfigHandler
Return repository instance.
getSchema()
- Method in class javazoom.download.util.
DatabaseConfig
Returns database schema (table name + column name) in Properties.
getSize()
- Method in class javazoom.download.util.
FileInfo
getTotalDownload(String)
- Method in class javazoom.download.
DownloadBean
Returns download hits for filename.
getTotalDownload()
- Method in class javazoom.download.util.
FileInfo
Gets total download hits for the file.
getTotalIncompleteDownload(String)
- Method in class javazoom.download.
DownloadBean
Returns number of incomplete downloads for filename.
getTotalIncompleteDownload()
- Method in class javazoom.download.util.
FileInfo
Gets total incomplete download hits (for instance stopped by end-user) for the file.
getUrl()
- Method in class javazoom.download.util.
DatabaseConfig
Gets database URL for connection.
getUrlMapping()
- Method in class javazoom.download.util.
FileInfo
Gets URL mapping.
getVirtualPath()
- Method in class javazoom.download.
DownloadBean
Return virtual path.
getXmlConf()
- Method in class javazoom.download.util.
Repository
Return path to xml files of Download4J.
I
IDPARAMETER
- Static variable in class javazoom.download.util.
Keys
Parameter id for download : Default is id
INFO
- Static variable in class javazoom.download.util.
Debug
init()
- Method in class javazoom.download.
DownloadServlet
Initializes DownloadServlet.
isZipEnabled()
- Method in class javazoom.download.util.
FileInfo
Gets zip on-the-fly state.
J
javazoom.download
- package javazoom.download
javazoom.download.util
- package javazoom.download.util
K
Keys
- class javazoom.download.util.
Keys
.
This class defines all consts.
Keys()
- Constructor for class javazoom.download.util.
Keys
L
LOGFILEDATEFORMAT
- Static variable in class javazoom.download.util.
Keys
Default log file date format : -yyyy-MM-dd_HH-mm
LOGFILEEXTENSION
- Static variable in class javazoom.download.util.
Keys
Default log file extension : .log
LOGFILENAME
- Static variable in class javazoom.download.util.
Keys
Default log file prefix : download4j
listFiles(Config, boolean)
- Method in class javazoom.download.
DownloadDatabaseSource
List files in folder.
listFiles(Config, boolean)
- Method in class javazoom.download.
DownloadFolderSource
List files in folder.
listFiles(Config, boolean)
- Method in class javazoom.download.
DownloadSource
List files of underlying config.
listFiles(Config, boolean)
- Method in class javazoom.download.
DownloadZipSource
List files in folder.
listFiles()
- Method in class javazoom.download.util.
Config
Return all files available in the Config without subfolders.
listFiles(boolean)
- Method in class javazoom.download.util.
Config
List all files available in the Config.
listFiles(boolean)
- Method in class javazoom.download.util.
DatabaseConfig
List files.
listFiles(boolean)
- Method in class javazoom.download.util.
FolderConfig
List files.
listFiles(boolean)
- Method in class javazoom.download.util.
ZipConfig
M
MimeHandler
- class javazoom.download.util.
MimeHandler
.
This class implements a SAX2 handler to read Download4J XML mime types.
MimeHandler()
- Constructor for class javazoom.download.util.
MimeHandler
Constructs a MimeHandler.
N
notifyCounters(FileInfo, boolean)
- Method in class javazoom.download.util.
Config
Notifies counter for the file.
notifyListeners()
- Method in class javazoom.download.util.
Config
P
PANIC
- Static variable in class javazoom.download.util.
Debug
performDownload(HttpServletRequest, HttpServletResponse)
- Method in class javazoom.download.
DownloadServlet
Processes the download.
process(String, Properties, HttpServletResponse)
- Method in class javazoom.download.
DownloadImpl
Runs download in the incoming thread.
R
REALM
- Static variable in class javazoom.download.util.
Keys
HTTP Realm name for Download4J, Default is Download4J Realm
Repository
- class javazoom.download.util.
Repository
.
This class manage a repository of Config instances identified by id.
recurseList(File, Vector, boolean)
- Method in class javazoom.download.
DownloadFolderSource
Find all files in a given folder and subfolders.
registerFolderConfig(String, String, String, Properties)
- Method in class javazoom.download.
DownloadBean
Register dynamically (without modifying folder.xml) a new FolderConfig.
remove(String)
- Method in class javazoom.download.util.
Repository
Remove a Config from the repository (given an id).
removeListener(DownloadListener)
- Method in class javazoom.download.util.
Config
resetTotalDownload()
- Method in class javazoom.download.util.
FileInfo
Cleans total downloads counter.
resetTotalIncompleteDownload()
- Method in class javazoom.download.util.
FileInfo
Cleans total incomplete downloads counter.
S
SECUREFILENAME
- Static variable in class javazoom.download.util.
Keys
Enables/Disables filename security : Default is true
setConfig(Config)
- Method in class javazoom.download.
DownloadBean
Set Config that applies to the downloadbean instance.
setContentDisposition(String)
- Method in class javazoom.download.util.
FileInfo
Set Content-Disposition field.
setContentDispositionHeader(String)
- Method in class javazoom.download.util.
FileInfo
Set Content-Disposition HTTP header field.
setContentType(String)
- Method in class javazoom.download.util.
FileInfo
Set Content-Type field.
setCredentials(Properties)
- Method in class javazoom.download.util.
DatabaseConfig
Sets credentials to connect the database.
setDescription(String)
- Method in class javazoom.download.util.
Config
Set config description.
setDownloadSource(DownloadSource)
- Method in class javazoom.download.util.
Config
Set download source instance.
setDriver(String)
- Method in class javazoom.download.util.
DatabaseConfig
Sets database driver classname.
setEncodeUrl(boolean)
- Method in class javazoom.download.
DownloadBean
Enable/Disable URL encoding for download link.
setFileWriter(String)
- Method in class javazoom.download.util.
Debug
Sets fileERR as messages output
setFiles(Vector)
- Method in class javazoom.download.util.
Config
Sets Download4J FileInfo.
setId(String)
- Method in class javazoom.download.util.
Config
Set config id.
setImplementation(String)
- Method in class javazoom.download.util.
DatabaseConfig
Sets DownloadSource implementation for database.
setLbcs(char[])
- Static method in class javazoom.download.util.
Base64
set the line break chracters for use in encoding output.
setLogLevel(int)
- Method in class javazoom.download.util.
Debug
Sets level of traces. 0 : PANIC
1 : PANIC + INFO
2 : PANIC + INFO + DEBUG
setMimes(Properties)
- Method in class javazoom.download.util.
Config
Set mimes types.
setPath(String)
- Method in class javazoom.download.util.
FolderConfig
Sets folder's path.
setPath(String)
- Method in class javazoom.download.util.
ZipConfig
Sets path to ZIP archive.
setProperties(Properties)
- Method in class javazoom.download.util.
Config
Sets Download4J properties.
setSchema(Properties)
- Method in class javazoom.download.util.
DatabaseConfig
Sets database schema.
setSize(long)
- Method in class javazoom.download.util.
FileInfo
setStandardLink(boolean)
- Method in class javazoom.download.
DownloadBean
Enable standard link.
setStdErrWriter()
- Method in class javazoom.download.util.
Debug
Sets Standard ERR as messages output.
setStdOutWriter()
- Method in class javazoom.download.util.
Debug
Sets Standard OUT as messages output.
setUrl(String)
- Method in class javazoom.download.util.
DatabaseConfig
Sets database URL for connection.
setVirtualPath(String)
- Method in class javazoom.download.
DownloadBean
Set Virtual Path.
setXmlConf(String)
- Method in class javazoom.download.util.
Repository
Set path to xml files of Download4J.
startDocument()
- Method in class javazoom.download.util.
ConfigHandler
SAX2 - startDocument.
startDocument()
- Method in class javazoom.download.util.
MimeHandler
SAX2 - startDocument callback.
startElement(String, String, String, Attributes)
- Method in class javazoom.download.util.
ConfigHandler
SAX2 - startElement.
startElement(String, String, String, Attributes)
- Method in class javazoom.download.util.
MimeHandler
SAX2 - startElement callback.
T
trace(int, String)
- Method in class javazoom.download.util.
Debug
Traces message to output.
translationTable
- Static variable in class javazoom.download.util.
Base64
the Base64 translation table; does the same as 'encode()', but this way decoding should be faster.
U
UNKNOWN
- Static variable in class javazoom.download.util.
Keys
update(Config)
- Method in interface javazoom.download.
DownloadListener
Updates Config (Vector of FileInfo, ID, Description, Downloaded files state ...)
updateDownload(int)
- Method in class javazoom.download.util.
FileInfo
Updates total download counter.
updateFilename(String)
- Method in interface javazoom.download.
DownloadListener
Updates filename.
updateIncompleteDownload(int)
- Method in class javazoom.download.util.
FileInfo
Updates total incomplete download counter.
Z
ZIP
- Static variable in class javazoom.download.util.
Keys
ZIPCONTENTTYPE
- Static variable in class javazoom.download.util.
Keys
Default content-type for zip files : application/zip
ZipConfig
- class javazoom.download.util.
ZipConfig
.
This class implements a Config for ZIP archive.
ZipConfig()
- Constructor for class javazoom.download.util.
ZipConfig
A
B
C
D
E
F
G
I
J
K
L
M
N
P
R
S
T
U
Z
Overview
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes