public class DiskFileItem extends Object implements FileItem
 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, should be deleted later on.
| Modifier and Type | Field and Description | 
|---|---|
| static String | DEFAULT_CHARSETDefault content charset to be used when no explicit charset
 parameter is provided by the sender. | 
| Constructor and Description | 
|---|
| DiskFileItem(String fieldName,
            String contentType,
            boolean isFormField,
            String fileName,
            int sizeThreshold,
            File repository)Constructs a new  DiskFileIteminstance. | 
| Modifier and Type | Method and Description | 
|---|---|
| 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 | getCharSet()Returns the content charset passed by the agent or  nullif
 not defined. | 
| String | getContentType()Returns the content type passed by the agent or  nullif
 not defined. | 
| String | getDefaultCharset()Returns the default charset for use when no explicit charset
 parameter is provided by the sender. | 
| String | getFieldName()Returns the name of the field in the multipart form corresponding to
 this file item. | 
| FileItemHeaders | getHeaders()Returns the file item headers. | 
| InputStream | getInputStream()Returns an  InputStreamthat can be
 used to retrieve the contents of the file. | 
| String | getName()Returns the original file name in the client's file system. | 
| OutputStream | getOutputStream()Returns an  OutputStreamthat can
 be used for storing the contents of the file. | 
| long | getSize()Returns the size of the file. | 
| File | getStoreLocation()Returns the  Fileobject for theFileItem's
 data's temporary location on the disk. | 
| String | getString()Returns the contents of the file as a String, using the default
 character encoding. | 
| String | getString(String charset)Returns the contents of the file as a String, using the specified
 encoding. | 
| protected File | getTempFile()Creates and returns a  Filerepresenting a uniquely
 named temporary file in the configured repository path. | 
| boolean | isFormField()Determines whether or not a  FileIteminstance represents
 a simple form field. | 
| boolean | isInMemory()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 a  FileIteminstance represents
 a simple form field. | 
| void | setHeaders(FileItemHeaders pHeaders)Sets the file item headers. | 
| String | toString()Returns a string representation of this object. | 
| void | write(File file)A convenience method to write an uploaded item to disk. | 
public static final String DEFAULT_CHARSET
public DiskFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository)
DiskFileItem instance.fieldName - The name of the form field.contentType - The content type passed by the browser or
                      null 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, or
                      null 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.public InputStream getInputStream() throws IOException
InputStream that can be
 used to retrieve the contents of the file.getInputStream in interface FileItemInputStream that can be
         used to retrieve the contents of the file.IOException - if an error occurs.public String getContentType()
null if
 not defined.getContentType in interface FileItemnull if
         not defined.public String getCharSet()
null if
 not defined.null if
         not defined.public String getName()
getName in interface FileItemInvalidFileNameException - 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().public boolean isInMemory()
isInMemory in interface FileItemtrue if the file contents will be read
         from memory; false otherwise.public long getSize()
public byte[] get()
public String getString(String charset) throws UnsupportedEncodingException
get() to retrieve the
 contents of the file.getString in interface FileItemcharset - The charset to use.UnsupportedEncodingException - if the requested character
                                      encoding is not available.public String getString()
get() to retrieve the
 contents of the file.
 TODO Consider making this method throw UnsupportedEncodingException.public void write(File file) throws Exception
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.
public void delete()
FileItem instance is garbage
 collected, this method can be used to ensure that this is done at an
 earlier time, thus preserving system resources.public String getFieldName()
getFieldName in interface FileItemsetFieldName(java.lang.String)public void setFieldName(String fieldName)
setFieldName in interface FileItemfieldName - The name of the form field.getFieldName()public boolean isFormField()
FileItem instance represents
 a simple form field.isFormField in interface FileItemtrue if the instance represents a simple form
         field; false if it represents an uploaded file.setFormField(boolean)public void setFormField(boolean state)
FileItem instance represents
 a simple form field.setFormField in interface FileItemstate - true if the instance represents a simple form
              field; false if it represents an uploaded file.isFormField()public OutputStream getOutputStream() throws IOException
OutputStream that can
 be used for storing the contents of the file.getOutputStream in interface FileItemOutputStream that can be used
         for storing the contents of the file.IOException - if an error occurs.public File getStoreLocation()
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 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.null if the data is stored in
         memory.protected void finalize()
                 throws Throwable
protected File getTempFile()
File representing a uniquely
 named temporary file in the configured repository path. The lifetime of
 the file is tied to the lifetime of the FileItem 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.
File to be used for temporary storage.public String toString()
public FileItemHeaders getHeaders()
getHeaders in interface FileItemHeadersSupportpublic void setHeaders(FileItemHeaders pHeaders)
setHeaders in interface FileItemHeadersSupportpHeaders - The file items headers.public String getDefaultCharset()
public void setDefaultCharset(String charset)
charset - the default charsetCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.