com.jcorporate.expresso.core.misc.upload
Class FileItem

java.lang.Object
  com.jcorporate.expresso.core.misc.upload.FileItem

All Implemented Interfaces:

javax.activation.DataSource, org.apache.struts.upload.FormFile

public class FileItem

extends Object

implements org.apache.struts.upload.FormFile, javax.activation.DataSource

This class represents a file that was received by Turbine using multipart/form-data POST request.

After retrieving an instance of this class from the ParameterParser (see ParameterParser.getFileItem(String) and ParameterParser.getFileItems(String)) you can use it to acces the data that was sent by the browser. You may either request all contents of file at once using get() or request an InputStream with getStream() and process the file without attempting to load it into memory, which may come handy with large files.

Version:

$Id: FileItem.java,v 1.8 2004/11/17 20:48:13 lhamel Exp $

Author:

Rafal Krzewski

Field Summary

protected ByteArrayOutputStream	byteStream Temporary storage for in-memory files.
protected byte[]	content Cached contents of the file.
protected String	contentType The content type passed by the browser or null if not defined.
static int	DEFAULT_UPLOAD_SIZE_THRESHOLD The maximal size of request that will have it's elements stored in memory.
protected String	fileName The original filename in the user's filesystem.
protected File	storeLocation Temporary storage location.

Constructor Summary

protected

FileItem(String fileName, String contentType) Constructs a new FileItem.

Method Summary

void	destroy() Destroy all content for this form file.
byte[]	get() Returns the contents of the file as an array of bytes.
String	getContentType() Returns the content type passed by the browser or null if not defined.
byte[]	getFileData() Get the data in byte array for for this file.
String	getFileName() Returns the original filename in the user's filesystem.
int	getFileSize() Get the size of this file
InputStream	getInputStream() Get an InputStream that represents this file.
String	getName() Returns the name of the FileItem
OutputStream	getOutputStream() Returns an OutputStream that can be used for storing the contensts of the file.
long	getSize() Returns the size of the file.
File	getStoreLocation() Returns the File objects for the FileItems's data temporary location on the disk.
InputStream	getStream() Returns an InputStream that can be used to retrieve the contents of the file.
String	getString() Returns the contents of the file as a String, using default encoding.
String	getString(String encoding) Returns the contents of the file as a String, using specified encoding.
boolean	inMemory() Provides a hint if the file contents will be read from memory.
static FileItem	newInstance(String path, String name, String contentType, int requestSize, boolean storeAsFile) Instantiates a FileItem.
void	setContentType(String contentType) Set the content type for this file
void	setFileName(String newFileName) Set the filename of this file
void	setFileSize(int filesize) Set the file size

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_UPLOAD_SIZE_THRESHOLD

public static final int DEFAULT_UPLOAD_SIZE_THRESHOLD

The maximal size of request that will have it's elements stored in memory.

See Also:

Constant Field Values

fileName

protected String fileName

The original filename in the user's filesystem.

contentType

protected String contentType

The content type passed by the browser or null if not defined.

content

protected byte[] content

Cached contents of the file.

storeLocation

protected File storeLocation

Temporary storage location.

byteStream

protected ByteArrayOutputStream byteStream

Temporary storage for in-memory files.

Constructor Detail

FileItem

protected FileItem(String fileName,
                   String contentType)

Constructs a new FileItem.

Use #newInstance(String,String,String,int) to instantiate FileItems.

Parameters:

fileName - The original filename in the user's filesystem.

contentType - The content type passed by the browser or null if not defined.

Method Detail

getFileName

public String getFileName()

Returns the original filename in the user's filesystem.

Specified by:

getFileName in interface org.apache.struts.upload.FormFile

Returns:

The original filename in the user's filesystem.

getContentType

public String getContentType()

Returns the content type passed by the browser or null if not defined.

Specified by:

getContentType in interface org.apache.struts.upload.FormFile

Returns:

The content type passed by the browser or null if not defined.

inMemory

public boolean inMemory()

Provides a hint if the file contents will be read from memory.

Returns:

True if the file contents will be read from memory.

getSize

public long getSize()

