|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 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.
Field Summary | |
---|---|
static int |
DEFAULT_UPLOAD_SIZE_THRESHOLD
The maximal size of request that will have it's elements stored in memory. |
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 as an array of bytes. |
java.lang.String |
getContentType()
Returns the content type passed by the browser or null if
not defined. |
java.lang.String |
getFieldName()
Returns the name of the field in the multipart form corresponding to this file item. |
java.io.InputStream |
getInputStream()
Returns an InputStream that can be
used to retrieve the contents of the file. |
java.lang.String |
getName()
Returns the original filename in the client's filesystem. |
java.io.OutputStream |
getOutputStream()
Returns an OutputStream that can
be used for storing the contents of the file. |
long |
getSize()
Returns the size of the file. |
java.io.File |
getStoreLocation()
Returns the File object for the FileItem 's
data's temporary location on the disk. |
java.lang.String |
getString()
Returns the contents of the file as a String, using the default character encoding. |
java.lang.String |
getString(java.lang.String encoding)
Returns the contents of the file 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(java.lang.String name)
Sets the field name used to reference this file item. |
void |
setIsFormField(boolean state)
Specifies whether or not a FileItem instance represents
a simple form field. |
void |
write(java.lang.String file)
A convenience method to write an uploaded file to disk. |
Field Detail |
public static final int DEFAULT_UPLOAD_SIZE_THRESHOLD
Method Detail |
public java.io.InputStream getInputStream() throws java.io.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.java.io.IOException
- if an error occurs.public java.lang.String getContentType()
null
if
not defined.null
if
not defined.public java.lang.String getName()
public boolean isInMemory()
true
if the file contents will be read
from memory.public long getSize()
public byte[] get()
public java.lang.String getString(java.lang.String encoding) throws java.io.UnsupportedEncodingException
get()
to retrieve the
contents of the file.encoding
- The character encoding to use.java.io.UnsupportedEncodingException
- if the requested character
encoding is not available.public java.lang.String getString()
get()
to retrieve the
contents of the file.public java.io.File getStoreLocation()
File
object for the FileItem
's
data's temporary location on the disk. Note that for
FileItem
s that have their data stored in memory,
this method will return null
. When handling large
files, you can use File.renameTo(File)
to
move the file to new location without copying the data, if the
source and destination locations reside within the same logical
volume.null
if the data is stored in
memory.public void write(java.lang.String file) throws java.lang.Exception
file
- The full path to location where the uploaded file should
be stored.java.lang.Exception
- if an error occurs.public 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.public java.lang.String getFieldName()
public void setFieldName(java.lang.String name)
name
- The name of the form field.public 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.public void setIsFormField(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.public java.io.OutputStream getOutputStream() throws java.io.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.java.io.IOException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |