com.isti.util

Class FileDownloader

java.lang.Object

java.lang.Thread

com.isti.util.IstiThread

com.isti.util.IstiNotifyThread

com.isti.util.FileDownloader

All Implemented Interfaces:

FileUtilsConst, TimeConstants, java.lang.Runnable

public class FileDownloader
extends IstiNotifyThread
implements FileUtilsConst

Class FileDownloader downloads a file with optional dialogs.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class com.isti.util.IstiThread

DEFAULT_TERMINATE_WAIT_TIME, terminateFlag

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface com.isti.util.FileUtilsConst

PATH_SEPARATOR, PERLINE_DEFAULT, STREAM_TRANSFER_BUFFER_SIZE

Fields inherited from interface com.isti.util.TimeConstants

HOURS_PER_DAY, MINUTES_PER_DAY, MINUTES_PER_HOUR, MS_PER_DAY, MS_PER_HOUR, MS_PER_MINUTE, MS_PER_SECOND, SECONDS_PER_DAY, SECONDS_PER_MINUTE

Constructor Summary

Constructors

Constructor and Description
FileDownloader(java.util.List<java.net.URL> urlList, java.io.File outputDir, CallBackStringParam callBackObj, IstiDialogInterface dialogObj, ProgressIndicatorInterface progressBarObj, boolean unzipDownloadedFileFlag) Creates a file download thread.
FileDownloader(java.lang.String fileNameStr, java.io.File outputDir, CallBackStringParam callBackObj, IstiDialogInterface dialogObj, ProgressIndicatorInterface progressBarObj) Creates a file download thread.
FileDownloader(java.lang.String fileNameStr, java.io.File outputDir, CallBackStringParam callBackObj, IstiDialogInterface dialogObj, ProgressIndicatorInterface progressBarObj, boolean unzipDownloadedFileFlag) Creates a file download thread.

Method Summary

Modifier and Type	Method and Description
protected void	addOutputFileObj(java.io.File outputFile) Add the output file.
protected void	backupOutputFile(java.io.File outputFile) Backup the output file.
protected java.lang.String	checkConnection(java.net.URLConnection urlCon) Checks the connection.
protected java.lang.String	checkHttpURLConnection(java.net.HttpURLConnection htpUrlCon) Checks the HTTP connection.
protected long	checkLastModified(java.net.URLConnection urlCon, java.io.File outputFile) Checks the last modified time.
protected java.io.File	createOutputFileObject(java.io.File outputDir, java.net.URL fileUrl) Create the output file object.
static java.util.List<java.net.URL>	createUrlList(java.lang.String... fileNames) Create an immutable URL list.
protected void	doThreadFinished(java.lang.String errMsgStr) Performs thread-finished operations.
protected java.io.File	getBackupFile(java.io.File outputFile) Gets the backup file for the specified output file.
IstiDialogInterface	getDialogObj() Get the dialog object.
java.lang.String	getFileNameStr() Get the file name string.
protected static java.lang.String	getFileNameStr(java.util.List<java.net.URL> urlList) Get the file name string.
protected java.io.File	getOutputDir(java.net.URL url) Get the output directory for the specified URL.
java.io.File	getOutputFileObj() Returns the file object for the last file downloaded (or attempted).
java.io.File	getOutputFileObj(int index) Returns the file object for the file downloaded (or attempted).
ProgressIndicatorInterface	getProgressBarObj() Get the progress bar object.
java.util.List<java.net.URL>	getUrlList() Get the immutable URL list.
protected void	initProgressBar() Initialize the progress bar.
boolean	isCloseWhenDone() Determines if dialog is closed when the download is done.
boolean	isDownloadDone() Returns the completion status of the download attempt.
boolean	isOutputFirstDirFlag() Determine if output is going to the first directory.
void	requestDialogFocus() Perfoms a 'requestFocus()' on the currently-displayed dialog (if any).
void	run() Runs the thread.
protected java.lang.String	run(java.io.File outputDir, java.net.URL fileUrl) Download the specified file.
void	setBackupFile(boolean b) Determines if the output file should be backed up if it already exists.
void	setCallBackObj(CallBackStringParam callBackObj) Sets the call-back object to use used.
void	setCheckConnection(boolean b) Determines if the connection should be checked.
void	setCheckLastModified(boolean b) Determines if the last modified time should be checked.
void	setCloseWhenDone(boolean b) Sets if the dialog is closed when the download is done.
void	setDeleteFileAfterUnzip(boolean b) Determines if the file should be deleted after unzip.
protected void	setDownloadDone(java.lang.String errMsgStr) Sets the download done.
void	setFileNameStr(java.lang.String fileNameStr) Set the file name string.
void	setOutputFirstDirFlag(boolean outputFirstDirFlag) Set if output is going to the first directory.
void	terminate() Deprecated. Should use the terminateThread method instead.
void	terminateThread(java.lang.String msgStr) Terminates this download thread.
protected void	threadFinished(java.lang.String errMsgStr) Performs thread-finished operations (if terminate flag not set).
protected void	transferStream(java.io.InputStream inputStream, java.io.OutputStream outputStream) Transfers data from the input stream to the output stream.
protected java.lang.Object	unzipZipFile(java.io.File file, java.io.File outputDir) Unzip the file.

Methods inherited from class com.isti.util.IstiNotifyThread

sleep

Methods inherited from class com.isti.util.IstiThread

clearThreadWaitNotifyFlag, isTerminated, nextThreadNum, notifyThread, start, terminate, waitForNotify, waitForNotify, waitForTerminate, waitForTerminate, wasStarted

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDownloader

public FileDownloader(java.util.List<java.net.URL> urlList,
                      java.io.File outputDir,
                      CallBackStringParam callBackObj,
                      IstiDialogInterface dialogObj,
                      ProgressIndicatorInterface progressBarObj,
                      boolean unzipDownloadedFileFlag)
               throws java.lang.Exception

Creates a file download thread. It downloads the specified file to the output directory.

Parameters:

urlList - the immutable URL list.

outputDir - the output directory.

callBackObj - if not null then a call-back object whose method is called (after the download is complete) with a string parameter containing null if successful or an error message if an error occurred.

dialogObj - the dialog object or null for none.

progressBarObj - the progress bar object or null for none.

unzipDownloadedFileFlag - true to unzip file after download (if it is a ZIP file); false to not unzip file.

Throws:

java.lang.Exception - if the URL list is null or empty.

FileDownloader

public FileDownloader(java.lang.String fileNameStr,
                      java.io.File outputDir,
                      CallBackStringParam callBackObj,
                      IstiDialogInterface dialogObj,
                      ProgressIndicatorInterface progressBarObj)
               throws java.lang.Exception

Creates a file download thread. It downloads the specified file to the output directory and if the file is a ZIP file it unzips the file.

Parameters:

fileNameStr - the installer file name string.

outputDir - the output directory.

callBackObj - if not null then a call-back object whose method is called (after the download is complete) with a string parameter containing null if successful or an error message if an error occurred.

dialogObj - the dialog object or null for none.

progressBarObj - the progress bar object or null for none.

Throws:

java.lang.Exception - if the file name string cannot be parsed.

FileDownloader

public FileDownloader(java.lang.String fileNameStr,
                      java.io.File outputDir,
                      CallBackStringParam callBackObj,
                      IstiDialogInterface dialogObj,
                      ProgressIndicatorInterface progressBarObj,
                      boolean unzipDownloadedFileFlag)
               throws java.lang.Exception

Creates a file download thread. It downloads the specified file to the output directory.

Parameters:

fileNameStr - the installer file name string.

outputDir - the output directory.

callBackObj - if not null then a call-back object whose method is called (after the download is complete) with a string parameter containing null if successful or an error message if an error occurred.

dialogObj - the dialog object or null for none.

progressBarObj - the progress bar object or null for none.

unzipDownloadedFileFlag - true to unzip file after download (if it is a ZIP file); false to not unzip file.

Throws:

java.lang.Exception - if the file name string cannot be parsed.

Method Detail

createUrlList

public static java.util.List<java.net.URL> createUrlList(java.lang.String... fileNames)
                                                  throws java.lang.Exception

Create an immutable URL list.

Parameters:

fileNames - the file names optionally using the path-separator.

Returns:

the immutable URL list or an empty list if no file names.

Throws:

java.lang.Exception - if the file names cannot be parsed.

java.lang.NullPointerException - if the file names are null.

See Also:

FileUtilsConst.PATH_SEPARATOR

getFileNameStr

protected static final java.lang.String getFileNameStr(java.util.List<java.net.URL> urlList)
                                                throws java.lang.Exception

Get the file name string.

Parameters:

urlList - the immutable URL list.

Returns:

the file name string

Throws:

java.lang.Exception - if the URL list is null or empty.

addOutputFileObj

protected void addOutputFileObj(java.io.File outputFile)

Add the output file.

Parameters:

outputFile - the output file.

backupOutputFile

protected void backupOutputFile(java.io.File outputFile)

Backup the output file.

Parameters:

outputFile - the output file.

checkConnection

protected java.lang.String checkConnection(java.net.URLConnection urlCon)
                                    throws java.io.IOException

Checks the connection.

Parameters:

urlCon - the URL connection.

Returns:

the error message or null if none.

Throws:

java.io.IOException - if an I/O error has occurred.

checkHttpURLConnection

protected java.lang.String checkHttpURLConnection(java.net.HttpURLConnection htpUrlCon)
                                           throws java.io.IOException

Checks the HTTP connection.

Parameters:

htpUrlCon - the HTTP URL connection.

Returns:

the error message or null if none.

Throws:

java.io.IOException - if an I/O error has occurred.

checkLastModified

protected long checkLastModified(java.net.URLConnection urlCon,
                                 java.io.File outputFile)

Checks the last modified time.

Parameters:

urlCon - the URL connection.

outputFile - the output file.

Returns:

the last modified time or -1 if the download should be terminated.

createOutputFileObject

protected java.io.File createOutputFileObject(java.io.File outputDir,
                                              java.net.URL fileUrl)

Create the output file object.

Parameters:

outputDir - the output directory.

fileUrl - the file URL.

Returns:

the output file object.

doThreadFinished

protected void doThreadFinished(java.lang.String errMsgStr)

Performs thread-finished operations.

Parameters:

errMsgStr - error message to be entered into the call-back object, or null for none.

getBackupFile

protected java.io.File getBackupFile(java.io.File outputFile)

Gets the backup file for the specified output file.

Parameters:

outputFile - the output file.

Returns:

the backup file.

getDialogObj

public IstiDialogInterface getDialogObj()

Get the dialog object.

Returns:

the dialog object or null for none.

getFileNameStr

public java.lang.String getFileNameStr()

Get the file name string.

Returns:

the file name string

getOutputDir

protected java.io.File getOutputDir(java.net.URL url)

Get the output directory for the specified URL.

Parameters:

url - the URL.

Returns:

the output directory.

getOutputFileObj

public java.io.File getOutputFileObj()

Returns the file object for the last file downloaded (or attempted).

Returns:

The file object for the last file downloaded, or null if none.

getOutputFileObj

public java.io.File getOutputFileObj(int index)

Returns the file object for the file downloaded (or attempted).

Parameters:

index - the file index or -1 for the last.

Returns:

The file object for the file downloaded, or null if none.

getProgressBarObj

public ProgressIndicatorInterface getProgressBarObj()

Get the progress bar object.

Returns:

the the progress bar object or null for none.

getUrlList

public java.util.List<java.net.URL> getUrlList()

Get the immutable URL list.

Returns:

the immutable URL list.

initProgressBar

protected void initProgressBar()

