|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.wicket.util.upload.DiskFileItem
public class DiskFileItem
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.
When using the DiskFileItemFactory, then you should consider the following:
Temporary files are automatically deleted as soon as they are no longer needed. (More precisely,
when the corresponding instance of File is garbage collected.) This is done by
the so-called reaper thread, which is started automatically when the class
org.apache.commons.io.FileCleaner is loaded. It might make sense to terminate that
thread, for example, if your web application ends. See the section on "Resource cleanup" in the
users guide of commons-fileupload.
| Field Summary | |
|---|---|
static String |
DEFAULT_CHARSET
Default content charset to be used when no explicit charset parameter is provided by the sender. |
| Constructor Summary | |
|---|---|
DiskFileItem(String fieldName,
String contentType,
boolean isFormField,
String fileName,
int sizeThreshold,
File repository,
IFileCleaner fileUploadCleaner)
Constructs a new DiskFileItem instance. |
|
| 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. |
String |
getCharSet()
Returns the content charset passed by the agent or null if not defined. |
String |
getContentType()
Returns the content type passed by the agent or null if not defined. |
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 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 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 charset)
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. |
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 |
setHeaders(FileItemHeaders pHeaders)
Sets the file item headers. |
String |
toString()
|
void |
write(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, wait, wait, wait |
| Field Detail |
|---|
public static final String DEFAULT_CHARSET
| Constructor Detail |
|---|
public DiskFileItem(String fieldName,
String contentType,
boolean isFormField,
String fileName,
int sizeThreshold,
File repository,
IFileCleaner fileUploadCleaner)
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 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.fileUploadCleaner - | Method Detail |
|---|
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 FileItempublic boolean isInMemory()
isInMemory in interface FileItemtrue if the file contents will be read from memory; false
otherwise.public long getSize()
getSize in interface FileItempublic byte[] get()
get in interface FileItem
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.
getString in interface FileItem
public void write(File file)
throws IOException
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 FileItemfile - The File into which the uploaded item should be stored.
Exception - if an error occurs.
IOException - if an error occurs.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.
delete in interface FileItempublic 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
contensts 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
finalize in class ObjectThrowableprotected 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.
File to be used for temporary storage.public String toString()
toString in class ObjectObject.toString()public FileItemHeaders getHeaders()
getHeaders in interface FileItemHeadersSupportpublic void setHeaders(FileItemHeaders pHeaders)
setHeaders in interface FileItemHeadersSupportpHeaders - The file items headers.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||