wjhk.jupload2.upload

Class UploadFileData

java.lang.Object

wjhk.jupload2.upload.UploadFileData

All Implemented Interfaces:

FileData

Direct Known Subclasses:

UploadFileDataPoisonned

public class UploadFileData
extends Object
implements FileData

This class implements the FileData interface, and is responsible to do the actual upload of the files.

Author:

etienne_sf

Constructor Summary

Constructors

Constructor and Description
UploadFileData(boolean poisonned) This particular constructor is posted by the FilePreparationThread in the preparedFileQueue to indicate that the last file has been prepared.
UploadFileData(FileData fileDataParam, int numOfFileInCurrentUpload, FileUploadManagerThread fileUploadManagerThreadParam, UploadPolicy uploadPolicyParam) Standard constructor for the UploadFileData class.

Method Summary

Modifier and Type	Method and Description
void	afterUpload() Clean any local resources, then transmit to the encapsulated FileData.afterUpload().
void	appendFileProperties(ByteArrayEncoder bae, int index) Called during the upload, by the FileUploadThread.
void	beforeRetry() Clean any local resources, to allow retrying to upload this file.
void	beforeUpload(String uploadFileRoot) Prepare the fileData to upload.
boolean	canRead() Indicate if this file can be read.
String	getAbsolutePath() Returns the absolute path, as it will be sent during the upload.
String	getDirectory() Get the directory of the file.
File	getFile()
String	getFileExtension()
long	getFileLength()
String	getFileName() Get the original filename.
InputStream	getInputStream() This function creates an InputStream from this file.
Date	getLastModified()
String	getMD5() Retrieves the MD5 sum of the file.
String	getMimeType() This function return the FileData content type.
int	getNumOfFileInCurrentUpload()
String	getRelativeDir() Retrieves the path of this file relative to the root directory
TreeFileDataNode	getTreeFileDataNode() Links this FileData to the associated TreeFileDataNode, from the hierarchical view.
String	getUploadFilename(int index) Retrieves the file name, that should be used in the server application.
boolean	getUploadFlag() The upload floag is not managed here.
long	getUploadLength() This methods stores locally the upload length.
String	getUploadName(int index) Retrieves the upload file name, that should be sent to the server.
boolean	isPoisonned()
boolean	isPreparedForUpload() Indicates whether the file can be uploaded or not.
void	setTreeFileDataNode(TreeFileDataNode node) Setters for the to the associated TreeFileDataNode, from the hierarchical view.
void	setUploadFlag(boolean uploadFlag) The upload floag is not managed here.

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadFileData

public UploadFileData(FileData fileDataParam,
                      int numOfFileInCurrentUpload,
                      FileUploadManagerThread fileUploadManagerThreadParam,
                      UploadPolicy uploadPolicyParam)

Standard constructor for the UploadFileData class.

Parameters:

fileDataParam - The file data the this instance must transmist.

numOfFileInCurrentUpload -

fileUploadManagerThreadParam - The current instance of FileUploadThread

uploadPolicyParam - The current upload policy, instance of UploadPolicy

UploadFileData

public UploadFileData(boolean poisonned)

This particular constructor is posted by the FilePreparationThread in the preparedFileQueue to indicate that the last file has been prepared.

Parameters:

poisonned - This parameter is here to avoid this constructor to be the default constructor. Its value must be 'true'.

Method Detail

afterUpload

public void afterUpload()

Clean any local resources, then transmit to the encapsulated FileData.afterUpload().

Specified by:

afterUpload in interface FileData

See Also:

FileData.afterUpload()

beforeRetry

public void beforeRetry()

Clean any local resources, to allow retrying to upload this file. The file remains prepared..

appendFileProperties

public void appendFileProperties(ByteArrayEncoder bae,
                                 int index)
                          throws JUploadIOException

Called during the upload, by the FileUploadThread. The FileData instance should then call the ByteArrayEncoder.appendTextProperty(String, String, int) method to add each file property to the current upload.

Specified by:

appendFileProperties in interface FileData

Parameters:

bae - The byte encoder, where the properties must be added

index - Index of the file concerned by this value. -1 if this is a global parameter.

Throws:

JUploadIOException - Encapsulation of the IOException, if any would occurs.

See Also:

ByteArrayEncoder.appendTextProperty(String, String, int)

beforeUpload

public void beforeUpload(String uploadFileRoot)
                  throws JUploadException

