Class MixedFileUpload
java.lang.Object
org.jboss.netty.handler.codec.http.multipart.MixedFileUpload
- All Implemented Interfaces:
Comparable<InterfaceHttpData>,FileUpload,HttpData,InterfaceHttpData
Mixed implementation using both in Memory and in File with a limit of size
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.jboss.netty.handler.codec.http.multipart.InterfaceHttpData
InterfaceHttpData.HttpDataType -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final longprivate FileUploadprivate final longprotected long -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddContent(ChannelBuffer buffer, boolean last) Add the content from the ChannelBuffervoidcheckSize(long newSize) Check if the new size is not reaching the max limit allowed.intvoiddelete()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.Returns the content of the file item as a ChannelBufferReturns the Charset passed by the browser or null if not defined.getChunk(int length) Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read.Returns the Content-Transfer-EncodingReturns the content type passed by the browser or null if not defined.getFile()Returns the original filename in the client's filesystem, as provided by the browser (or other client software).getName()Returns the name of this InterfaceHttpData.Returns the contents of the file item as a String, using the default character encoding.Returns the contents of the file item as a String, using the specified charset.booleanbooleanProvides a hint as to whether or not the file contents will be read from memory.longlength()Returns the size in byte of the InterfaceHttpDatabooleanA convenience method to write an uploaded item to disk.voidsetCharset(Charset charset) Set the Charset passed by the browser if definedvoidsetContent(File file) Set the content from the file (erase any previous data)voidsetContent(InputStream inputStream) Set the content from the inputStream (erase any previous data)voidsetContent(ChannelBuffer buffer) Set the content from the ChannelBuffer (erase any previous data)voidsetContentTransferEncoding(String contentTransferEncoding) Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binaryvoidsetContentType(String contentType) Set the Content Type passed by the browser if definedvoidsetFilename(String filename) Set the original filenamevoidsetMaxSize(long maxSize) Set the maxSize for this HttpData.toString()
-
Field Details
-
fileUpload
-
limitSize
private final long limitSize -
definedSize
private final long definedSize -
maxSize
protected long maxSize
-
-
Constructor Details
-
MixedFileUpload
-
-
Method Details
-
setMaxSize
public void setMaxSize(long maxSize) Description copied from interface:HttpDataSet the maxSize for this HttpData. When limit will be reached, an exception will be raised. Setting it to (-1) means no limitation. By default, to be set from the HttpDataFactory.- Specified by:
setMaxSizein interfaceHttpData- Parameters:
maxSize-
-
checkSize
Description copied from interface:HttpDataCheck if the new size is not reaching the max limit allowed. The limit is always computed in term of bytes.- Specified by:
checkSizein interfaceHttpData- Parameters:
newSize-- Throws:
IOException
-
addContent
Description copied from interface:HttpDataAdd the content from the ChannelBuffer- Specified by:
addContentin interfaceHttpData- Parameters:
buffer- must be not null except if last is set to Falselast- True of the buffer is the last one- Throws:
IOException
-
delete
public void delete()Description copied from interface:HttpDataDeletes the underlying storage for a file item, including deleting any associated temporary disk file. -
get
Description copied from interface:HttpDataReturns the contents of the file item as an array of bytes.- Specified by:
getin interfaceHttpData- Returns:
- the contents of the file item as an array of bytes.
- Throws:
IOException
-
getChannelBuffer
Description copied from interface:HttpDataReturns the content of the file item as a ChannelBuffer- Specified by:
getChannelBufferin interfaceHttpData- Returns:
- the content of the file item as a ChannelBuffer
- Throws:
IOException
-
getCharset
Description copied from interface:HttpDataReturns the Charset passed by the browser or null if not defined.- Specified by:
getCharsetin interfaceHttpData- Returns:
- the Charset passed by the browser or null if not defined.
-
getContentType
Description copied from interface:FileUploadReturns the content type passed by the browser or null if not defined.- Specified by:
getContentTypein interfaceFileUpload- Returns:
- the content type passed by the browser or null if not defined.
-
getContentTransferEncoding
Description copied from interface:FileUploadReturns the Content-Transfer-Encoding- Specified by:
getContentTransferEncodingin interfaceFileUpload- Returns:
- the Content-Transfer-Encoding
-
getFilename
Description copied from interface:FileUploadReturns the original filename in the client's filesystem, as provided by the browser (or other client software).- Specified by:
getFilenamein interfaceFileUpload- Returns:
- the original filename
-
getString
Description copied from interface:HttpDataReturns the contents of the file item as a String, using the default character encoding.- Specified by:
getStringin interfaceHttpData- Returns:
- the contents of the file item as a String, using the default character encoding.
- Throws:
IOException
-
getString
Description copied from interface:HttpDataReturns the contents of the file item as a String, using the specified charset.- Specified by:
getStringin interfaceHttpData- Parameters:
encoding- the charset to use- Returns:
- the contents of the file item as a String, using the specified charset.
- Throws:
IOException
-
isCompleted
public boolean isCompleted()- Specified by:
isCompletedin interfaceHttpData- Returns:
- True if the InterfaceHttpData is completed (all data are stored)
-
isInMemory
public boolean isInMemory()Description copied from interface:HttpDataProvides a hint as to whether or not the file contents will be read from memory.- Specified by:
isInMemoryin interfaceHttpData- Returns:
- True if the file contents is in memory.
-
length
public long length()Description copied from interface:HttpDataReturns the size in byte of the InterfaceHttpData -
renameTo
Description copied from interface:HttpDataA convenience method to write an uploaded item to disk. If a previous one exists, it will be deleted. Once this method is called, if successful, the new file will be out of the cleaner of the factory that creates the original InterfaceHttpData object.- Specified by:
renameToin interfaceHttpData- Parameters:
dest- destination file - must be not null- Returns:
- True if the write is successful
- Throws:
IOException
-
setCharset
Description copied from interface:HttpDataSet the Charset passed by the browser if defined- Specified by:
setCharsetin interfaceHttpData- Parameters:
charset- Charset to set - must be not null
-
setContent
Description copied from interface:HttpDataSet the content from the ChannelBuffer (erase any previous data)- Specified by:
setContentin interfaceHttpData- Parameters:
buffer- must be not null- Throws:
IOException
-
setContent
Description copied from interface:HttpDataSet the content from the file (erase any previous data)- Specified by:
setContentin interfaceHttpData- Parameters:
file- must be not null- Throws:
IOException
-
setContent
Description copied from interface:HttpDataSet the content from the inputStream (erase any previous data)- Specified by:
setContentin interfaceHttpData- Parameters:
inputStream- must be not null- Throws:
IOException
-
setContentType
Description copied from interface:FileUploadSet the Content Type passed by the browser if defined- Specified by:
setContentTypein interfaceFileUpload- Parameters:
contentType- Content Type to set - must be not null
-
setContentTransferEncoding
Description copied from interface:FileUploadSet the Content-Transfer-Encoding type from String as 7bit, 8bit or binary- Specified by:
setContentTransferEncodingin interfaceFileUpload
-
setFilename
Description copied from interface:FileUploadSet the original filename- Specified by:
setFilenamein interfaceFileUpload
-
getHttpDataType
- Specified by:
getHttpDataTypein interfaceInterfaceHttpData- Returns:
- The HttpDataType
-
getName
Description copied from interface:InterfaceHttpDataReturns the name of this InterfaceHttpData.- Specified by:
getNamein interfaceInterfaceHttpData
-
compareTo
- Specified by:
compareToin interfaceComparable<InterfaceHttpData>
-
toString
-
getChunk
Description copied from interface:HttpDataReturns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read. Once it arrives at the end, it returns an EMPTY_BUFFER and it resets the current position to 0.- Specified by:
getChunkin interfaceHttpData- Returns:
- a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return
- Throws:
IOException
-
getFile
- Specified by:
getFilein interfaceHttpData- Returns:
- the associated File if this data is represented in a file
- Throws:
IOException- if this data is not represented by a file
-