com.aspectran.web.support.multipart.commons

Class CommonsMultipartFileParameter

java.lang.Object

com.aspectran.core.activity.request.parameter.FileParameter

com.aspectran.web.support.multipart.commons.CommonsMultipartFileParameter

public class CommonsMultipartFileParameter
extends FileParameter

This class represents a file item that was received within a multipart/form-data POST request.

Created: 2008. 04. 11 PM 8:55:25

Field Summary

Fields inherited from class com.aspectran.core.activity.request.parameter.FileParameter

savedFile

Constructor Summary

Constructors

Constructor and Description
CommonsMultipartFileParameter(org.apache.commons.fileupload.FileItem fileItem) Create an instance wrapping the given FileItem.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the underlying Commons FileItem instances.
byte[]	getBytes() Return an byte array to read the contents of the file from.
String	getContentType() Gets the content type of the data being uploaded.
File	getFile()
String	getFileName() Returns the file name that was uploaded in the multipart form.
long	getFileSize() Returns the file size that was uploaded in the multipart form.
InputStream	getInputStream() Return an InputStream to read the contents of the file from.
String	getStorageDescription() Return a description for the storage location of the multipart content.
void	release()
File	saveAs(File destFile, boolean overwrite) Save an uploaded file as a given destination file.

Methods inherited from class com.aspectran.core.activity.request.parameter.FileParameter

getSavedFile, isRefused, rollback, saveAs, setRefused, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonsMultipartFileParameter

public CommonsMultipartFileParameter(org.apache.commons.fileupload.FileItem fileItem)

Create an instance wrapping the given FileItem.

Parameters:

fileItem - the FileItem to wrap

Method Detail

getFile

public File getFile()

Overrides:

getFile in class FileParameter

getContentType

public String getContentType()

Gets the content type of the data being uploaded. This is never null, and defaults to "content/unknown" when the mime type of the data couldn't be determined and was not set manually.

Overrides:

getContentType in class FileParameter

Returns:

the content type

getFileName

public String getFileName()

Returns the file name that was uploaded in the multipart form.

Overrides:

getFileName in class FileParameter

Returns:

the file name

getFileSize

public long getFileSize()

Returns the file size that was uploaded in the multipart form.

Overrides:

getFileSize in class FileParameter

Returns:

the file size

getInputStream

public InputStream getInputStream()
                           throws IOException

Return an InputStream to read the contents of the file from.

Overrides:

getInputStream in class FileParameter

Returns:

the contents of the file as stream, or an empty stream if empty

Throws:

IOException - in case of access errors (if the temporary store fails)

getBytes

public byte[] getBytes()

Return an byte array to read the contents of the file from.

Overrides:

getBytes in class FileParameter

Returns:

the byte array

saveAs

public File saveAs(File destFile,
                   boolean overwrite)
            throws IOException

Save an uploaded file as a given destination file.

Overrides:

saveAs in class FileParameter

Parameters:

destFile - the destination file

overwrite - whether to overwrite if it already exists

Returns:

a saved file

Throws:

IOException - if an I/O error has occurred

delete

public void delete()

Deletes the underlying Commons FileItem instances.

Overrides:

delete in class FileParameter

release

public void release()

Overrides:

release in class FileParameter

getStorageDescription

public String getStorageDescription()

Return a description for the storage location of the multipart content. Tries to be as specific as possible: mentions the file location in case of a temporary file.

Returns:

a description for the storage location of the multipart content