Apache Tomcat 6.0.41

org.apache.tomcat.util.http.fileupload
Class DefaultFileItem

java.lang.Object
  extended by org.apache.tomcat.util.http.fileupload.DefaultFileItem
All Implemented Interfaces:
java.io.Serializable, FileItem

public class DefaultFileItem
extends java.lang.Object
implements FileItem

The default implementation of the FileItem interface.

After retrieving an instance of this class from a DiskFileUpload instance (see #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.

Author:
Rafal Krzewski, Sean Legassick, Jason van Zyl, John McNally, Martin Cooper, Sean C. Sullivan
See Also:
Serialized Form

Method Summary
 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.
 java.lang.String getContentType()
          Returns the content type passed by the browser or null if not defined.
 java.lang.String getFieldName()
          Returns the name of the field in the multipart form corresponding to this file item.
 java.io.InputStream getInputStream()
          Returns an InputStream that can be used to retrieve the contents of the file.
 java.lang.String getName()
          Returns the original filename in the client's filesystem.
 java.io.OutputStream getOutputStream()
          Returns an OutputStream that can be used for storing the contents of the file.
 long getSize()
          Returns the size of the file.
 java.io.File getStoreLocation()
          Returns the File object for the FileItem's data's temporary location on the disk.
 java.lang.String getString()
          Returns the contents of the file as a String, using the default character encoding.
 java.lang.String getString(java.lang.String encoding)
          Returns the contents of the file as a String, using the specified encoding.
protected  java.io.File getTempFile()
          Creates and returns a File representing a uniquely named temporary file in the configured repository path.
 boolean isFormField()
          Determines whether or not a FileItem instance represents a simple form field.
 boolean isInMemory()
          Provides a hint as to whether or not the file contents will be read from memory.
 void setFieldName(java.lang.String fieldName)
          Sets the field name used to reference this file item.
 void setFormField(boolean state)
          Specifies whether or not a FileItem instance represents a simple form field.
 void write(java.io.File file)
          A convenience method to write an uploaded item to disk.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException
Returns an InputStream that can be used to retrieve the contents of the file.

Specified by:
getInputStream in interface FileItem
Returns:
An InputStream that can be used to retrieve the contents of the file.
Throws:
java.io.IOException - if an error occurs.

getContentType

public java.lang.String getContentType()
Returns the content type passed by the browser or null if not defined.

Specified by:
getContentType in interface FileItem
Returns:
The content type passed by the browser or null if not defined.

getName

public java.lang.String getName()
Returns the original filename in the client's filesystem.

Specified by:
getName in interface FileItem
Returns:
The original filename in the client's filesystem.

isInMemory

public boolean isInMemory()
Provides a hint as to whether or not the file contents will be read from memory.

Specified by:
isInMemory in interface FileItem
Returns:
true if the file contents will be read from memory; false otherwise.

getSize

public long getSize()
Returns the size of the file.

Specified by:
getSize in interface FileItem
Returns:
The size of the file, in bytes.

get

public byte[] get()
Returns 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:
get in interface FileItem
Returns:
The contents of the file as an array of bytes.

getString

public java.lang.String getString(java.lang.String encoding)
                           throws java.io.UnsupportedEncodingException
Returns the contents of the file as a String, using the specified encoding. This method uses get() to retrieve the contents of the file.

Specified by:
getString in interface FileItem
Parameters:
encoding - The character encoding to use.
Returns:
The contents of the file, as a string.
Throws:
java.io.UnsupportedEncodingException - if the requested character encoding is not available.

getString

public java.lang.String getString()
Returns the contents of the file as a String, using the default character encoding. This method uses get() to retrieve the contents of the file.

Specified by:
getString in interface FileItem
Returns:
The contents of the file, as a string.

write

public void write(java.io.File file)
           throws java.lang.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.

Specified by:
write in interface FileItem
Parameters:
file - The File into which the uploaded item should be stored.
Throws:
java.lang.Exception - if an error occurs.

delete

public 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 the FileItem instance is garbage collected, this method can be used to ensure that this is done at an earlier time, thus preserving system resources.

Specified by:
delete in interface FileItem

getFieldName

public java.lang.String getFieldName()
Returns the name of the field in the multipart form corresponding to this file item.

Specified by:
getFieldName in interface FileItem
Returns:
The name of the form field.
See Also:
setFieldName(java.lang.String)

setFieldName

public void setFieldName(java.lang.String fieldName)
Sets the field name used to reference this file item.

Specified by:
setFieldName in interface FileItem
Parameters:
fieldName - The name of the form field.
See Also:
getFieldName()

isFormField

public boolean isFormField()
Determines whether or not a FileItem instance represents a simple form field.

Specified by:
isFormField in interface FileItem
Returns:
true if the instance represents a simple form field; false if it represents an uploaded file.
See Also:
setFormField(boolean)

setFormField

public void setFormField(boolean state)
Specifies whether or not a FileItem instance represents a simple form field.

Specified by:
setFormField in interface FileItem
Parameters:
state - true if the instance represents a simple form field; false if it represents an uploaded file.
See Also:
isFormField()

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
Returns an OutputStream that can be used for storing the contents of the file.

Specified by:
getOutputStream in interface FileItem
Returns:
An OutputStream that can be used for storing the contensts of the file.
Throws:
java.io.IOException - if an error occurs.

getStoreLocation

public java.io.File getStoreLocation()
Returns the 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.

Returns:
The data file, or null if the data is stored in memory.

finalize

protected void finalize()
Removes the file contents from the temporary storage.

Overrides:
finalize in class java.lang.Object

getTempFile

protected java.io.File getTempFile()
Creates and returns a File representing a uniquely named temporary file in the configured repository path.

Returns:
The File to be used for temporary storage.

Apache Tomcat 6.0.41

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.