Interface FileItem
-
- All Superinterfaces:
FileItemHeadersSupport
- All Known Implementing Classes:
DiskFileItem
public interface FileItem extends FileItemHeadersSupport
This class represents a file or form item that was received within a
multipart/form-dataPOST request.After retrieving an instance of this class from a
FileUploadinstance (see#parseRequest(RequestContext)), you may either request all contents of the 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.While this interface does not extend
javax.activation.DataSourceper se (to avoid a seldom used dependency), several of the defined methods are specifically defined with the same signatures as methods in that interface. This allows an implementation of this interface to also implementjavax.activation.DataSourcewith minimal additional work.- Since:
- 1.3 additionally implements FileItemHeadersSupport
-
-
Method Summary
All Methods Instance Methods Abstract 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 item as an array of bytes.StringgetContentType()Returns the content type passed by the browser ornullif not defined.StringgetFieldName()Returns the name of the field in the multipart form corresponding to this file item.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, as provided by the browser (or other client software).OutputStreamgetOutputStream()Returns anOutputStreamthat can be used for storing the contents of the file.longgetSize()Returns the size of the file item.StringgetString()Returns the contents of the file item as a String, using the default character encoding.StringgetString(String encoding)Returns the contents of the file item as a String, using the specified encoding.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.voidsetFieldName(String name)Sets the field name used to reference this file item.voidsetFormField(boolean state)Specifies whether or not aFileIteminstance represents a simple form field.voidwrite(File file)A convenience method to write an uploaded item to disk.-
Methods inherited from interface org.apache.tomcat.util.http.fileupload.FileItemHeadersSupport
getHeaders, setHeaders
-
-
-
-
Method Detail
-
getInputStream
InputStream getInputStream() throws IOException
Returns anInputStreamthat can be used to retrieve the contents of the file.- Returns:
- An
InputStreamthat can be used to retrieve the contents of the file. - Throws:
IOException- if an error occurs.
-
getContentType
String getContentType()
Returns the content type passed by the browser ornullif not defined.- Returns:
- The content type passed by the browser or
nullif not defined.
-
getName
String getName()
Returns the original file name in the client's file system, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.- 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().
-
isInMemory
boolean isInMemory()
Provides a hint as to whether or not the file contents will be read from memory.- Returns:
trueif the file contents will be read from memory;falseotherwise.
-
getSize
long getSize()
Returns the size of the file item.- Returns:
- The size of the file item, in bytes.
-
get
byte[] get() throws UncheckedIOExceptionReturns the contents of the file item as an array of bytes.- Returns:
- The contents of the file item as an array of bytes.
- Throws:
UncheckedIOException- if an I/O error occurs
-
getString
String getString(String encoding) throws UnsupportedEncodingException, IOException
Returns the contents of the file item as a String, using the specified encoding. This method usesget()to retrieve the contents of the item.- Parameters:
encoding- The character encoding to use.- Returns:
- The contents of the item, as a string.
- Throws:
UnsupportedEncodingException- if the requested character encoding is not available.IOException- if an I/O error occurs
-
getString
String getString()
Returns the contents of the file item as a String, using the default character encoding. This method usesget()to retrieve the contents of the item.- Returns:
- The contents of the item, as a string.
-
write
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 method is not guaranteed to succeed if called more than once for the same item. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit.
- Parameters:
file- TheFileinto which the uploaded item should be stored.- Throws:
Exception- if an error occurs.
-
delete
void delete()
Deletes the underlying storage for a file item, including deleting any associated temporary disk file. Although this storage will be deleted automatically when theFileIteminstance is garbage collected, this method can be used to ensure that this is done at an earlier time, thus preserving system resources.
-
getFieldName
String getFieldName()
Returns the name of the field in the multipart form corresponding to this file item.- Returns:
- The name of the form field.
-
setFieldName
void setFieldName(String name)
Sets the field name used to reference this file item.- Parameters:
name- The name of the form field.
-
isFormField
boolean isFormField()
Determines whether or not aFileIteminstance represents a simple form field.- Returns:
trueif the instance represents a simple form field;falseif it represents an uploaded file.
-
setFormField
void setFormField(boolean state)
Specifies whether or not aFileIteminstance represents a simple form field.- Parameters:
state-trueif the instance represents a simple form field;falseif it represents an uploaded file.
-
getOutputStream
OutputStream getOutputStream() throws IOException
Returns anOutputStreamthat can be used for storing the contents of the file.- Returns:
- An
OutputStreamthat can be used for storing the contents of the file. - Throws:
IOException- if an error occurs.
-
-