Class DiskFileItem
- All Implemented Interfaces:
- FileItem,- FileItemHeadersSupport
FileItem interface.
 
 After retrieving an instance of this class from a DiskFileItemFactory 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:
- FileUpload 1.1
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringDefault content charset to be used when no explicit charset parameter is provided by the sender.
- 
Constructor SummaryConstructorsConstructorDescriptionDiskFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository) Constructs a newDiskFileIteminstance.
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()Deletes the underlying storage for a file item, including deleting any associated temporary disk file.protected voidfinalize()Removes the file contents from the temporary storage.byte[]get()Gets the contents of the file as an array of bytes.Gets the content charset passed by the agent ornullif not defined.Gets the content type passed by the agent ornullif not defined.Gets the default charset for use when no explicit charset parameter is provided by the sender.Gets the name of the field in the multipart form corresponding to this file item.Gets the file item headers.Gets anInputStreamthat can be used to retrieve the contents of the file.getName()Gets the original file name in the client's file system.Gets anOutputStreamthat can be used for storing the contents of the file.longgetSize()Gets the size of the file.Gets theFileobject for theFileItem's data's temporary location on the disk.Gets the contents of the file as a String, using the default character encoding.Gets the contents of the file as a String, using the specified encoding.protected FileCreates and returns aFilerepresenting a uniquely named temporary file in the configured repository path.booleanTests whether or not aFileIteminstance represents a simple form field.booleanProvides a hint as to whether or not the file contents will be read from memory.voidsetDefaultCharset(String charset) Sets the default charset for use when no explicit charset parameter is provided by the sender.voidsetFieldName(String fieldName) Sets the field name used to reference this file item.voidsetFormField(boolean formField) Sets whether or not aFileIteminstance represents a simple form field.voidsetHeaders(FileItemHeaders headers) Sets the file item headers.toString()Returns a string representation of this object.voidA convenience method to write an uploaded item to disk.
- 
Field Details- 
DEFAULT_CHARSETDefault 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- 
DiskFileItempublic DiskFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository) Constructs a newDiskFileIteminstance.- Parameters:
- fieldName- The name of the form field.
- contentType- The content type passed by the browser or- nullif 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, or- nullif 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- 
delete
- 
finalizeRemoves the file contents from the temporary storage.- Overrides:
- finalizein class- Object
- Throws:
- Throwable- Thrown by- Object.finalize().
 
- 
getGets 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:
- getin interface- FileItem
- Returns:
- The contents of the file as an array of bytes or nullif the data cannot be read.
- Throws:
- UncheckedIOException- if an I/O error occurs
- ArithmeticException- if the file- sizeoverflows an int
 
- 
getCharSetGets the content charset passed by the agent ornullif not defined.- Returns:
- The content charset passed by the agent or nullif not defined.
 
- 
getContentTypeGets the content type passed by the agent ornullif not defined.- Specified by:
- getContentTypein interface- FileItem
- Returns:
- The content type passed by the agent or nullif not defined.
 
- 
getDefaultCharsetGets the default charset for use when no explicit charset parameter is provided by the sender.- Returns:
- the default charset
 
- 
getFieldNameGets the name of the field in the multipart form corresponding to this file item.- Specified by:
- getFieldNamein interface- FileItem
- Returns:
- The name of the form field.
- See Also:
 
- 
getHeadersGets the file item headers.- Specified by:
- getHeadersin interface- FileItemHeadersSupport
- Returns:
- The file items headers.
 
- 
getInputStreamGets anInputStreamthat can be used to retrieve the contents of the file.- Specified by:
- getInputStreamin interface- FileItem
- Returns:
- An InputStreamthat can be used to retrieve the contents of the file.
- Throws:
- IOException- if an error occurs.
 
- 
getNameGets the original file name in the client's file system.- Specified by:
- getNamein interface- FileItem
- 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 use- InvalidFileNameException.getName().
 
- 
getOutputStreamGets anOutputStreamthat can be used for storing the contents of the file.- Specified by:
- getOutputStreamin interface- FileItem
- Returns:
- An OutputStreamthat can be used for storing the contents of the file.
 
- 
getSize
- 
getStoreLocationGets theFileobject for theFileItem's data's temporary location on the disk. Note that forFileItems 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 nullif the data is stored in memory.
 
- 
getStringGets 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. 
- 
getStringGets the contents of the file as a String, using the specified encoding. This method usesget()to retrieve the contents of the file.- Specified by:
- getStringin interface- FileItem
- 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.
 
- 
getTempFileCreates and returns aFilerepresenting a uniquely named temporary file in the configured repository path. The lifetime of the file is tied to the lifetime of theFileIteminstance; 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 Fileto be used for temporary storage.
 
- 
isFormFieldpublic boolean isFormField()Tests whether or not aFileIteminstance represents a simple form field.- Specified by:
- isFormFieldin interface- FileItem
- Returns:
- trueif the instance represents a simple form field;- falseif it represents an uploaded file.
- See Also:
 
- 
isInMemorypublic boolean isInMemory()Provides a hint as to whether or not the file contents will be read from memory.- Specified by:
- isInMemoryin interface- FileItem
- Returns:
- trueif the file contents will be read from memory;- falseotherwise.
 
- 
setDefaultCharsetSets the default charset for use when no explicit charset parameter is provided by the sender.- Parameters:
- charset- the default charset
 
- 
setFieldNameSets the field name used to reference this file item.- Specified by:
- setFieldNamein interface- FileItem
- Parameters:
- fieldName- The name of the form field.
- See Also:
 
- 
setFormFieldpublic void setFormField(boolean formField) Sets whether or not aFileIteminstance represents a simple form field.- Specified by:
- setFormFieldin interface- FileItem
- Parameters:
- formField-- trueif the instance represents a simple form field;- falseif it represents an uploaded file.
- See Also:
 
- 
setHeadersSets the file item headers.- Specified by:
- setHeadersin interface- FileItemHeadersSupport
- Parameters:
- headers- The file items headers.
 
- 
toString
- 
writeA 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. 
 
-