Interface HttpData
- All Superinterfaces:
ByteBufHolder
,Comparable<InterfaceHttpData>
,InterfaceHttpData
,ReferenceCounted
- All Known Subinterfaces:
Attribute
,FileUpload
- All Known Implementing Classes:
AbstractDiskHttpData
,AbstractHttpData
,AbstractMemoryHttpData
,AbstractMixedHttpData
,DiskAttribute
,DiskFileUpload
,MemoryAttribute
,MemoryFileUpload
,MixedAttribute
,MixedFileUpload
Extended interface for InterfaceHttpData
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData
InterfaceHttpData.HttpDataType
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addContent
(ByteBuf buffer, boolean last) Add the content from the ChannelBuffervoid
checkSize
(long newSize) Check if the new size is not reaching the max limit allowed.copy()
Creates a deep copy of thisByteBufHolder
.long
Returns the defined length of the HttpData.void
delete()
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.Duplicates thisByteBufHolder
.byte[]
get()
Returns the contents of the file item as an array of bytes.
Note: this method will allocate a lot of memory, if the data is currently stored on the file system.Returns the content of the file item as a ByteBuf.
Note: this method will allocate a lot of memory, if the data is currently stored on the file system.Returns 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()
long
Returns the maxSize for this HttpData.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 getMethod to write an uploaded item to disk.Returns a newByteBufHolder
which contains the specifiedcontent
.retain()
Increases the reference count by1
.retain
(int increment) Increases the reference count by the specifiedincrement
.Duplicates thisByteBufHolder
.void
setCharset
(Charset charset) Set the Charset passed by the browser if definedvoid
setContent
(ByteBuf buffer) Set the content from the ChannelBuffer (erase any previous data)void
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
setMaxSize
(long maxSize) Set the maxSize for this HttpData.touch()
Records the current access location of this object for debugging purposes.Records the current access location of this object with an additional arbitrary information for debugging purposes.Methods inherited from interface io.netty.buffer.ByteBufHolder
content
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData
getHttpDataType, getName
Methods inherited from interface io.netty.util.ReferenceCounted
refCnt, release, release
-
Method Details
-
getMaxSize
long getMaxSize()Returns the maxSize for this HttpData. -
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. -
checkSize
Check if the new size is not reaching the max limit allowed. The limit is always computed in terms of bytes.- Throws:
IOException
-
setContent
Set the content from the ChannelBuffer (erase any previous data)ReferenceCounted.release()
ownership ofbuffer
is transferred to thisHttpData
.- Parameters:
buffer
- must be not null- Throws:
IOException
-
addContent
Add the content from the ChannelBufferReferenceCounted.release()
ownership ofbuffer
is transferred to thisHttpData
.- 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
-
definedLength
long definedLength()Returns the defined length of the HttpData. If no Content-Length is provided in the request, the defined length is always 0 (whatever during decoding or in final state). If Content-Length is provided in the request, this is this given defined length. This value does not change, whatever during decoding or in the final state. This method could be used for instance to know the amount of bytes transmitted for one particular HttpData, for example oneFileUpload
or any known bigAttribute
.- Returns:
- the defined length of the HttpData
-
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.
Note: this method will allocate a lot of memory, if the data is currently stored on the file system.- Returns:
- the contents of the file item as an array of bytes.
- Throws:
IOException
-
getByteBuf
Returns the content of the file item as a ByteBuf.
Note: this method will allocate a lot of memory, if the data is currently stored on the file system.- Returns:
- the content of the file item as a ByteBuf
- 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 getMethod to write an uploaded item to disk. If a previous one exists, it will be deleted. Once this getMethod 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
-
copy
HttpData copy()Description copied from interface:ByteBufHolder
Creates a deep copy of thisByteBufHolder
.- Specified by:
copy
in interfaceByteBufHolder
-
duplicate
HttpData duplicate()Description copied from interface:ByteBufHolder
Duplicates thisByteBufHolder
. Be aware that this will not automatically callByteBufHolder.retain()
.- Specified by:
duplicate
in interfaceByteBufHolder
-
retainedDuplicate
HttpData retainedDuplicate()Description copied from interface:ByteBufHolder
Duplicates thisByteBufHolder
. This method returns a retained duplicate unlikeByteBufHolder.duplicate()
.- Specified by:
retainedDuplicate
in interfaceByteBufHolder
- See Also:
-
replace
Description copied from interface:ByteBufHolder
Returns a newByteBufHolder
which contains the specifiedcontent
.- Specified by:
replace
in interfaceByteBufHolder
-
retain
HttpData retain()Description copied from interface:ReferenceCounted
Increases the reference count by1
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceInterfaceHttpData
- Specified by:
retain
in interfaceReferenceCounted
-
retain
Description copied from interface:ReferenceCounted
Increases the reference count by the specifiedincrement
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceInterfaceHttpData
- Specified by:
retain
in interfaceReferenceCounted
-
touch
HttpData touch()Description copied from interface:ReferenceCounted
Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you viaResourceLeakDetector
. This method is a shortcut totouch(null)
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceInterfaceHttpData
- Specified by:
touch
in interfaceReferenceCounted
-
touch
Description copied from interface:ReferenceCounted
Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you viaResourceLeakDetector
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceInterfaceHttpData
- Specified by:
touch
in interfaceReferenceCounted
-