|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.fileupload.DefaultFileItem
The default mplementation of the
FileItem
interface.
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.
Field Summary | |
---|---|
private java.io.ByteArrayOutputStream |
byteStream
Temporary storage for in-memory files. |
private byte[] |
content
Cached contents of the file. |
private java.lang.String |
contentType
The content type passed by the browser, or null if
not defined. |
private static int |
counter
Counter used in unique identifier generation. |
private java.lang.String |
fieldName
The name of the form field as provided by the browser. |
private java.lang.String |
fileName
The original filename in the user's filesystem. |
private boolean |
isFormField
Whether or not this item is a simple form field. |
private java.io.File |
storeLocation
Temporary storage location on disk. |
Fields inherited from interface org.apache.commons.fileupload.FileItem |
---|
DEFAULT_UPLOAD_SIZE_THRESHOLD |
Constructor Summary | |
---|---|
|
DefaultFileItem()
Default constructor. |
protected |
DefaultFileItem(java.lang.String fileName,
java.lang.String contentType)
Constructs a new DefaultFileItem instance. |
Method Summary | |
---|---|
void |
delete()
Deletes the underlying storage for a file item, including deleting any associated temporary disk file. |
protected void |
finalize()
Removes the file contents from the temporary storage. |
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. |
private static java.lang.String |
getUniqueId()
Returns an identifier that is unique within the class loader used to load this class, but does not have random-like apearance. |
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. |
static FileItem |
newInstance(java.lang.String path,
java.lang.String name,
java.lang.String contentType,
int requestSize,
int threshold)
Instantiates a DefaultFileItem. |
void |
setFieldName(java.lang.String fieldName)
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. |
Methods inherited from class java.lang.Object |
---|
|
Field Detail |
private static int counter
private java.lang.String fileName
private java.lang.String contentType
null
if
not defined.private byte[] content
private java.io.File storeLocation
private java.io.ByteArrayOutputStream byteStream
private java.lang.String fieldName
private boolean isFormField
Constructor Detail |
public DefaultFileItem()
protected DefaultFileItem(java.lang.String fileName, java.lang.String contentType)
DefaultFileItem
instance.
Use newInstance(String,String,String,int,int)
to
instantiate DefaultFileItem
s.
fileName
- The original filename in the user's filesystem.contentType
- The content type passed by the browser or
null
if not defined.Method Detail |
public java.io.InputStream getInputStream() throws java.io.IOException
InputStream
that can be
used to retrieve the contents of the file.getInputStream
in interface FileItem
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.getContentType
in interface FileItem
null
if
not defined.public java.lang.String getName()
getName
in interface FileItem
public boolean isInMemory()
isInMemory
in interface FileItem
true
if the file contents will be read
from memory.public long getSize()
getSize
in interface FileItem
public byte[] get()
get
in interface FileItem
public java.lang.String getString(java.lang.String encoding) throws java.io.UnsupportedEncodingException
get()
to retrieve the
contents of the file.getString
in interface FileItem
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.getString
in interface FileItem
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.getStoreLocation
in interface FileItem
null
if the data is stored in
memory.public void write(java.lang.String file) throws java.lang.Exception
write
in interface FileItem
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.delete
in interface FileItem
public java.lang.String getFieldName()
getFieldName
in interface FileItem
public void setFieldName(java.lang.String fieldName)
setFieldName
in interface FileItem
fieldName
- The name of the form field.public boolean isFormField()
FileItem
instance represents
a simple form field.isFormField
in interface FileItem
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.setIsFormField
in interface FileItem
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.getOutputStream
in interface FileItem
OutputStream
that can be used
for storing the contensts of the file.java.io.IOException
- if an error occurs.protected void finalize()
finalize
in class java.lang.Object
public static FileItem newInstance(java.lang.String path, java.lang.String name, java.lang.String contentType, int requestSize, int threshold)
requestSize
to
decide what temporary storage approach the new item should take.path
- The path under which temporary files should be
created.name
- The original filename in the client's filesystem.contentType
- The content type passed by the browser, or
null
if not defined.requestSize
- The total size of the POST request this item
belongs to.threshold
- The maximum size to store in memory.DefaultFileItem
instance.private static java.lang.String getUniqueId()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |