public class CommonsMultipartFile extends java.lang.Object implements MultipartFile, java.io.Serializable
MultipartFile
implementation for Apache Commons FileUpload.CommonsMultipartResolver
,
Serialized FormConstructor and Description |
---|
CommonsMultipartFile(org.apache.commons.fileupload.FileItem fileItem)
Create an instance wrapping the given FileItem.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
getBytes()
Return the contents of the file as an array of bytes.
|
java.lang.String |
getContentType()
Return the content type of the file.
|
org.apache.commons.fileupload.FileItem |
getFileItem()
Return the underlying
org.apache.commons.fileupload.FileItem
instance. |
java.io.InputStream |
getInputStream()
Return an InputStream to read the contents of the file from.
|
java.lang.String |
getName()
Return the name of the parameter in the multipart form.
|
java.lang.String |
getOriginalFilename()
Return the original filename in the client's filesystem.
|
long |
getSize()
Return the size of the file in bytes.
|
java.lang.String |
getStorageDescription()
Return a description for the storage location of the multipart content.
|
protected boolean |
isAvailable()
Determine whether the multipart content is still available.
|
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 |
setPreserveFilename(boolean preserveFilename)
Set whether to preserve the filename as sent by the client, not stripping off
path information in
getOriginalFilename() . |
void |
transferTo(java.io.File dest)
Transfer the received file to the given destination file.
|
protected static final Log logger
public CommonsMultipartFile(org.apache.commons.fileupload.FileItem fileItem)
fileItem
- the FileItem to wrappublic final org.apache.commons.fileupload.FileItem getFileItem()
org.apache.commons.fileupload.FileItem
instance. There is hardly any need to access this.public void setPreserveFilename(boolean preserveFilename)
getOriginalFilename()
.
Default is "false", stripping off path information that may prefix the actual filename e.g. from Opera. Switch this to "true" for preserving the client-specified filename as-is, including potential path separators.
getOriginalFilename()
,
CommonsFileUploadSupport.setPreserveFilename(boolean)
public java.lang.String getName()
MultipartFile
getName
in interface MultipartFile
null
or empty)public java.lang.String getOriginalFilename()
MultipartFile
This may contain path information depending on the browser used, but it typically will not with any other than Opera.
getOriginalFilename
in interface MultipartFile
null
if not defined or not availableFileItem.getName()
,
setPreserveFilename(boolean)
public java.lang.String getContentType()
MultipartFile
getContentType
in interface MultipartFile
null
if not defined
(or no file has been chosen in the multipart form)public boolean isEmpty()
MultipartFile
isEmpty
in interface MultipartFile
public long getSize()
MultipartFile
getSize
in interface MultipartFile
public byte[] getBytes()
MultipartFile
getBytes
in interface MultipartFile
public java.io.InputStream getInputStream() throws java.io.IOException
MultipartFile
The user is responsible for closing the returned stream.
getInputStream
in interface InputStreamSource
getInputStream
in interface MultipartFile
java.io.IOException
- in case of access errors (if the temporary store fails)public void transferTo(java.io.File dest) throws java.io.IOException, java.lang.IllegalStateException
MultipartFile
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 target file has been moved in the filesystem, this operation cannot be invoked again afterwards. Therefore, call this method just once in order to work with any storage mechanism.
NOTE: Depending on the underlying provider, temporary storage may be container-dependent, including the base directory for relative destinations specified here (e.g. with Servlet 3.0 multipart handling). For absolute destinations, the target file may get renamed/moved from its temporary location or newly copied, even if a temporary copy already exists.
transferTo
in interface MultipartFile
dest
- the destination file (typically absolute)java.io.IOException
- in case of reading or writing errorsjava.lang.IllegalStateException
- if the file has already been moved
in the filesystem and is not available anymore for another transferFileItem.write(File)
,
Part.write(String)
protected boolean isAvailable()
public java.lang.String getStorageDescription()