wjhk.jupload2.upload

Class FileUploadManagerThreadImpl

java.lang.Object

java.lang.Thread

wjhk.jupload2.upload.FileUploadManagerThreadImpl

All Implemented Interfaces:

Runnable, FileUploadManagerThread

public class FileUploadManagerThreadImpl
extends Thread
implements FileUploadManagerThread

This class is responsible for managing the upload. At the end of the upload, the JUploadPanel.updateButtonState() is called, to refresh the button state. Its job is to:

Prepare upload for the file (calls to FileData#beforeUpload() for each file in the file list.

Create the thread to send a packet of files.

Prepare the packets, that will be red by the upload thread.

Manage the end of upload: trigger the call to JUploadPanel.updateButtonState() and the call to UploadPolicy.afterUpload(Exception, String).

Manage the 'stop' button reaction.

This class is created by JUploadPanel, when the user clicks on the upload button.

Author:

etienne_sf

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface wjhk.jupload2.upload.FileUploadManagerThread

UPLOAD_STATUS_CHUNK_UPLOADED_WAITING_FOR_RESPONSE, UPLOAD_STATUS_FILE_UPLOADED_WAITING_FOR_RESPONSE, UPLOAD_STATUS_NOT_STARTED, UPLOAD_STATUS_UPLOADED, UPLOAD_STATUS_UPLOADING

Constructor Summary

Constructors

Constructor and Description
FileUploadManagerThreadImpl(UploadPolicy uploadPolicy) Standard constructor of the class.

Method Summary

Modifier and Type	Method and Description
void	anotherFileHasBeenSent(UploadFilePacket uploadFilePacket, UploadFileData newlyUploadedFileData) This method is called each time a new file is sent to the server.
void	currentRequestIsFinished(UploadFilePacket uploadFilePacket) This method is called when the server response for the upload indicates a success.
JUploadException	getUploadException() Get the last upload exception that occurs.
boolean	isUploadFinished() Indicates whether the upload is finished or not.
boolean	isUploadStopped() Indicates if the upload has been stopped by the user, or by any upload error.
void	nbBytesUploaded(long nbBytes, UploadFileData uploadFileData) Used by the UploadFileData#uploadFile(java.io.OutputStream, long) for each uploaded buffer
void	run() The heart of the program.
void	setUploadException(JUploadException uploadExceptionParam) Stores the last upload exception that occurs.
void	setUploadStatus(UploadFilePacket uploadFilePacket, UploadFileData uploadFileData, int uploadStatus) Indicate the current state of the upload, to allow a correct display of UPLOAD_STATUS_UPLOADED status. the upload progress bar.
void	stopUpload() Reaction to the user click on the 'Stop' button, or any action from the user asking to stop the upload.

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, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface wjhk.jupload2.upload.FileUploadManagerThread

interrupt, isAlive, join, start

Constructor Detail

FileUploadManagerThreadImpl

public FileUploadManagerThreadImpl(UploadPolicy uploadPolicy)
                            throws JUploadException

Standard constructor of the class.

Parameters:

uploadPolicy -

Throws:

JUploadException

Method Detail

run

public final void run()

Description copied from interface: FileUploadManagerThread

The heart of the program. This method prepare the upload, then calls doUpload for each HTTP request.

Specified by:

run in interface Runnable

Specified by:

run in interface FileUploadManagerThread

Overrides:

run in class Thread

See Also:

FileUploadManagerThread.run()

setUploadException

public void setUploadException(JUploadException uploadExceptionParam)

Description copied from interface: FileUploadManagerThread

Stores the last upload exception that occurs. This method won't write to the log file.

Specified by:

setUploadException in interface FileUploadManagerThread

See Also:

FileUploadManagerThread.setUploadException(wjhk.jupload2.exception.JUploadException)

getUploadException

public JUploadException getUploadException()

Description copied from interface: FileUploadManagerThread

Get the last upload exception that occurs.

Specified by:

getUploadException in interface FileUploadManagerThread

Returns:

The last upload exception, or null if no exception occurs.

See Also:

FileUploadManagerThread.getUploadException()

isUploadFinished

public boolean isUploadFinished()

Description copied from interface: FileUploadManagerThread

Indicates whether the upload is finished or not. As several conditions can make the upload being finished (all files uploaded, an error occured, the user stops the upload), a specific boolean is built. It's managed by the FileUploadManagerThread.run() method.

Specified by:

isUploadFinished in interface FileUploadManagerThread

Returns:

true if the upload is finished. False otherwise.

See Also:

FileUploadManagerThread.isUploadFinished()

isUploadStopped

public boolean isUploadStopped()

Description copied from interface: FileUploadManagerThread

Indicates if the upload has been stopped by the user, or by any upload error. This method should not be used to know if it's the end of the upload. To do this, see FileUploadManagerThread.isUploadFinished()

Specified by:

isUploadStopped in interface FileUploadManagerThread

Returns:

true if the current upload has been asked to stop by the user, false otherwise.

See Also:

FileUploadManagerThread.isUploadStopped()

nbBytesUploaded

public void nbBytesUploaded(long nbBytes,
                            UploadFileData uploadFileData)
                     throws JUploadException

Description copied from interface: FileUploadManagerThread

Used by the UploadFileData#uploadFile(java.io.OutputStream, long) for each uploaded buffer

Specified by:

nbBytesUploaded in interface FileUploadManagerThread

Parameters:

nbBytes - Number of additional bytes that where uploaded.

uploadFileData - The file that is currently being uploade (or null if no file is being uploaded)

Throws:

JUploadException

See Also:

FileUploadManagerThread.nbBytesUploaded(long, UploadFileData)

setUploadStatus

public void setUploadStatus(UploadFilePacket uploadFilePacket,
                            UploadFileData uploadFileData,
                            int uploadStatus)
                     throws JUploadException

Description copied from interface: FileUploadManagerThread

Indicate the current state of the upload, to allow a correct display of UPLOAD_STATUS_UPLOADED status. the upload progress bar.

Specified by:

setUploadStatus in interface FileUploadManagerThread

Parameters:

uploadFilePacket - The current packet. This parameter is mandatory only for the

uploadFileData - The file whose upload begins, is going on or is finished.

Throws:

JUploadException

See Also:

FileUploadManagerThread.setUploadStatus(wjhk.jupload2.upload.UploadFilePacket, wjhk.jupload2.upload.UploadFileData, int)

stopUpload

public void stopUpload()

Description copied from interface: FileUploadManagerThread

Reaction to the user click on the 'Stop' button, or any action from the user asking to stop the upload. The upload should go on for the current file, and stop before starting the next upload request to the server, to avoid strange problems on the server.

Specified by:

stopUpload in interface FileUploadManagerThread

See Also:

FileUploadManagerThread.stopUpload()

anotherFileHasBeenSent

public void anotherFileHasBeenSent(UploadFilePacket uploadFilePacket,
                                   UploadFileData newlyUploadedFileData)
                            throws JUploadException

Description copied from interface: FileUploadManagerThread

This method is called each time a new file is sent to the server. It's main aim is to allow a proper display of the progress bar. It is public, as upload is done in another thread, whose class maybe in another package.

Specified by:

anotherFileHasBeenSent in interface FileUploadManagerThread

Throws:

JUploadException

See Also:

FileUploadManagerThread.anotherFileHasBeenSent(wjhk.jupload2.upload.UploadFilePacket, wjhk.jupload2.upload.UploadFileData)

currentRequestIsFinished

public void currentRequestIsFinished(UploadFilePacket uploadFilePacket)
                              throws JUploadException

Description copied from interface: FileUploadManagerThread

This method is called when the server response for the upload indicates a success. It is public, as upload is done in another thread, whose class maybe in another package.

Specified by:

currentRequestIsFinished in interface FileUploadManagerThread

Parameters:

uploadFilePacket - The packet of files that was successfully uploaded.

Throws:

JUploadException

See Also:

FileUploadManagerThread.currentRequestIsFinished(wjhk.jupload2.upload.UploadFilePacket)