wjhk.jupload2.upload

Class DefaultFileUploadThread

java.lang.Object

java.lang.Thread

wjhk.jupload2.upload.DefaultFileUploadThread

All Implemented Interfaces:

Runnable, FileUploadThread

Direct Known Subclasses:

FileUploadThreadFTP, FileUploadThreadHTTP

public abstract class DefaultFileUploadThread
extends Thread
implements FileUploadThread

This class is based on the FileUploadThread class. It's an abstract class that contains the default implementation for the FileUploadThread interface.
It contains the following abstract methods, which must be implemented in the children classes. These methods are called in this order:

For each upload request (for instance, upload of 3 files with nbFilesPerRequest to 2, makes 2 request: 2 files, then the last one):

try

startRequest(long, boolean, int, boolean): start of the UploadRequest.

Then, for each file to upload (according to the nbFilesPerRequest and maxChunkSize applet parameters)

beforeFile(int) is called before writting the bytes for this file (or this chunk)

afterFile(int) is called after writting the bytes for this file (or this chunk)

finishRequest()

finallycleanRequest()

Call of cleanAll(), to clean up any used resources, common to the whole upload.

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	responseBody The response message from the application.
protected String	responseMsg The full response message from the server, if any.
protected UploadPolicy	uploadPolicy The upload policy contains all parameters needed to define the way files should be uploaded, including the URL.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
DefaultFileUploadThread(String threadName, BlockingQueue<UploadFilePacket> packetQueue, UploadPolicy uploadPolicy, FileUploadManagerThread fileUploadManagerThread) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection to the server and releases resources.
BlockingQueue<UploadFilePacket>	getPacketQueue()
String	getResponseBody() Return the the body for the server response.
String	getResponseMsg() Get the server Output.
String	normalizeCRLF(String s) Replace single \r and \n by uniform end of line characters (CRLF).
String	quoteCRLF(String s) Replace \r and \n by correctly displayed end of line characters.
void	run() This method waits for a packet on the packetQueue.
void	setFileUploadThreadManager(FileUploadManagerThread fileUploadManagerThread) Changes the FileUploadManagerThread.

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.FileUploadThread

getState, interrupt, isAlive, join, join, start

Field Detail

uploadPolicy

protected UploadPolicy uploadPolicy

The upload policy contains all parameters needed to define the way files should be uploaded, including the URL.

responseMsg

protected String responseMsg

The full response message from the server, if any. For instance, in HTTP mode, this contains both the headers and the body.

responseBody

protected String responseBody

The response message from the application. For instance, in HTTP mode, this contains the body response.
Note: for easier management on the various server configurations, all end or line characters (CR, LF or CRLF) are changed to uniform CRLF.

Constructor Detail

DefaultFileUploadThread

public DefaultFileUploadThread(String threadName,
                               BlockingQueue<UploadFilePacket> packetQueue,
                               UploadPolicy uploadPolicy,
                               FileUploadManagerThread fileUploadManagerThread)

Creates a new instance.

Parameters:

threadName - The name of the thread, that will be displayed in the debugger and in the logs.

packetQueue - The queue from wich packets to upload are available.

uploadPolicy - The upload policy to be applied.

fileUploadManagerThread - The thread that is managing the upload.

Method Detail

getResponseBody

public String getResponseBody()

Return the the body for the server response. That is: the server response without the http header. This is the functional response from the server application, that has been as the HTTP reply body, for instance: all 'echo' PHP commands.

Returns:

The last application response (HTTP body, in HTTP upload)

getResponseMsg

public String getResponseMsg()

Get the server Output.

Specified by:

getResponseMsg in interface FileUploadThread

Returns:

The status message from the first line of the response (e.g. "200 OK").

getPacketQueue

public BlockingQueue<UploadFilePacket> getPacketQueue()

Specified by:

getPacketQueue in interface FileUploadThread

Returns:

the packetQueue

run

public final void run()

This method waits for a packet on the packetQueue. Then, it calls the doUpload() method, to send these files to the server.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

close

public void close()

Description copied from interface: FileUploadThread

Closes the connection to the server and releases resources.

Specified by:

close in interface FileUploadThread

See Also:

FileUploadThread.close()

normalizeCRLF

public final String normalizeCRLF(String s)

Replace single \r and \n by uniform end of line characters (CRLF). This makes it easier, to search for string within the body.

Parameters:

s - The original string

Returns:

The string with single \r and \n modified changed to CRLF (\r\n).

quoteCRLF

public final String quoteCRLF(String s)

Replace \r and \n by correctly displayed end of line characters. Used to display debug output. It also replace any single \r or \n by \r\n, to make it easier, to search for string within the body.

Parameters:

s - The original string

Returns:

The string with \r and \n modified, to be correctly displayed.

setFileUploadThreadManager

public void setFileUploadThreadManager(FileUploadManagerThread fileUploadManagerThread)
                                throws JUploadException

Changes the FileUploadManagerThread. The standard way is to give the FileUploadManagerThread to the constructor. This method is used by JUnit tests, to be able to control which FileUploadThread is created.

Specified by:

setFileUploadThreadManager in interface FileUploadThread

Throws:

JUploadException

See Also:

FileUploadManagerThread