Class DiskFileItem
- All Implemented Interfaces:
- FileItem<DiskFileItem>,- FileItemHeadersProvider<DiskFileItem>
FileItem interface.
 
 After retrieving an instance of this class from a DiskFileItemFactory instance (see
 org.apache.commons.fileupload2.core.servlet.ServletFileUpload
 #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.
 
 Temporary files, which are created for file items, should be deleted later on. The best way to do this is using a
 FileCleaningTracker, which you can set on the DiskFileItemFactory. However, if you do use such a tracker, then you must
 consider the following: Temporary files are automatically deleted as soon as they are no longer needed. (More precisely, when the corresponding instance of
 File is garbage collected.) This is done by the so-called reaper thread, which is started and stopped automatically by the
 FileCleaningTracker when there are files to be tracked. It might make sense to terminate that thread, for example, if your web
 application ends. See the section on "Resource cleanup" in the users guide of Commons FileUpload.
 
- 
Nested Class SummaryNested Classes
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final CharsetDefault content charset to be used when no explicit charset parameter is provided by the sender.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DiskFileItem.Builderbuilder()Constructs a newDiskFileItem.Builder.static StringcheckFileName(String fileName) Tests if the file name is valid.delete()Deletes the underlying storage for a file item, including deleting any associated temporary disk file.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 default charset for use when no explicit charset parameter is provided by the sender.Gets the content type passed by the agent ornullif not defined.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.getPath()Gets thePathfor theFileItem's data's temporary location on the disk.longgetSize()Gets the size of the file.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 PathCreates 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.setCharsetDefault(Charset charset) Sets the default charset for use when no explicit charset parameter is provided by the sender.setFieldName(String fieldName) Sets the field name used to reference this file item.setFormField(boolean state) Specifies whether or not aFileIteminstance represents a simple form field.setHeaders(FileItemHeaders headers) Sets the file item headers.toString()Returns a string representation of this object.Writes 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.
 
- 
- 
Method Details- 
builderConstructs a newDiskFileItem.Builder.- Returns:
- a new DiskFileItem.Builder.
 
- 
checkFileNameTests if the file name is valid. For example, if it contains a NUL characters, it's invalid. If the file name is valid, it will be returned without any modifications. Otherwise, throw anInvalidPathException.- Parameters:
- fileName- The file name to check
- Returns:
- Unmodified file name, if valid.
- Throws:
- InvalidPathException- The file name is invalid.
 
- 
deleteDeletes 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.- Specified by:
- deletein interface- FileItem<DiskFileItem>
- Returns:
- thisinstance.
- Throws:
- IOException- if an error occurs.
 
- 
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<DiskFileItem>
- Returns:
- The contents of the file as an array of bytes or nullif the data cannot be read.
- Throws:
- IOException- if an I/O error occurs.
- OutOfMemoryError- See- Files.readAllBytes(Path): If an array of the required size cannot be allocated, for example the file is larger that- 2GB
 
- 
getCharsetGets the content charset passed by the agent ornullif not defined.- Returns:
- The content charset passed by the agent or nullif not defined.
 
- 
getCharsetDefaultGets the default charset for use when no explicit charset parameter is provided by the sender.- Returns:
- the default charset
 
- 
getContentTypeGets the content type passed by the agent ornullif not defined.- Specified by:
- getContentTypein interface- FileItem<DiskFileItem>
- Returns:
- The content type passed by the agent or nullif not defined.
 
- 
getFieldNameGets the name of the field in the multipart form corresponding to this file item.- Specified by:
- getFieldNamein interface- FileItem<DiskFileItem>
- Returns:
- The name of the form field.
- See Also:
 
- 
getHeadersGets the file item headers.- Specified by:
- getHeadersin interface- FileItemHeadersProvider<DiskFileItem>
- Returns:
- The file items headers.
 
- 
getInputStreamGets anInputStreamthat can be used to retrieve the contents of the file.- Specified by:
- getInputStreamin interface- FileItem<DiskFileItem>
- 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<DiskFileItem>
- Returns:
- The original file name in the client's file system.
- Throws:
- InvalidPathException- 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- InvalidPathException.getInput().
 
- 
getOutputStreamGets anOutputStreamthat can be used for storing the contents of the file.- Specified by:
- getOutputStreamin interface- FileItem<DiskFileItem>
- Returns:
- An OutputStreamthat can be used for storing the contents of the file.
 
- 
getPathGets thePathfor 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 useFiles.move(Path,Path,CopyOption...)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.
 
- 
getSizeGets the size of the file.- Specified by:
- getSizein interface- FileItem<DiskFileItem>
- Returns:
- The size of the file, in bytes.
 
- 
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. - Specified by:
- getStringin interface- FileItem<DiskFileItem>
- Returns:
- The contents of the file, as a string.
- Throws:
- IOException- if an I/O error occurs
 
- 
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<DiskFileItem>
- Parameters:
- charset- The charset to use.
- Returns:
- The contents of the file, as a string.
- Throws:
- IOException- if an I/O error occurs
 
- 
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.
 
- 
isFormFieldTests whether or not aFileIteminstance represents a simple form field.- Specified by:
- isFormFieldin interface- FileItem<DiskFileItem>
- Returns:
- trueif the instance represents a simple form field;- falseif it represents an uploaded file.
- See Also:
 
- 
isInMemoryProvides a hint as to whether or not the file contents will be read from memory.- Specified by:
- isInMemoryin interface- FileItem<DiskFileItem>
- Returns:
- trueif the file contents will be read from memory;- falseotherwise.
 
- 
setCharsetDefaultSets the default charset for use when no explicit charset parameter is provided by the sender.- Parameters:
- charset- the default charset
- Returns:
- thisinstance.
 
- 
setFieldNameSets the field name used to reference this file item.- Specified by:
- setFieldNamein interface- FileItem<DiskFileItem>
- Parameters:
- fieldName- The name of the form field.
- Returns:
- thisinstance.
- See Also:
 
- 
setFormFieldSpecifies whether or not aFileIteminstance represents a simple form field.- Specified by:
- setFormFieldin interface- FileItem<DiskFileItem>
- Parameters:
- state-- trueif the instance represents a simple form field;- falseif it represents an uploaded file.
- Returns:
- thisinstance.
- See Also:
 
- 
setHeadersSets the file item headers.- Specified by:
- setHeadersin interface- FileItemHeadersProvider<DiskFileItem>
- Parameters:
- headers- The file items headers.
- Returns:
- thisinstance.
 
- 
toStringReturns a string representation of this object.
- 
writeWrites 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. - Specified by:
- writein interface- FileItem<DiskFileItem>
- Parameters:
- file- The- Fileinto which the uploaded item should be stored.
- Returns:
- thisinstance.
- Throws:
- IOException- if an error occurs.
 
 
-