ro.fortsoft.pf4j.update

Class SimpleFileDownloader

java.lang.Object

ro.fortsoft.pf4j.update.SimpleFileDownloader

All Implemented Interfaces:

FileDownloader

public class SimpleFileDownloader
extends Object
implements FileDownloader

Downloads a file from a URL.

Author:

Decebal Suiu

Constructor Summary

Constructors

Constructor and Description
SimpleFileDownloader()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.nio.file.Path	copyLocalFile(URL fileUrl) Efficient copy of file in case of local file system
java.nio.file.Path	downloadFile(URL fileUrl) Downloads a file.
protected java.nio.file.Path	downloadFileHttp(URL fileUrl) Downloads file from HTTP or FTP
protected void	validateDownload(URL originalUrl, java.nio.file.Path downloadedFile) Succeeds if downloaded file exists and has size > 0

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleFileDownloader

public SimpleFileDownloader()

Method Detail

downloadFile

public java.nio.file.Path downloadFile(URL fileUrl)
                                throws ro.fortsoft.pf4j.PluginException,
                                       IOException

Downloads a file. If HTTP(S) or FTP, stream content, if local file:/ do a simple filesystem copy to tmp folder. Other protocols not supported.

Specified by:

downloadFile in interface FileDownloader

Parameters:

fileUrl - the URI representing the file to download

Returns:

the path of downloaded/copied file

Throws:

IOException - in case of network or IO problems

ro.fortsoft.pf4j.PluginException - in case of other problems

copyLocalFile

protected java.nio.file.Path copyLocalFile(URL fileUrl)
                                    throws IOException,
                                           ro.fortsoft.pf4j.PluginException

Efficient copy of file in case of local file system

Parameters:

fileUrl - source file

Returns:

path of target file

Throws:

IOException - if problems during copy

ro.fortsoft.pf4j.PluginException - in case of other problems

downloadFileHttp

protected java.nio.file.Path downloadFileHttp(URL fileUrl)
                                       throws IOException,
                                              ro.fortsoft.pf4j.PluginException

Downloads file from HTTP or FTP

Parameters:

fileUrl - source file

Returns:

path of downloaded file

Throws:

IOException - if IO problems

ro.fortsoft.pf4j.PluginException - if validation fails or any other problems

validateDownload

protected void validateDownload(URL originalUrl,
                    java.nio.file.Path downloadedFile)
                         throws ro.fortsoft.pf4j.PluginException

Succeeds if downloaded file exists and has size > 0

Override this method to provide your own validation rules such as content length matching or checksum checking etc

Parameters:

originalUrl - the source from which the file was downloaded

downloadedFile - the path to the downloaded file

Throws:

ro.fortsoft.pf4j.PluginException - if the validation failed