Apache Struts API Documentation: Class CommonsMultipartRequestHandler.CommonsFormFile

org.apache.struts.upload Class CommonsMultipartRequestHandler.CommonsFormFile

java.lang.Object
  |
  +--org.apache.struts.upload.CommonsMultipartRequestHandler.CommonsFormFile

All Implemented Interfaces:

FormFile, java.io.Serializable

Enclosing class:

CommonsMultipartRequestHandler

static class CommonsMultipartRequestHandler.CommonsFormFile

extends java.lang.Object

implements FormFile, java.io.Serializable

This class implements the Struts FormFile interface by wrapping the Commons FileUpload FileItem interface. This implementation is read-only; any attempt to modify an instance of this class will result in an UnsupportedOperationException.

See Also:

Serialized Form

fileItem

org.apache.commons.fileupload.FileItem fileItem

The FileItem instance wrapped by this object.

CommonsMultipartRequestHandler.CommonsFormFile

public CommonsMultipartRequestHandler.CommonsFormFile(org.apache.commons.fileupload.FileItem fileItem)

Constructs an instance of this class which wraps the supplied file item.

Parameters:

fileItem - The Commons file item to be wrapped.

getContentType

public java.lang.String getContentType()

Returns the content type for this file.

Specified by:

getContentType in interface FormFile

Returns:

A String representing content type.

setContentType

public void setContentType(java.lang.String contentType)

Sets the content type for this file.

NOTE: This method is not supported in this implementation.

Specified by:

setContentType in interface FormFile

Parameters:

contentType - A string representing the content type.

getFileSize

public int getFileSize()

Returns the size, in bytes, of this file.

Specified by:

getFileSize in interface FormFile

Returns:

The size of the file, in bytes.

setFileSize

public void setFileSize(int filesize)

Sets the size, in bytes, for this file.

NOTE: This method is not supported in this implementation.

Specified by:

setFileSize in interface FormFile

Parameters:

filesize - The size of the file, in bytes.

getFileName

public java.lang.String getFileName()

Returns the (client-side) file name for this file.

Specified by:

getFileName in interface FormFile

Returns:

The client-size file name.

setFileName

public void setFileName(java.lang.String fileName)

Sets the (client-side) file name for this file.

NOTE: This method is not supported in this implementation.

Specified by:

setFileName in interface FormFile

Parameters:

fileName - The client-side name for the file.

getFileData

public byte[] getFileData()
                   throws java.io.FileNotFoundException,
                          java.io.IOException

Returns the data for this file as a byte array. Note that this may result in excessive memory usage for large uploads. The use of the getInputStream method is encouraged as an alternative.

Specified by:

getFileData in interface FormFile

Returns:

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

Throws:

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

java.io.IOException - If there is some sort of IOException

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.FileNotFoundException,
                                          java.io.IOException

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

Specified by:

getInputStream in interface FormFile

Throws:

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

java.io.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 FormFile

getBaseFileName

protected java.lang.String getBaseFileName(java.lang.String filePath)

Returns the base file name from the supplied file path. On the surface, this would appear to be a trivial task. Apparently, however, some Linux JDKs do not implement File.getName() correctly for Windows paths, so we attempt to take care of that here.

Parameters:

filePath - The full path to the file.

Returns:

The base file name, from the end of the path.

toString

public java.lang.String toString()

Returns the (client-side) file name for this file.

Overrides:

toString in class java.lang.Object

Returns:

The client-size file name.