org.apache.tomcat.util.http.fileupload
public class DefaultFileItem extends Object implements FileItem
The default implementation of the
FileItem
interface.
After retrieving an instance of this class from a DiskFileUpload
instance (see
#parseRequest(javax.servlet.http.HttpServletRequest)
), you may
either request all contents of file at once using get or
request an java.io.InputStream InputStream
with
getInputStream and process the file without attempting to load
it into memory, which may come handy with large files.
Version: $Id: DefaultFileItem.java 467222 2006-10-24 03:17:11Z markt $
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. |
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 java.io.InputStream InputStream that can be
used to retrieve the contents of the file.
|
String | getName()
Returns the original filename in the client's filesystem.
|
OutputStream | getOutputStream()
Returns an java.io.OutputStream OutputStream that can
be used for storing the contents of the file.
|
long | getSize()
Returns the size of the file.
|
File | getStoreLocation()
Returns the java.io.File object for the FileItem 's
data's temporary location on the disk. |
String | getString(String encoding)
Returns the contents of the file as a String, using the specified
encoding. |
String | getString()
Returns the contents of the file as a String, using the default
character encoding. |
protected File | getTempFile()
Creates and returns a java.io.File File representing a uniquely
named temporary file in the configured repository path.
|
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 fieldName)
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. |
FileItem
instance is garbage
collected, this method can be used to ensure that this is done at an
earlier time, thus preserving system resources.Returns: The contents of the file as an array of bytes.
null
if
not defined.
Returns: The content type passed by the browser or null
if
not defined.
Returns: The name of the form field.
java.io.InputStream InputStream
that can be
used to retrieve the contents of the file.
Returns: An java.io.InputStream InputStream
that can be
used to retrieve the contents of the file.
Throws: IOException if an error occurs.
Returns: The original filename in the client's filesystem.
java.io.OutputStream OutputStream
that can
be used for storing the contents of the file.
Returns: An java.io.OutputStream OutputStream
that can be used
for storing the contensts of the file.
Throws: IOException if an error occurs.
Returns: The size of the file, in bytes.
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 java.io.File#renameTo(java.io.File) to
move the file to new location without copying the data, if the
source and destination locations reside within the same logical
volume.
Returns: The data file, or null
if the data is stored in
memory.
Parameters: encoding The character encoding to use.
Returns: The contents of the file, as a string.
Throws: UnsupportedEncodingException if the requested character encoding is not available.
Returns: The contents of the file, as a string.
java.io.File File
representing a uniquely
named temporary file in the configured repository path.
Returns: The java.io.File File
to be used for temporary storage.
FileItem
instance represents
a simple form field.
Returns: true
if the instance represents a simple form
field; false
if it represents an uploaded file.
Returns: true
if the file contents will be read
from memory; false
otherwise.
Parameters: fieldName The name of the form field.
FileItem
instance represents
a simple form field.
Parameters: state true
if the instance represents a simple form
field; false
if it represents an uploaded file.
This implementation first attempts to rename the uploaded item to the specified destination file, if the item was originally written to disk. Otherwise, the data will be copied to the specified file.
This method is only guaranteed to work once, the first time it is invoked for a particular item. This is because, in the event that the method renames a temporary file, that file will no longer be available to copy or rename again at a later time.
Parameters: file The File
into which the uploaded item should
be stored.
Throws: Exception if an error occurs.