org.apache.commons.fileupload
Class DefaultFileItem
java.lang.Object
org.apache.commons.fileupload.DefaultFileItem
- FileItem, Serializable
public class DefaultFileItem
extends java.lang.Object
$Id: DefaultFileItem.java,v 1.21 2003/06/24 05:45:15 martinc Exp $private byte[] | cachedContent - Cached contents of the file.
|
private String | contentType - The content type passed by the browser, or
null if
not defined.
|
private static int | counter - Counter used in unique identifier generation.
|
private DeferredFileOutputStream | dfos - Output stream for this item.
|
private String | fieldName - The name of the form field as provided by the browser.
|
private String | fileName - The original filename in the user's filesystem.
|
private boolean | isFormField - Whether or not this item is a simple form field.
|
private File | repository - The directory in which uploaded files will be stored, if stored on disk.
|
private int | sizeThreshold - The threshold above which uploads will be stored on disk.
|
DefaultFileItem(String fieldName, String contentType, boolean isFormField, String fileName, int sizeThreshold, File repository) - Constructs a new
DefaultFileItem instance.
|
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 | getContentType() - Returns the content type passed by the browser or
null if
not defined.
|
String | getFieldName() - Returns the name of the field in the multipart form corresponding to
this file item.
|
InputStream | getInputStream() - Returns an
InputStream that can be
used to retrieve the contents of the file.
|
String | getName() - Returns the original filename in the client's filesystem.
|
OutputStream | getOutputStream() - Returns an
OutputStream that can
be used for storing the contents of the file.
|
long | getSize() - Returns the size of the file.
|
File | getStoreLocation() - Returns the
java.io.File object for the FileItem '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 encoding) - Returns the contents of the file as a String, using the specified
encoding.
|
protected File | getTempFile() - Creates and returns a
File representing a uniquely
named temporary file in the configured repository path.
|
private static String | getUniqueId() - Returns an identifier that is unique within the class loader used to
load this class, but does not have random-like apearance.
|
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(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(File file) - A convenience method to write an uploaded item to disk.
|
cachedContent
private byte[] cachedContent
Cached contents of the file.
contentType
private String contentType
The content type passed by the browser, or null
if
not defined.
counter
private static int counter
Counter used in unique identifier generation.
fieldName
private String fieldName
The name of the form field as provided by the browser.
fileName
private String fileName
The original filename in the user's filesystem.
isFormField
private boolean isFormField
Whether or not this item is a simple form field.
repository
private File repository
The directory in which uploaded files will be stored, if stored on disk.
sizeThreshold
private int sizeThreshold
The threshold above which uploads will be stored on disk.
DefaultFileItem
(package private) DefaultFileItem(String fieldName,
String contentType,
boolean isFormField,
String fileName,
int sizeThreshold,
File repository)
Constructs a new DefaultFileItem
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 filename in the user's filesystem, 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.
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.
- delete in interface FileItem
finalize
protected void finalize()
Removes the file contents from the temporary storage.
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.
- get in interface FileItem
- The contents of the file as an array of bytes.
getContentType
public String getContentType()
Returns the content type passed by the browser or null
if
not defined.
- getContentType in interface FileItem
- The content type passed by the browser or
null
if
not defined.
getFieldName
public String getFieldName()
Returns the name of the field in the multipart form corresponding to
this file item.
- getFieldName in interface FileItem
- The name of the form field.
setFieldName(java.lang.String)
getInputStream
public InputStream getInputStream()
throws IOException
Returns an InputStream
that can be
used to retrieve the contents of the file.
- getInputStream in interface FileItem
- An
InputStream
that can be
used to retrieve the contents of the file.
getName
public String getName()
Returns the original filename in the client's filesystem.
- getName in interface FileItem
- The original filename in the client's filesystem.
getOutputStream
public OutputStream getOutputStream()
throws IOException
Returns an OutputStream
that can
be used for storing the contents of the file.
- getOutputStream in interface FileItem
- An
OutputStream
that can be used
for storing the contensts of the file.
getSize
public long getSize()
Returns the size of the file.
- getSize in interface FileItem
- The size of the file, in bytes.
getStoreLocation
public File getStoreLocation()
Returns the java.io.File
object for the FileItem
's
data's temporary location on the disk. Note that for
FileItem
s that have their data stored in memory,
this method will return null
. When handling large
files, you can use java.io.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.
- The data file, or
null
if the data is stored in
memory.
getString
public 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.
- getString in interface FileItem
- The contents of the file, as a string.
getString
public String getString(String encoding)
throws 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.
- getString in interface FileItem
encoding
- The character encoding to use.
- The contents of the file, as a string.
getTempFile
protected File getTempFile()
Creates and returns a File
representing a uniquely
named temporary file in the configured repository path.
- The
File
to be used for temporary storage.
getUniqueId
private static String getUniqueId()
Returns an identifier that is unique within the class loader used to
load this class, but does not have random-like apearance.
- A String with the non-random looking instance identifier.
isFormField
public boolean isFormField()
Determines whether or not a FileItem
instance represents
a simple form field.
- isFormField in interface FileItem
true
if the instance represents a simple form
field; false
if it represents an uploaded file.
isInMemory
public boolean isInMemory()
Provides a hint as to whether or not the file contents will be read
from memory.
- isInMemory in interface FileItem
true
if the file contents will be read
from memory; false
otherwise.
setFieldName
public void setFieldName(String fieldName)
Sets the field name used to reference this file item.
- setFieldName in interface FileItem
fieldName
- The name of the form field.
setFormField
public void setFormField(boolean state)
Specifies whether or not a FileItem
instance represents
a simple form field.
- setFormField in interface FileItem
state
- true
if the instance represents a simple form
field; false
if it represents an uploaded file.
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.
- write in interface FileItem
file
- The File
into which the uploaded item should
be stored.
Copyright © 2002-2003 Apache Software Foundation. All Rights Reserved.