Class DiskFileItem
- All Implemented Interfaces:
FileItem
,FileItemHeadersSupport
The default implementation of the
FileItem
interface.
After retrieving an instance of this class from a FileUpload
instance (see
#parseRequest(org.apache.tomcat.util.http.fileupload.RequestContext)
), 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.
Temporary files, which are created for file items, will be deleted when the associated request is recycled.
- Since:
- 1.1
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Default content charset to be used when no explicit charset parameter is provided by the sender. -
Constructor Summary
ConstructorDescriptionDiskFileItem
(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository) Constructs a newDiskFileItem
instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Returns the content charset passed by the agent ornull
if not defined.Returns the content type passed by the agent ornull
if not defined.Returns the default charset for use when no explicit charset parameter is provided by the sender.Returns the name of the field in the multipart form corresponding to this file item.Returns the file item headers.Returns anInputStream
that can be used to retrieve the contents of the file.getName()
Returns the original file name in the client's file system.Returns anOutputStream
that can be used for storing the contents of the file.long
getSize()
Returns the size of the file.Returns theFile
object for theFileItem
's data's temporary location on the disk.Returns the contents of the file as a String, using the default character encoding.Returns the contents of the file as a String, using the specified encoding.protected File
Creates and returns aFile
representing a uniquely named temporary file in the configured repository path.boolean
Determines whether or not aFileItem
instance represents a simple form field.boolean
Provides a hint as to whether or not the file contents will be read from memory.void
setDefaultCharset
(String charset) Sets the default charset for use when no explicit charset parameter is provided by the sender.void
setFieldName
(String fieldName) Sets the field name used to reference this file item.void
setFormField
(boolean state) Specifies whether or not aFileItem
instance represents a simple form field.void
setHeaders
(FileItemHeaders pHeaders) Sets the file item headers.toString()
Returns a string representation of this object.void
A convenience method to write an uploaded item to disk.
-
Field Details
-
DEFAULT_CHARSET
Default content charset to be used when no explicit charset parameter is provided by the sender. Media subtypes of the "text" type are defined to have a default charset value of "ISO-8859-1" when received via HTTP.- See Also:
-
-
Constructor Details
-
DiskFileItem
public DiskFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository) Constructs a newDiskFileItem
instance.- Parameters:
fieldName
- The name of the form field.contentType
- The content type passed by the browser ornull
if not specified.isFormField
- Whether or not this item is a plain form field, as opposed to a file upload.fileName
- The original file name in the user's file system, ornull
if not specified.sizeThreshold
- The threshold, in bytes, below which items will be retained in memory and above which they will be stored as a file.repository
- The data repository, which is the directory in which files will be created, should the item size exceed the threshold.
-
-
Method Details
-
getInputStream
Returns anInputStream
that can be used to retrieve the contents of the file.- Specified by:
getInputStream
in interfaceFileItem
- Returns:
- An
InputStream
that can be used to retrieve the contents of the file. - Throws:
IOException
- if an error occurs.
-
getContentType
Returns the content type passed by the agent ornull
if not defined.- Specified by:
getContentType
in interfaceFileItem
- Returns:
- The content type passed by the agent or
null
if not defined.
-
getCharSet
Returns the content charset passed by the agent ornull
if not defined.- Returns:
- The content charset passed by the agent or
null
if not defined.
-
getName
Returns the original file name in the client's file system.- Specified by:
getName
in interfaceFileItem
- Returns:
- The original file name in the client's file system.
- Throws:
InvalidFileNameException
- The file name contains a NUL character, which might be an indicator of a security attack. If you intend to use the file name anyways, catch the exception and useInvalidFileNameException.getName()
.
-
isInMemory
public boolean isInMemory()Provides a hint as to whether or not the file contents will be read from memory.- Specified by:
isInMemory
in interfaceFileItem
- Returns:
true
if the file contents will be read from memory;false
otherwise.
-
getSize
public long getSize()Returns the size of the file. -
get
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.- Specified by:
get
in interfaceFileItem
- Returns:
- The contents of the file as an array of bytes
or
null
if the data cannot be read - Throws:
IOException
- if an I/O error occurs
-
getString
Returns the contents of the file as a String, using the specified encoding. This method usesget()
to retrieve the contents of the file.- Specified by:
getString
in interfaceFileItem
- Parameters:
charset
- The charset to use.- Returns:
- The contents of the file, as a string.
- Throws:
UnsupportedEncodingException
- if the requested character encoding is not available.IOException
- if an I/O error occurs
-
getString
Returns the contents of the file as a String, using the default character encoding. This method usesget()
to retrieve the contents of the file. TODO Consider making this method throw UnsupportedEncodingException. -
write
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.
-
delete
public void delete()Deletes the underlying storage for a file item, including deleting any associated temporary disk file. This method can be used to ensure that this is done at an earlier time, thus preserving system resources. -
getFieldName
Returns the name of the field in the multipart form corresponding to this file item.- Specified by:
getFieldName
in interfaceFileItem
- Returns:
- The name of the form field.
- See Also:
-
setFieldName
Sets the field name used to reference this file item.- Specified by:
setFieldName
in interfaceFileItem
- Parameters:
fieldName
- The name of the form field.- See Also:
-
isFormField
public boolean isFormField()Determines whether or not aFileItem
instance represents a simple form field.- Specified by:
isFormField
in interfaceFileItem
- Returns:
true
if the instance represents a simple form field;false
if it represents an uploaded file.- See Also:
-
setFormField
public void setFormField(boolean state) Specifies whether or not aFileItem
instance represents a simple form field.- Specified by:
setFormField
in interfaceFileItem
- Parameters:
state
-true
if the instance represents a simple form field;false
if it represents an uploaded file.- See Also:
-
getOutputStream
Returns anOutputStream
that can be used for storing the contents of the file.- Specified by:
getOutputStream
in interfaceFileItem
- Returns:
- An
OutputStream
that can be used for storing the contents of the file.
-
getStoreLocation
Returns theFile
object for theFileItem
's data's temporary location on the disk. Note that forFileItem
s that have their data stored in memory, this method will returnnull
. When handling large files, you can useFile.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.
-
finalize
protected void finalize()Removes the file contents from the temporary storage. -
getTempFile
Creates and returns aFile
representing a uniquely named temporary file in the configured repository path. The lifetime of the file is tied to the lifetime of theFileItem
instance; the file will be deleted when the instance is garbage collected.Note: Subclasses that override this method must ensure that they return the same File each time.
- Returns:
- The
File
to be used for temporary storage.
-
toString
Returns a string representation of this object. -
getHeaders
Returns the file item headers.- Specified by:
getHeaders
in interfaceFileItemHeadersSupport
- Returns:
- The file items headers.
-
setHeaders
Sets the file item headers.- Specified by:
setHeaders
in interfaceFileItemHeadersSupport
- Parameters:
pHeaders
- The file items headers.
-
getDefaultCharset
Returns the default charset for use when no explicit charset parameter is provided by the sender.- Returns:
- the default charset
-
setDefaultCharset
Sets the default charset for use when no explicit charset parameter is provided by the sender.- Parameters:
charset
- the default charset
-