Interface HttpData
- All Superinterfaces:
Comparable<InterfaceHttpData>
,InterfaceHttpData
- All Known Subinterfaces:
Attribute
,FileUpload
- All Known Implementing Classes:
AbstractDiskHttpData
,AbstractHttpData
,AbstractMemoryHttpData
,DiskAttribute
,DiskFileUpload
,MemoryAttribute
,MemoryFileUpload
,MixedAttribute
,MixedFileUpload
Extended interface for InterfaceHttpData
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.jboss.netty.handler.codec.http.multipart.InterfaceHttpData
InterfaceHttpData.HttpDataType
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addContent
(ChannelBuffer buffer, boolean last) Add the content from the ChannelBuffervoid
checkSize
(long newSize) Check if the new size is not reaching the max limit allowed.void
delete()
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.getFile()
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.boolean
boolean
Provides a hint as to whether or not the file contents will be read from memory.long
length()
Returns the size in byte of the InterfaceHttpDataboolean
A convenience method to write an uploaded item to disk.void
setCharset
(Charset charset) Set the Charset passed by the browser if definedvoid
setContent
(File file) Set the content from the file (erase any previous data)void
setContent
(InputStream inputStream) Set the content from the inputStream (erase any previous data)void
setContent
(ChannelBuffer buffer) Set the content from the ChannelBuffer (erase any previous data)void
setMaxSize
(long maxSize) Set the maxSize for this HttpData.Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.jboss.netty.handler.codec.http.multipart.InterfaceHttpData
getHttpDataType, getName
-
Method Details
-
setMaxSize
void setMaxSize(long maxSize) Set 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.- Parameters:
maxSize
-
-
checkSize
Check if the new size is not reaching the max limit allowed. The limit is always computed in term of bytes.- Parameters:
newSize
-- Throws:
IOException
-
setContent
Set the content from the ChannelBuffer (erase any previous data)- Parameters:
buffer
- must be not null- Throws:
IOException
-
addContent
Add the content from the ChannelBuffer- Parameters:
buffer
- must be not null except if last is set to Falselast
- True of the buffer is the last one- Throws:
IOException
-
setContent
Set the content from the file (erase any previous data)- Parameters:
file
- must be not null- Throws:
IOException
-
setContent
Set the content from the inputStream (erase any previous data)- Parameters:
inputStream
- must be not null- Throws:
IOException
-
isCompleted
boolean isCompleted()- Returns:
- True if the InterfaceHttpData is completed (all data are stored)
-
length
long length()Returns the size in byte of the InterfaceHttpData- Returns:
- the size of the InterfaceHttpData
-
delete
void delete()Deletes the underlying storage for a file item, including deleting any associated temporary disk file. -
get
Returns the contents of the file item as an array of bytes.- Returns:
- the contents of the file item as an array of bytes.
- Throws:
IOException
-
getChannelBuffer
Returns the content of the file item as a ChannelBuffer- Returns:
- the content of the file item as a ChannelBuffer
- Throws:
IOException
-
getChunk
Returns 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.- Returns:
- a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return
- Throws:
IOException
-
getString
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 default character encoding.
- Throws:
IOException
-
getString
Returns the contents of the file item as a String, using the specified charset.- Parameters:
encoding
- the charset to use- Returns:
- the contents of the file item as a String, using the specified charset.
- Throws:
IOException
-
setCharset
Set the Charset passed by the browser if defined- Parameters:
charset
- Charset to set - must be not null
-
getCharset
Charset getCharset()Returns the Charset passed by the browser or null if not defined.- Returns:
- the Charset passed by the browser or null if not defined.
-
renameTo
A 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.- Parameters:
dest
- destination file - must be not null- Returns:
- True if the write is successful
- Throws:
IOException
-
isInMemory
boolean isInMemory()Provides a hint as to whether or not the file contents will be read from memory.- Returns:
- True if the file contents is in memory.
-
getFile
- Returns:
- the associated File if this data is represented in a file
- Throws:
IOException
- if this data is not represented by a file
-