public interface MultipartFile extends InputStreamSource
The file contents are either stored in memory or temporarily on disk. In either case, the user is responsible for copying file contents to a session-level or persistent store as and if desired. The temporary storage will be cleared at the end of request processing.
MultipartHttpServletRequest
,
MultipartResolver
Modifier and Type | Method and Description |
---|---|
byte[] |
getBytes()
Return the contents of the file as an array of bytes.
|
String |
getContentType()
Return the content type of the file.
|
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.
|
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.
|
String getName()
null
or empty)String getOriginalFilename()
This may contain path information depending on the browser used, but it typically will not with any other than Opera.
null
if not defined or not availableFileItem.getName()
,
CommonsMultipartFile.setPreserveFilename(boolean)
String getContentType()
null
if not defined
(or no file has been chosen in the multipart form)boolean isEmpty()
long getSize()
byte[] getBytes() throws IOException
IOException
- in case of access errors (if the temporary store fails)InputStream getInputStream() throws IOException
The user is responsible for closing the returned stream.
getInputStream
in interface InputStreamSource
IOException
- in case of access errors (if the temporary store fails)void transferTo(File dest) throws IOException, IllegalStateException
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.
dest
- the destination file (typically absolute)IOException
- in case of reading or writing errorsIllegalStateException
- if the file has already been moved
in the filesystem and is not available anymore for another transferFileItem.write(File)
,
Part.write(String)