Prepare the fileData to upload. For instance, picture data can be resized before upload (see PictureFileData. This method is called before the upload of this file. If no exception is thrown, then the file is correctly prepared.

Specified by:

beforeUpload in interface FileData

Parameters:

uploadFileRoot - The biggest path which is common to all uploaded files. Used to calculate the relativeDir to this root path, for each file. This relative path is sent as metadata during the upload

Throws:

JUploadException - Encapsulation of the Exception, if any error would occurs.

See Also:

FileUploadThread, FileData.getRelativeDir()

canRead

public boolean canRead()

Indicate if this file can be read. Take care of the File.canRead() methods, that seems to be wrong from time to time.

Specified by:

canRead in interface FileData

Returns:

indicates whether the file can be read or not.

getDirectory

public String getDirectory()

Get the directory of the file.

Specified by:

getDirectory in interface FileData

Returns:

The directory where this file is stored.

getFile

public File getFile()

getFileExtension

public String getFileExtension()

Specified by:

getFileExtension in interface FileData

Returns:

The extension for the original file.

getFileLength

public long getFileLength()

Specified by:

getFileLength in interface FileData

Returns:

The length of the original file.

getFileName

public String getFileName()

Get the original filename. This is the name of the file, into the local hardrive

Specified by:

getFileName in interface FileData

Returns:

The original filename

getInputStream

public InputStream getInputStream()
                           throws JUploadException

This function creates an InputStream from this file. The FileUploadThread class then reads bytes from it and transfers them to the webserver. The caller is responsible for closing this stream.
This method may only be called when FileData.isPreparedForUpload() returns true.

Specified by:

getInputStream in interface FileData

Returns:

An InputStream, representing this instance.

Throws:

JUploadException - Encapsulation of the Exception, if any would occurs.

getLastModified

public Date getLastModified()

Specified by:

getLastModified in interface FileData

Returns:

The original file date.

getMD5

public String getMD5()
              throws JUploadException

Retrieves the MD5 sum of the file.
Since 5.0.0, this method is is in DefaultFileData, and is calculated depending on the sendMD5Sum applet parameter, during the file preparation file.

Specified by:

getMD5 in interface FileData

Returns:

The corresponding MD5 sum.

Throws:

JUploadException

See Also:

#beforeUpload()

getMimeType

public String getMimeType()

This function return the FileData content type.

Specified by:

getMimeType in interface FileData

Returns:

The mimeType for the file.

getRelativeDir

public String getRelativeDir()

Retrieves the path of this file relative to the root directory

Specified by:

getRelativeDir in interface FileData

Returns:

This instance's relative path or an empty string if it was not created using a root parameter.

getAbsolutePath

public String getAbsolutePath()

Returns the absolute path, as it will be sent during the upload. In standard mode, it is the concatenation of the root and the relative path, that is: the absolute path of the File to upload on the local file system. In hierarchical mode, it is the path relative to the (empty) upload root.

Specified by:

getAbsolutePath in interface FileData

Returns:

getUploadFilename

public String getUploadFilename(int index)
                         throws JUploadException

Retrieves the file name, that should be used in the server application. Default is to send the original filename.

Parameters:

index - The index of this file in the current request to the server.

Returns:

The real file name. Not used in FTP upload.

Throws:

JUploadException - Thrown when an error occurs.

See Also:

UploadPolicy.getUploadFilename(FileData, int)

getUploadName

public String getUploadName(int index)
                     throws JUploadException

Retrieves the upload file name, that should be sent to the server. It's the technical name used to retrieve the file content. Default is File0, File1... This method just calls the UploadPolicy.getUploadFilename(FileData, int) method.

Parameters:

index - The index of this file in the current request to the server.

Returns:

The technical upload file name. Not used in FTP upload.

Throws:

JUploadException

See Also:

UploadPolicy.getUploadName(FileData, int)

getUploadLength

public long getUploadLength()

This methods stores locally the upload length. So, on the contrary of the FileData interface, this method may be called after afterUpload(), at one condition: that it has been called once before afterUpload() is called.

Specified by:

getUploadLength in interface FileData

Returns:

The length of upload. In this class, this is the size of the file, as it isn't transformed for upload. This size may change if encoding is necessary (needs a new FileData class), or if picture is to be resized or rotated.

See Also:

FileData.getUploadLength()

isPreparedForUpload

public boolean isPreparedForUpload()

Indicates whether the file can be uploaded or not. This boolean should be set to true in the call to #beforeUpload(), and the to false in the call to FileData.afterUpload().

Specified by:

isPreparedForUpload in interface FileData

Returns:

True if the file is ready for upload.

isPoisonned

public boolean isPoisonned()

Returns:

the poisonned status. Returns always false, as this instance is a true one. false indicates the 'End Of Queue' marker in the preparedFileQueue, which is not the case here

See Also:

UploadFileDataPoisonned

getNumOfFileInCurrentUpload

public int getNumOfFileInCurrentUpload()

Returns:

the numOfFileInCurrentUpload

getUploadFlag

public boolean getUploadFlag()

The upload floag is not managed here. This method alread returns true

Specified by:

getUploadFlag in interface FileData

Returns:

setUploadFlag

public void setUploadFlag(boolean uploadFlag)

The upload floag is not managed here. This method should not be called.

Specified by:

setUploadFlag in interface FileData

Throws:

IllegalArgumentException - when uploadFlag is false.

getTreeFileDataNode

public TreeFileDataNode getTreeFileDataNode()

Description copied from interface: FileData

Links this FileData to the associated TreeFileDataNode, from the hierarchical view.

Specified by:

getTreeFileDataNode in interface FileData

Returns:

setTreeFileDataNode

public void setTreeFileDataNode(TreeFileDataNode node)

Description copied from interface: FileData

Setters for the to the associated TreeFileDataNode, from the hierarchical view. Allows link between the flat and hierarchical view.

Specified by:

setTreeFileDataNode in interface FileData