wjhk.jupload2.filedata

Class DefaultFileData

java.lang.Object

wjhk.jupload2.filedata.DefaultFileData

All Implemented Interfaces:

FileData

Direct Known Subclasses:

AudioFileData, PictureFileData

public class DefaultFileData
extends Object
implements FileData

This class contains all data and methods for a file to upload. The current * UploadPolicy contains the necessary parameters * to personalize the way files must be handled.

This class is the default FileData implementation. It gives the default behavior, and is used by DefaultUploadPolicy. It provides standard control on the files chosen for upload.

Author:

etienne_sf

See Also:

FileData

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	canRead Indicates whether the applet can read this file or not.
protected File	file file is the file about which this FileData contains data.
protected String	fileDir Cached file directory
protected Date	fileModified Cached file modification time.
protected String	fileRoot cached root of this file.
protected long	fileSize Cached file size
protected String	md5sum The md5sum for the prepared file.
protected String	mimeType Mime type of the file.
protected boolean	uploadFlag Indicated whether this file should be uploaded or not.

Constructor Summary

Constructors

Constructor and Description
DefaultFileData(File file, UploadPolicy uploadPolicyParam) Standard constructor

Method Summary

Modifier and Type	Method and Description
void	afterUpload() This function is called after upload, whether it is successful or not.
void	appendFileProperties(ByteArrayEncoder bae, int index) Called during the upload, by the FileUploadThread.
void	beforeUpload(String uploadFileRoot) Prepare the fileData to upload.
void	calculateMD5Sum() Calculate the MD5Sum for the transformed file, or the original if no transformation should be done on the file, before 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.
static String	getExtension(String filename) Returns the extension of the given file.
protected File	getFile() Standard getter, for the file described by the FileData instance.
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.
String	getRelativeDir() Retrieves the path of this file relative to the root directory
static File	getRoot(List<? extends FileData> rows) Return the 'biggest' common ancestror of the given file array.
TreeFileDataNode	getTreeFileDataNode() Links this FileData to the associated TreeFileDataNode, from the hierarchical view.
boolean	getUploadFlag() Indicates whether the check box is checked or not.
long	getUploadLength() Get size of upload, which may be different from the actual file length.
boolean	isPreparedForUpload() Indicates whether the file can be uploaded or not.
void	setTreeFileDataNode(TreeFileDataNode treeFileDataNode) Setters for the to the associated TreeFileDataNode, from the hierarchical view.
void	setUploadFlag(boolean uploadFlag) Allows to set or unset the upload flag.

Methods inherited from class java.lang.Object

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

Field Detail

mimeType

protected String mimeType

Mime type of the file. It will be written in the upload HTTP request.

file

protected File file

file is the file about which this FileData contains data.

fileSize

protected long fileSize

Cached file size

fileDir

protected String fileDir

Cached file directory

fileRoot

protected String fileRoot

cached root of this file. This root is set during the prepareUpload call to set the root for the uploaded files, when it is known.

fileModified

protected Date fileModified

Cached file modification time.

uploadFlag

protected boolean uploadFlag

Indicated whether this file should be uploaded or not. Default value is true.

md5sum

protected String md5sum

The md5sum for the prepared file. Calculated in the #beforeUpload(), and cleared in the afterUpload().

canRead

protected Boolean canRead

Indicates whether the applet can read this file or not.

Constructor Detail

DefaultFileData

public DefaultFileData(File file,
                       UploadPolicy uploadPolicyParam)

Standard constructor

Parameters:

file - The file whose data this instance will give.

absoluteRoot - The directory root, to be able to calculate the result of getRelativeDir()

uploadPolicyParam - The current upload policy.

Method Detail

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()

getUploadLength

public long getUploadLength()

Get size of upload, which may be different from the actual file length. This call is valid only after a call to #beforeUpload() and before the call to FileData.afterUpload().

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:

PictureFileData

afterUpload

public void afterUpload()

This function is called after upload, whether it is successful or not. It allows fileData to free any resource created for the upload. For instance, PictureFileData.afterUpload() removes the temporary file, if any was created.

Specified by:

afterUpload in interface FileData

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.

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

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.

getLastModified

public Date getLastModified()

Specified by:

getLastModified in interface FileData

Returns:

The original file date.

getDirectory

public String getDirectory()

Get the directory of the file.

Specified by:

getDirectory in interface FileData

Returns:

The directory where this file is stored.

getUploadFlag

public boolean getUploadFlag()

Indicates whether the check box is checked or not. That is: whether the file should be uploaded or not.

Specified by:

getUploadFlag in interface FileData

Returns:

setUploadFlag

public void setUploadFlag(boolean uploadFlag)

Allows to set or unset the upload flag.

Specified by:

setUploadFlag in interface FileData

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()

calculateMD5Sum

public void calculateMD5Sum()
                     throws JUploadException

Calculate the MD5Sum for the transformed file, or the original if no transformation should be done on the file, before upload.

Throws:

JUploadException

getMimeType

public String getMimeType()

This function return the FileData content type.

Specified by:

getMimeType in interface FileData

Returns:

The mimeType for the file.

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.

getFile

protected File getFile()

Standard getter, for the file described by the FileData instance.
Since JUpload 6.0, this method is no more in the FileData interface. Direct link between the DefaultFile and the File should be avoided. This is especially true to access the file path. You should the other method of this interface, instead of this one. Typically, using this method is incompatible with the TreeViewUploadPolicy
To check if a file is already in the current upload list, you should now use the getAbsolutePath() method.

Returns:

the File instance associated with this row.

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:

getExtension

public static String getExtension(String filename)

Returns the extension of the given file. To be clear: jpg is the extension for the file named picture.jpg.

Parameters:

file - the file whose the extension is wanted!

Returns:

The extension, without the point, for the given file.

getRoot

public static File getRoot(List<? extends FileData> rows)

Return the 'biggest' common ancestror of the given file array. For instance, the root for the files /usr/bin/toto and /usr/titi is /usr.

Parameters:

rows -

Returns:

The common root for the given files.

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.

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:

the treeFileDataNode

setTreeFileDataNode

public void setTreeFileDataNode(TreeFileDataNode treeFileDataNode)

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