Class DiskFileItem
- java.lang.Object
-
- org.apache.tomcat.util.http.fileupload.disk.DiskFileItem
-
- All Implemented Interfaces:
FileItem,FileItemHeadersSupport
public class DiskFileItem extends Object implements FileItem
The default implementation of the
FileIteminterface.After retrieving an instance of this class from a
FileUploadinstance (see#parseRequest(org.apache.tomcat.util.http.fileupload.RequestContext)), you may either request all contents of file at once usingget()or request anInputStreamwithgetInputStream()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.
- Since:
- 1.1
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_CHARSETDefault content charset to be used when no explicit charset parameter is provided by the sender.
-
Constructor Summary
Constructors Constructor Description DiskFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository)Constructs a newDiskFileIteminstance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddelete()Deletes the underlying storage for a file item, including deleting any associated temporary disk file.byte[]get()Returns the contents of the file as an array of bytes.StringgetCharSet()Returns the content charset passed by the agent ornullif not defined.StringgetContentType()Returns the content type passed by the agent ornullif not defined.StringgetDefaultCharset()Returns the default charset for use when no explicit charset parameter is provided by the sender.StringgetFieldName()Returns the name of the field in the multipart form corresponding to this file item.FileItemHeadersgetHeaders()Returns the file item headers.InputStreamgetInputStream()Returns anInputStreamthat can be used to retrieve the contents of the file.StringgetName()Returns the original file name in the client's file system.OutputStreamgetOutputStream()Returns anOutputStreamthat can be used for storing the contents of the file.longgetSize()Returns the size of the file.FilegetStoreLocation()Returns theFileobject for theFileItem's data's temporary location on the disk.StringgetString()Returns the contents of the file as a String, using the default character encoding.StringgetString(String charset)Returns the contents of the file as a String, using the specified encoding.protected FilegetTempFile()Creates and returns aFilerepresenting a uniquely named temporary file in the configured repository path.booleanisFormField()Determines whether or not aFileIteminstance represents a simple form field.booleanisInMemory()Provides 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 state)Specifies whether or not aFileIteminstance represents a simple form field.voidsetHeaders(FileItemHeaders pHeaders)Sets the file item headers.StringtoString()Returns a string representation of this object.voidwrite(File file)A convenience method to write an uploaded item to disk.
-
-
-
Field Detail
-
DEFAULT_CHARSET
public static final String 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:
- Constant Field Values
-
-
Constructor Detail
-
DiskFileItem
public 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 ornullif 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, ornullif 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 Detail
-
getInputStream
public InputStream getInputStream() throws IOException
Returns anInputStreamthat can be used to retrieve the contents of the file.- Specified by:
getInputStreamin interfaceFileItem- Returns:
- An
InputStreamthat can be used to retrieve the contents of the file. - Throws:
IOException- if an error occurs.
-
getContentType
public String getContentType()
Returns the content type passed by the agent ornullif not defined.- Specified by:
getContentTypein interfaceFileItem- Returns:
- The content type passed by the agent or
nullif not defined.
-
getCharSet
public String getCharSet()
Returns the content charset passed by the agent ornullif not defined.- Returns:
- The content charset passed by the agent or
nullif not defined.
-
getName
public String getName()
Returns the original file name in the client's file system.- Specified by:
getNamein 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:
isInMemoryin interfaceFileItem- Returns:
trueif the file contents will be read from memory;falseotherwise.
-
getSize
public long getSize()
Returns the size of the file.
-
get
public byte[] get() throws UncheckedIOExceptionReturns 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 interfaceFileItem- 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
-
getString
public String getString(String charset) throws UnsupportedEncodingException, IOException
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:
getStringin 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
public String 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
public void write(File file) throws Exception
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
public String getFieldName()
Returns the name of the field in the multipart form corresponding to this file item.- Specified by:
getFieldNamein interfaceFileItem- Returns:
- The name of the form field.
- See Also:
setFieldName(String)
-
setFieldName
public void setFieldName(String fieldName)
Sets the field name used to reference this file item.- Specified by:
setFieldNamein interfaceFileItem- Parameters:
fieldName- The name of the form field.- See Also:
getFieldName()
-
isFormField
public boolean isFormField()
Determines whether or not aFileIteminstance represents a simple form field.- Specified by:
isFormFieldin interfaceFileItem- Returns:
trueif the instance represents a simple form field;falseif it represents an uploaded file.- See Also:
setFormField(boolean)
-
setFormField
public void setFormField(boolean state)
Specifies whether or not aFileIteminstance represents a simple form field.- Specified by:
setFormFieldin interfaceFileItem- Parameters:
state-trueif the instance represents a simple form field;falseif it represents an uploaded file.- See Also:
isFormField()
-
getOutputStream
public OutputStream getOutputStream()
Returns anOutputStreamthat can be used for storing the contents of the file.- Specified by:
getOutputStreamin interfaceFileItem- Returns:
- An
OutputStreamthat can be used for storing the contents of the file.
-
getStoreLocation
public File getStoreLocation()
Returns 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.
-
getTempFile
protected File getTempFile()
Creates 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.
-
toString
public String toString()
Returns a string representation of this object.
-
getHeaders
public FileItemHeaders getHeaders()
Returns the file item headers.- Specified by:
getHeadersin interfaceFileItemHeadersSupport- Returns:
- The file items headers.
-
setHeaders
public void setHeaders(FileItemHeaders pHeaders)
Sets the file item headers.- Specified by:
setHeadersin interfaceFileItemHeadersSupport- Parameters:
pHeaders- The file items headers.
-
getDefaultCharset
public String getDefaultCharset()
Returns the default charset for use when no explicit charset parameter is provided by the sender.- Returns:
- the default charset
-
setDefaultCharset
public void setDefaultCharset(String charset)
Sets the default charset for use when no explicit charset parameter is provided by the sender.- Parameters:
charset- the default charset
-
-