multipart/form-data
POST request.After retrieving an instance of this class from a FileUpload instance (see #parseRequest(javax.servlet.http.HttpServletRequest)), you may either request all contents of the file at once using get() or request an InputStream with getInputStream() and process the file without attempting to load it into memory, which may come handy with large files.
While this interface does not extend javax.activation.DataSource
per se (to avoid a seldom used dependency), several of the defined methods are specifically defined with the same signatures as methods in that interface. This allows an implementation of this interface to also implement javax.activation.DataSource
with minimal additional work.
Definition at line 101 of file FileItem.java.
Public Member Functions | |
String | getContentType () |
Returns the content type passed by the browser or null if not defined. | |
String | getName () |
Returns the original filename in the client's filesystem, as provided by the browser (or other client software). | |
boolean | isInMemory () |
Provides a hint as to whether or not the file contents will be read from memory. | |
long | getSize () |
Returns the size of the file item. | |
byte[] | get () |
Returns the contents of the file item as an array of bytes. | |
String | getString (String encoding) throws UnsupportedEncodingException |
Returns the contents of the file item as a String, using the specified encoding. | |
String | getString () |
Returns the contents of the file item as a String, using the default character encoding. | |
void | write (File file) throws Exception |
A convenience method to write an uploaded item to disk. | |
void | delete () |
Deletes the underlying storage for a file item, including deleting any associated temporary disk file. | |
String | getFieldName () |
Returns the name of the field in the multipart form corresponding to this file item. | |
void | setFieldName (String name) |
Sets the field name used to reference this file item. | |
boolean | isFormField () |
Determines whether or not a FileItem instance represents a simple form field. | |
void | setFormField (boolean state) |
Specifies whether or not a FileItem instance represents a simple form field. | |
OutputStream | getOutputStream () throws IOException |
Returns an OutputStream that can be used for storing the contents of the file. | |
Package Functions | |
InputStream | getInputStream () throws IOException |
Returns an InputStream that can be used to retrieve the contents of the file. |
InputStream org.apache.commons.fileupload.FileItem.getInputStream | ( | ) | throws IOException [package] |
Returns an InputStream that can be used to retrieve the contents of the file.
IOException | if an error occurs. |
Implemented in org.apache.commons.fileupload.DefaultFileItem.
String org.apache.commons.fileupload.FileItem.getContentType | ( | ) |
Returns the content type passed by the browser or null
if not defined.
null
if not defined. Implemented in org.apache.commons.fileupload.DefaultFileItem.
String org.apache.commons.fileupload.FileItem.getName | ( | ) |
Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.
Implemented in org.apache.commons.fileupload.DefaultFileItem.
boolean org.apache.commons.fileupload.FileItem.isInMemory | ( | ) |
Provides a hint as to whether or not the file contents will be read from memory.
true
if the file contents will be read from memory; false
otherwise. Implemented in org.apache.commons.fileupload.DefaultFileItem.
long org.apache.commons.fileupload.FileItem.getSize | ( | ) |
Returns the size of the file item.
Implemented in org.apache.commons.fileupload.DefaultFileItem.
byte [] org.apache.commons.fileupload.FileItem.get | ( | ) |
Returns the contents of the file item as an array of bytes.
Implemented in org.apache.commons.fileupload.DefaultFileItem.
String org.apache.commons.fileupload.FileItem.getString | ( | String | encoding | ) | throws UnsupportedEncodingException |
Returns the contents of the file item as a String, using the specified encoding.
This method uses get() to retrieve the contents of the item.
encoding | The character encoding to use. |
UnsupportedEncodingException | if the requested character encoding is not available. |
Implemented in org.apache.commons.fileupload.DefaultFileItem.
String org.apache.commons.fileupload.FileItem.getString | ( | ) |
Returns the contents of the file item as a String, using the default character encoding.
This method uses get() to retrieve the contents of the item.
Implemented in org.apache.commons.fileupload.DefaultFileItem.
void org.apache.commons.fileupload.FileItem.write | ( | File | file | ) | throws Exception |
A convenience method to write an uploaded item to disk.
The client code is not concerned with whether or not the item is stored in memory, or on disk in a temporary location. They just want to write the uploaded item to a file.
This method is not guaranteed to succeed if called more than once for the same item. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit.
file | The File into which the uploaded item should be stored. |
Exception | if an error occurs. |
Implemented in org.apache.commons.fileupload.DefaultFileItem.
void org.apache.commons.fileupload.FileItem.delete | ( | ) |
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
Although this storage will be deleted automatically when the FileItem
instance is garbage collected, this method can be used to ensure that this is done at an earlier time, thus preserving system resources.
Implemented in org.apache.commons.fileupload.DefaultFileItem.
String org.apache.commons.fileupload.FileItem.getFieldName | ( | ) |
Returns the name of the field in the multipart form corresponding to this file item.
Implemented in org.apache.commons.fileupload.DefaultFileItem.
void org.apache.commons.fileupload.FileItem.setFieldName | ( | String | name | ) |
Sets the field name used to reference this file item.
name | The name of the form field. |
Implemented in org.apache.commons.fileupload.DefaultFileItem.
boolean org.apache.commons.fileupload.FileItem.isFormField | ( | ) |
Determines whether or not a FileItem
instance represents a simple form field.
true
if the instance represents a simple form field; false
if it represents an uploaded file. Implemented in org.apache.commons.fileupload.DefaultFileItem.
void org.apache.commons.fileupload.FileItem.setFormField | ( | boolean | state | ) |
Specifies whether or not a FileItem
instance represents a simple form field.
state | true if the instance represents a simple form field; false if it represents an uploaded file. |
Implemented in org.apache.commons.fileupload.DefaultFileItem.
OutputStream org.apache.commons.fileupload.FileItem.getOutputStream | ( | ) | throws IOException |
Returns an OutputStream that can be used for storing the contents of the file.
IOException | if an error occurs. |
Implemented in org.apache.commons.fileupload.DefaultFileItem.
Referenced by org.apache.commons.fileupload.FileUploadBase.parseRequest().