Returns the size of the file.

Returns:

The size of the file.

get

public byte[] get()

Returns the contents of the file as an array of bytes. If the contents of the file were not yet cached int the memory, they will be loaded from the disk storage and chached.

Returns:

The contents of the file as an array of bytes.

getString

public String getString()

Returns the contents of the file as a String, using default encoding. This method uses get() to retrieve the contents of the file.

Returns:

The contents of the file.

getString

public String getString(String encoding)
                 throws UnsupportedEncodingException

Returns the contents of the file as a String, using specified encoding. This method uses get() to retireve the contents of the file.

Parameters:

encoding - The encoding to use.

Returns:

The contents of the file.

Throws:

UnsupportedEncodingException

getStream

public InputStream getStream()
                      throws Exception

Returns an InputStream that can be used to retrieve the contents of the file.

Returns:

An InputStream that can be used to retrieve the contents of the file.

Throws:

Exception - A generic exception.

getStoreLocation

public File getStoreLocation()

Returns the File objects for the FileItems's data temporary location on the disk. Note that for FileItems that have their data stored in memory this method will return null. When handling large files, you can use File.renameTo(File) to move the file to new location without copying the data, if the source and destination locations reside within the same logical volume.

Returns:

A File.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Returns an OutputStream that can be used for storing the contensts of the file.

Specified by:

getOutputStream in interface javax.activation.DataSource

Returns:

an OutputStream that can be used for storing the contensts of the file.

Throws:

IOException

newInstance

public static FileItem newInstance(String path,
                                   String name,
                                   String contentType,
                                   int requestSize,
                                   boolean storeAsFile)

Instantiates a FileItem. It uses requestSize to decide what temporary storage approach the new item should take. The largest request that will have its items cached in memory can be configured in TurbineResources.properties in the entry named file.upload.size.threshold

Parameters:

path - A String.

name - The original filename in the user's filesystem.

contentType - The content type passed by the browser or null if not defined.

requestSize - The total size of the POST request this item belongs to.

storeAsFile - Set to true if you want it stored as a local file.

Returns:

A FileItem.

setContentType

public void setContentType(String contentType)

Set the content type for this file

Specified by:

setContentType in interface org.apache.struts.upload.FormFile

Parameters:

contentType - The content type

getFileSize

public int getFileSize()

Get the size of this file

Specified by:

getFileSize in interface org.apache.struts.upload.FormFile

Returns:

An int representing the size of the file in bytes

setFileSize

public void setFileSize(int filesize)

Set the file size

Specified by:

setFileSize in interface org.apache.struts.upload.FormFile

Parameters:

filesize - An int reprsenting the size of the file in bytes

setFileName

public void setFileName(String newFileName)

Set the filename of this file

Specified by:

setFileName in interface org.apache.struts.upload.FormFile

Parameters:

newFileName - The name of the file

getFileData

public byte[] getFileData()
                   throws FileNotFoundException,
                          IOException

Get the data in byte array for for this file. Note that this can be a very hazardous method, files can be large enough to cause OutOfMemoryErrors. Short of being deprecated, it's strongly recommended that you use getInputStream to get the file data.

Specified by:

getFileData in interface org.apache.struts.upload.FormFile

Returns:

An array of bytes representing the data contained in the form file

Throws:

FileNotFoundException - If some sort of file representation cannot be found for the FormFile

IOException - If there is some sort of IOException

getInputStream

public InputStream getInputStream()
                           throws FileNotFoundException,
                                  IOException

Get an InputStream that represents this file. This is the preferred method of getting file data.

Specified by:

getInputStream in interface org.apache.struts.upload.FormFile

Returns:

an InputStream object.

Throws:

FileNotFoundException - If some sort of file representation cannot be found for the FormFile

IOException - If there is some sort of IOException

destroy

public void destroy()

Destroy all content for this form file. Implementations should remove any temporary files or any temporary file data stored somewhere

Specified by:

destroy in interface org.apache.struts.upload.FormFile

getName

public String getName()

Returns the name of the FileItem

Specified by:

getName in interface javax.activation.DataSource

Returns:

java.lang.String