Initialize the progress bar.

isCloseWhenDone

public boolean isCloseWhenDone()

Determines if dialog is closed when the download is done.

Returns:

true if dialog is closed when the download is done, false otherwise.

isDownloadDone

public boolean isDownloadDone()

Returns the completion status of the download attempt.

Returns:

true if the download attempt has finish; false if not.

isOutputFirstDirFlag

public boolean isOutputFirstDirFlag()

Determine if output is going to the first directory.

Returns:

true if output is going to the first directory, false otherwise.

requestDialogFocus

public void requestDialogFocus()

Perfoms a 'requestFocus()' on the currently-displayed dialog (if any).

run

public void run()

Runs the thread.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

run

protected java.lang.String run(java.io.File outputDir,
                               java.net.URL fileUrl)

Download the specified file.

Parameters:

outputDir - the output directory.

fileUrl - the file URL.

Returns:

the error message or null if none.

setBackupFile

public void setBackupFile(boolean b)

Determines if the output file should be backed up if it already exists. The default is false.

Parameters:

b - true if the output file should be backed up if it already exists.

setCallBackObj

public void setCallBackObj(CallBackStringParam callBackObj)

Sets the call-back object to use used.

Parameters:

callBackObj - if not null then a call-back object whose method is called (after the download is complete) with a string parameter containing null if successful or an error message if an error occurred.

setCheckConnection

public void setCheckConnection(boolean b)

Determines if the connection should be checked. The default is true.

Parameters:

b - true if the connection should be checked.

setCheckLastModified

public void setCheckLastModified(boolean b)

Determines if the last modified time should be checked. The default is false.

Parameters:

b - true if the last modified time should be checked.

setCloseWhenDone

public void setCloseWhenDone(boolean b)

Sets if the dialog is closed when the download is done.

Parameters:

b - true if dialog is closed when the download is done, false otherwise.

setDeleteFileAfterUnzip

public void setDeleteFileAfterUnzip(boolean b)

Determines if the file should be deleted after unzip. The default is true.

Parameters:

b - true if the file should be deleted after unzip.

setDownloadDone

protected void setDownloadDone(java.lang.String errMsgStr)

Sets the download done.

Parameters:

errMsgStr - error message to be entered into the call-back object, or null for none.

setFileNameStr

public void setFileNameStr(java.lang.String fileNameStr)
                    throws java.lang.Exception

Set the file name string.

Parameters:

fileNameStr - the file name string.

Throws:

java.lang.Exception - if the file name string cannot be parsed.

setOutputFirstDirFlag

public void setOutputFirstDirFlag(boolean outputFirstDirFlag)

Set if output is going to the first directory.

Parameters:

outputFirstDirFlag - true if output is going to the first directory, false otherwise.

terminate

public void terminate()

Deprecated. Should use the terminateThread method instead.

Terminates this thread if the thread is not terminated and alive.

Overrides:

terminate in class IstiNotifyThread

See Also:

terminateThread

terminateThread

public void terminateThread(java.lang.String msgStr)

Terminates this download thread.

Parameters:

msgStr - message string given to call-back object.

threadFinished

protected void threadFinished(java.lang.String errMsgStr)

Performs thread-finished operations (if terminate flag not set).

Parameters:

errMsgStr - error message to be entered into the call-back object, or null for none.

transferStream

protected void transferStream(java.io.InputStream inputStream,
                              java.io.OutputStream outputStream)
                       throws java.io.IOException

Transfers data from the input stream to the output stream.

Parameters:

inputStream - the input stream.

outputStream - the output stream.

Throws:

java.io.IOException - if an I/O error occurs.

unzipZipFile

protected java.lang.Object unzipZipFile(java.io.File file,
                                        java.io.File outputDir)
                                 throws java.io.IOException

Unzip the file.

Parameters:

file - the ZIP file.

outputDir - the output directory.

Returns:

the ZIP file object or null if none.

Throws:

java.io.IOException - if an I/O error has occurred.