|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--javazoom.upload.parsing.CfuFileItem
This class implements a custom CFU FileItem to get notified about upload event and pass extra parameters needed for UploadListener. This class is quite similar to DefaultFileItem provided by CFU.
| Field Summary | |
static java.lang.String |
FILE_PREFIX
Temporary file prefix : Default is upload_ |
| Constructor Summary | |
CfuFileItem(java.lang.String fieldName,
java.lang.String contentType,
boolean isFormField,
java.lang.String fileName,
int sizeThreshold,
java.io.File repository,
java.util.Vector listeners,
int custom)
Constructs a new CfuFileItem 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. |
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 |
| Field Detail |
public static java.lang.String FILE_PREFIX
| Constructor Detail |
public CfuFileItem(java.lang.String fieldName,
java.lang.String contentType,
boolean isFormField,
java.lang.String fileName,
int sizeThreshold,
java.io.File repository,
java.util.Vector listeners,
int custom)
CfuFileItem 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.listeners - UploadBean listeners to be notified.custom - Content Length of HTTP post.| Method Detail |
public java.io.InputStream getInputStream()
throws java.io.IOException
InputStream that can be
used to retrieve the contents of the file.
getInputStream in interface org.apache.commons.fileupload.FileItemInputStream that can be
used to retrieve the contents of the file.
java.io.IOException - if an error occurs.public java.lang.String getContentType()
null if
not defined.
getContentType in interface org.apache.commons.fileupload.FileItemnull if
not defined.public java.lang.String getName()
getName in interface org.apache.commons.fileupload.FileItempublic boolean isInMemory()
isInMemory in interface org.apache.commons.fileupload.FileItemtrue if the file contents will be read
from memory; false otherwise.public long getSize()
getSize in interface org.apache.commons.fileupload.FileItempublic byte[] get()
get in interface org.apache.commons.fileupload.FileItem
public java.lang.String getString(java.lang.String encoding)
throws java.io.UnsupportedEncodingException
get() to retrieve the
contents of the file.
getString in interface org.apache.commons.fileupload.FileItemencoding - The character encoding to use.
java.io.UnsupportedEncodingException - if the requested character
encoding is not available.public java.lang.String getString()
get() to retrieve the
contents of the file.
getString in interface org.apache.commons.fileupload.FileItem
public void write(java.io.File file)
throws java.lang.Exception
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 org.apache.commons.fileupload.FileItemfile - The File into which the uploaded item should
be stored.
java.lang.Exception - 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 org.apache.commons.fileupload.FileItempublic java.lang.String getFieldName()
getFieldName in interface org.apache.commons.fileupload.FileItemsetFieldName(java.lang.String)public void setFieldName(java.lang.String fieldName)
setFieldName in interface org.apache.commons.fileupload.FileItemfieldName - The name of the form field.getFieldName()public boolean isFormField()
FileItem instance represents
a simple form field.
isFormField in interface org.apache.commons.fileupload.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 org.apache.commons.fileupload.FileItemstate - true if the instance represents a simple form
field; false if it represents an uploaded file.isFormField()
public java.io.OutputStream getOutputStream()
throws java.io.IOException
OutputStream that can
be used for storing the contents of the file.
getOutputStream in interface org.apache.commons.fileupload.FileItemOutputStream that can be used
for storing the contensts of the file.
java.io.IOException - if an error occurs.public java.io.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()
finalize in class java.lang.Objectprotected java.io.File getTempFile()
File representing a uniquely
named temporary file in the configured repository path.
File to be used for temporary storage.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||