|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FileItem
This class represents a file or form item that was received within a
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.
Method Summary | |
---|---|
void |
delete()
Deletes the underlying storage for a file item, including deleting any associated temporary disk file. |
byte[] |
get()
Returns the contents of the file item as an array of bytes. |
String |
getContentType()
Returns the content type passed by the browser or null if not defined. |
String |
getFieldName()
Returns the name of the field in the multipart form corresponding to this file item. |
InputStream |
getInputStream()
Returns an InputStream that can be used to retrieve the contents
of the file. |
String |
getName()
Returns the original filename in the client's filesystem, as provided by the browser (or other client software). |
OutputStream |
getOutputStream()
Returns an OutputStream that can be used for storing the
contents of the file. |
long |
getSize()
Returns the size of the file item. |
String |
getString()
Returns the contents of the file item as a String, using the default character encoding. |
String |
getString(String encoding)
Returns the contents of the file item as a String, using the specified encoding. |
boolean |
isFormField()
Determines whether or not a FileItem instance represents a simple form field. |
boolean |
isInMemory()
Provides a hint as to whether or not the file contents will be read from memory. |
void |
setFieldName(String name)
Sets the field name used to reference this file item. |
void |
setFormField(boolean state)
Specifies whether or not a FileItem instance represents a simple form field. |
void |
write(File file)
A convenience method to write an uploaded item to disk. |
Method Detail |
---|
InputStream getInputStream() throws IOException
InputStream
that can be used to retrieve the contents
of the file.
InputStream
that can be used to retrieve the contents
of the file.
IOException
- if an error occurs.String getContentType()
null
if not defined.
null
if not defined.String getName()
boolean isInMemory()
true
if the file contents will be read from memory; false
otherwise.long getSize()
byte[] get()
String getString(String encoding) throws UnsupportedEncodingException
get()
to retrieve the contents of the item.
encoding
- The character encoding to use.
UnsupportedEncodingException
- if the requested character encoding is not available.String getString()
get()
to retrieve the contents of the item.
void write(File file) throws Exception
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.void delete()
FileItem
instance is garbage collected, this method can be used to ensure that this is done at an
earlier time, thus preserving system resources.
String getFieldName()
void setFieldName(String name)
name
- The name of the form field.boolean isFormField()
FileItem
instance represents a simple form field.
true
if the instance represents a simple form field; false
if it represents an uploaded file.void setFormField(boolean state)
FileItem
instance represents a simple form field.
state
- true
if the instance represents a simple form field;
false
if it represents an uploaded file.OutputStream getOutputStream() throws IOException
OutputStream
that can be used for storing the
contents of the file.
OutputStream
that can be used for storing the
contensts of the file.
IOException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |