public class

CommonsMultipartFile

extends Object
implements Serializable MultipartFile
java.lang.Object
   ↳ org.springframework.web.multipart.commons.CommonsMultipartFile

Class Overview

MultipartFile implementation for Jakarta Commons FileUpload.

NOTE: As of Spring 2.0, this class requires Commons FileUpload 1.1 or higher. The implementation does not use any deprecated FileUpload 1.0 API anymore, to be compatible with future Commons FileUpload releases.

See Also

Summary

Fields
protected static final Log logger
Public Constructors
CommonsMultipartFile(FileItem fileItem)
Create an instance wrapping the given FileItem.
Public Methods
byte[] getBytes()
Return the contents of the file as an array of bytes.
String getContentType()
Return the content type of the file.
final FileItem getFileItem()
Return the underlying org.apache.commons.fileupload.FileItem instance.
InputStream getInputStream()
Return an InputStream to read the contents of the file from.
String getName()
Return the name of the parameter in the multipart form.
String getOriginalFilename()
Return the original filename in the client's filesystem.
long getSize()
Return the size of the file in bytes.
String getStorageDescription()
Return a description for the storage location of the multipart content.
boolean isEmpty()
Return whether the uploaded file is empty, that is, either no file has been chosen in the multipart form or the chosen file has no content.
void transferTo(File dest)
Transfer the received file to the given destination file.
Protected Methods
boolean isAvailable()
Determine whether the multipart content is still available.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.web.multipart.MultipartFile

Fields

protected static final Log logger

Public Constructors

public CommonsMultipartFile (FileItem fileItem)

Create an instance wrapping the given FileItem.

Parameters
fileItem the FileItem to wrap

Public Methods

public byte[] getBytes ()

Return the contents of the file as an array of bytes.

Returns
  • the contents of the file as bytes, or an empty byte array if empty

public String getContentType ()

Return the content type of the file.

Returns
  • the content type, or null if not defined (or no file has been chosen in the multipart form)

public final FileItem getFileItem ()

Return the underlying org.apache.commons.fileupload.FileItem instance. There is hardly any need to access this.

public InputStream getInputStream ()

Return an InputStream to read the contents of the file from. The user is responsible for closing the stream.

Returns
  • the contents of the file as stream, or an empty stream if empty
Throws
IOException

public String getName ()

Return the name of the parameter in the multipart form.

Returns
  • the name of the parameter (never null or empty)

public String getOriginalFilename ()

Return the original filename in the client's filesystem.

This may contain path information depending on the browser used, but it typically will not with any other than Opera.

Returns
  • the original filename, or the empty String if no file has been chosen in the multipart form

public long getSize ()

Return the size of the file in bytes.

Returns
  • the size of the file, or 0 if empty

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.

public boolean isEmpty ()

Return whether the uploaded file is empty, that is, either no file has been chosen in the multipart form or the chosen file has no content.

public void transferTo (File dest)

Transfer the received file to the given destination file.

This may either move the file in the filesystem, copy the file in the filesystem, or save memory-held contents to the destination file. If the destination file already exists, it will be deleted first.

If the file has been moved in the filesystem, this operation cannot be invoked again. Therefore, call this method just once to be able to work with any storage mechanism.

Parameters
dest the destination file
Throws
IOException
IllegalStateException

Protected Methods

protected boolean isAvailable ()

Determine whether the multipart content is still available. If a temporary file has been moved, the content is no longer available.