com.dpslink.base.io

Class FileUpload

java.lang.Object

com.dpslink.base.io.FileUpload

All Implemented Interfaces:

java.io.Serializable

public class FileUpload
extends java.lang.Object
implements java.io.Serializable

A utility class that contains file upload helper methods.

IMPORTANT: When a submitted html form is processed by this class, the form fields are read in the order in which they appear on the form. Form field values that are critical to the file upload process must therefore appear on the form before the <input type="file"...> form field that defines the file being uploaded, otherwise the critical values won't be known until after the file has being uploaded.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private BaseServletContext	ivContext The current context for the servlet or thread using this class.
private FileUploadListener	ivListener The class that will receive file upload event notifications.
private java.util.HashMap<java.lang.String,java.lang.String>	ivParams The submitted form fields and their values.
private static long	serialVersionUID The class' serialization version id.
private static java.io.File	TEMP_FOLDER The site's configured temporary file folder.

Constructor Summary

Constructors

Constructor and Description
FileUpload(FileUploadListener listener, BaseServletContext ctx) Constructs a new instance of the file upload class with the given servlet or thread context.

Method Summary

Modifier and Type	Method and Description
void	deleteFromTemp(java.lang.String fileName) Deletes an uploaded file from the site's configured temporary folder.
BaseServletContext	getContext() Returns the current context for the servlet or thread using this class.
boolean	isFileUpload() Answers if a file upload is to be processed based on whether a submitted servlet request's content type is "multipart/form-data".
boolean	moveFromTemp(java.lang.String fileName, java.lang.String destPath) Moves an uploaded file from the site's configured temporary folder to the given destination folder.
boolean	moveFromTemp(java.lang.String fileName, java.lang.String destPath, java.lang.String destName) Moves an uploaded file from the site's configured temporary folder to the given destination folder.
private void	sendEvent(java.lang.String field, java.lang.String file, int error) Sends a file upload event to the upload listener.
boolean	uploadToTemp(long maxSize) Uploads the requested file(s) to the site's configured temporary folder by parsing and processing submitted multipart/form-data.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

TEMP_FOLDER

private static final java.io.File TEMP_FOLDER

The site's configured temporary file folder.

ivListener

private FileUploadListener ivListener

The class that will receive file upload event notifications.

ivContext

private BaseServletContext ivContext

The current context for the servlet or thread using this class.

ivParams

private java.util.HashMap<java.lang.String,java.lang.String> ivParams

The submitted form fields and their values.

Constructor Detail

FileUpload

public FileUpload(FileUploadListener listener,
                  BaseServletContext ctx)

Constructs a new instance of the file upload class with the given servlet or thread context.

Parameters:

listener - (FileUploadListener) The class that will receive file upload event notifications.

ctx - (BaseServletContext) The current servlet or thread context.

Method Detail

getContext

public BaseServletContext getContext()

Returns the current context for the servlet or thread using this class.

Returns:

BaseServletContext - The current servlet or thread context.

isFileUpload

public boolean isFileUpload()

Answers if a file upload is to be processed based on whether a submitted servlet request's content type is "multipart/form-data".

Returns:

boolean - true if a file upload is to be processed, otherwise false.

uploadToTemp

public boolean uploadToTemp(long maxSize)

Uploads the requested file(s) to the site's configured temporary folder by parsing and processing submitted multipart/form-data. Sends an upload event to the upload listener for each file that is processed.

IMPORTANT: When a submitted html form is processed by this method, the form fields are read in the order in which they appear on the form. Form field values that are critical to the file upload process must therefore appear on the form before the <input type="file"...> form field that defines the file being uploaded, otherwise the critical values won't be known until after the file has being uploaded.

Parameters:

maxSize - (long) The maximum upload file size allowed. A value of zero indicates that there is no maximum.

Returns:

boolean - true if the upload completes successfully, otherwise false.

deleteFromTemp

public void deleteFromTemp(java.lang.String fileName)

Deletes an uploaded file from the site's configured temporary folder.

Parameters:

fileName - (String) The name of the uploaded file.

moveFromTemp

public boolean moveFromTemp(java.lang.String fileName,
                            java.lang.String destPath)

Moves an uploaded file from the site's configured temporary folder to the given destination folder. If a file with the same name already exists in the destination folder, an attempt is made to overlay the existing file.

Parameters:

fileName - (String) The name of the uploaded file.

destPath - (String) The fully qualified path to where the file is to be moved.

Returns:

boolean - true if moving the file is successful, otherwise false.

moveFromTemp

public boolean moveFromTemp(java.lang.String fileName,
                            java.lang.String destPath,
                            java.lang.String destName)

Moves an uploaded file from the site's configured temporary folder to the given destination folder. If a file with the given name already exists in the destination folder, an attempt is made to overlay the existing file.

Parameters:

fileName - (String) The name of the uploaded file.

destPath - (String) The fully qualified path to where the file is to be moved.

destName - (String) The name of the destination file.

Returns:

boolean - true if moving the file is successful, otherwise false.

sendEvent

private void sendEvent(java.lang.String field,
                       java.lang.String file,
                       int error)

Sends a file upload event to the upload listener.

Parameters:

field - (String) The name of the form field being processed.

file - (String) The name of the file being processed.

error - (int) The upload processing's error code.