| java.lang.Object
 org.apache.tomcat.util.http.fileupload.DefaultFileItem
| Constructor Summary | |
| | DefaultFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository)
Constructs a new DefaultFileItem instance. |
| Method Summary | |
| public 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. | | public byte[] | get()
Returns the contents of the file as an array of bytes. | | public String | getContentType()
Returns the content type passed by the browser or null if
not defined. | | public String | getFieldName()
Returns the name of the field in the multipart form corresponding to
this file item. | | public InputStream | getInputStream()
Returns an
java.io.InputStream InputStream that can be
used to retrieve the contents of the file. | | public String | getName()
Returns the original filename in the client's filesystem. | | public OutputStream | getOutputStream()
Returns an
java.io.OutputStream OutputStream that can
be used for storing the contents of the file. | | public long | getSize()
Returns the size of the file. | | public File | getStoreLocation()
Returns the
java.io.File object for the FileItem's
data's temporary location on the disk. | | public String | getString(String encoding)
Returns the contents of the file as a String, using the specified
encoding. | | public 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. | | public boolean | isFormField()
Determines whether or not a FileItem instance represents
a simple form field. | | public boolean | isInMemory()
Provides a hint as to whether or not the file contents will be read
from memory. | | public void | setFieldName(String fieldName)
Sets the field name used to reference this file item. | | public void | setFormField(boolean state)
Specifies whether or not a FileItem instance represents
a simple form field. | | public void | write(File file)
A convenience method to write an uploaded item to disk. |
| DefaultFileItem | | DefaultFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository)(Code) | | Constructs a new DefaultFileItem instance.
Parameters:
fieldName - The name of the form field.
Parameters:
contentType - The content type passed by the browser ornull if not specified.
Parameters:
isFormField - Whether or not this item is a plain form field, asopposed to a file upload.
Parameters:
fileName - The original filename in the user's filesystem, ornull if not specified.
Parameters:
sizeThreshold - The threshold, in bytes, below which items will beretained in memory and above which they will bestored as a file.
Parameters:
repository - The data repository, which is the directory inwhich files will be created, should the item sizeexceed the threshold. |
| delete | | public void delete()(Code) | | 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.
|
| finalize | | protected void finalize()(Code) | | Removes the file contents from the temporary storage.
|
| get | | public byte[] get()(Code) | | Returns the contents of the file as an array of bytes. If the
contents of the file were not yet cached in memory, they will be
loaded from the disk storage and cached.
The contents of the file as an array of bytes. |
| getContentType | | public String getContentType()(Code) | | Returns the content type passed by the browser or null if
not defined.
The content type passed by the browser or null ifnot defined. |
| getName | | public String getName()(Code) | | Returns the original filename in the client's filesystem.
The original filename in the client's filesystem. |
| getSize | | public long getSize()(Code) | | Returns the size of the file.
The size of the file, in bytes. |
| getStoreLocation | | public File getStoreLocation()(Code) | | Returns the
java.io.File object for the FileItem's
data's temporary location on the disk. Note that for
FileItems 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.
The data file, or null if the data is stored inmemory. |
| getString | | public String getString()(Code) | | Returns the contents of the file as a String, using the default
character encoding. This method uses
DefaultFileItem.get() to retrieve the
contents of the file.
The contents of the file, as a string. |
| getTempFile | | protected File getTempFile()(Code) | | Creates and returns a
java.io.File File representing a uniquely
named temporary file in the configured repository path.
The java.io.File File to be used for temporary storage. |
| isFormField | | public boolean isFormField()(Code) | | Determines whether or not a FileItem instance represents
a simple form field.
true if the instance represents a simple formfield; false if it represents an uploaded file.
See Also: DefaultFileItem.setFormField(boolean) |
| isInMemory | | public boolean isInMemory()(Code) | | Provides a hint as to whether or not the file contents will be read
from memory.
true if the file contents will be readfrom memory; false otherwise. |
| setFormField | | public void setFormField(boolean state)(Code) | | Specifies whether or not a FileItem instance represents
a simple form field.
Parameters:
state - true if the instance represents a simple formfield; false if it represents an uploaded file.
See Also: DefaultFileItem.isFormField() |
| write | | public void write(File file) throws Exception(Code) | | 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 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 shouldbe stored.
exception:
Exception - if an error occurs. |
|
|