Class AbstractMixedHttpData<D extends HttpData>
- java.lang.Object
-
- io.netty.util.AbstractReferenceCounted
-
- io.netty.handler.codec.http.multipart.AbstractMixedHttpData<D>
-
- All Implemented Interfaces:
ByteBufHolder
,HttpData
,InterfaceHttpData
,ReferenceCounted
,java.lang.Comparable<InterfaceHttpData>
- Direct Known Subclasses:
MixedAttribute
,MixedFileUpload
abstract class AbstractMixedHttpData<D extends HttpData> extends AbstractReferenceCounted implements HttpData
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData
InterfaceHttpData.HttpDataType
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.lang.String
baseDir
(package private) boolean
deleteOnExit
private long
limitSize
(package private) D
wrapped
-
Constructor Summary
Constructors Constructor Description AbstractMixedHttpData(long limitSize, java.lang.String baseDir, boolean deleteOnExit, D initial)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
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.int
compareTo(InterfaceHttpData o)
ByteBuf
content()
Return the data which is held by thisByteBufHolder
.D
copy()
Creates a deep copy of thisByteBufHolder
.protected void
deallocate()
Called onceAbstractReferenceCounted.refCnt()
is equals 0.long
definedLength()
Returns the defined length of the HttpData.void
delete()
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.D
duplicate()
Duplicates thisByteBufHolder
.boolean
equals(java.lang.Object obj)
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.ByteBuf
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.java.nio.charset.Charset
getCharset()
Returns the Charset passed by the browser or null if not defined.ByteBuf
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.java.io.File
getFile()
InterfaceHttpData.HttpDataType
getHttpDataType()
long
getMaxSize()
Returns the maxSize for this HttpData.java.lang.String
getName()
Returns the name of this InterfaceHttpData.java.lang.String
getString()
Returns the contents of the file item as a String, using the default character encoding.java.lang.String
getString(java.nio.charset.Charset encoding)
Returns the contents of the file item as a String, using the specified charset.int
hashCode()
boolean
isCompleted()
boolean
isInMemory()
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 InterfaceHttpData(package private) abstract D
makeDiskData()
boolean
renameTo(java.io.File dest)
A convenience getMethod to write an uploaded item to disk.D
replace(ByteBuf content)
Returns a newByteBufHolder
which contains the specifiedcontent
.D
retain()
Increases the reference count by1
.D
retain(int increment)
Increases the reference count by the specifiedincrement
.D
retainedDuplicate()
Duplicates thisByteBufHolder
.void
setCharset(java.nio.charset.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(java.io.File file)
Set the content from the file (erase any previous data)void
setContent(java.io.InputStream inputStream)
Set the content from the inputStream (erase any previous data)void
setMaxSize(long maxSize)
Set the maxSize for this HttpData.java.lang.String
toString()
D
touch()
Records the current access location of this object for debugging purposes.D
touch(java.lang.Object hint)
Records the current access location of this object with an additional arbitrary information for debugging purposes.-
Methods inherited from class io.netty.util.AbstractReferenceCounted
refCnt, release, release, setRefCnt
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface io.netty.util.ReferenceCounted
refCnt, release, release
-
-
-
-
Constructor Detail
-
AbstractMixedHttpData
AbstractMixedHttpData(long limitSize, java.lang.String baseDir, boolean deleteOnExit, D initial)
-
-
Method Detail
-
makeDiskData
abstract D makeDiskData()
-
getMaxSize
public long getMaxSize()
Description copied from interface:HttpData
Returns the maxSize for this HttpData.- Specified by:
getMaxSize
in interfaceHttpData
-
setMaxSize
public void setMaxSize(long maxSize)
Description copied from interface:HttpData
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.- Specified by:
setMaxSize
in interfaceHttpData
-
content
public ByteBuf content()
Description copied from interface:ByteBufHolder
Return the data which is held by thisByteBufHolder
.- Specified by:
content
in interfaceByteBufHolder
-
checkSize
public void checkSize(long newSize) throws java.io.IOException
Description copied from interface:HttpData
Check if the new size is not reaching the max limit allowed. The limit is always computed in terms of bytes.
-
definedLength
public long definedLength()
Description copied from interface:HttpData
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
.- Specified by:
definedLength
in interfaceHttpData
- Returns:
- the defined length of the HttpData
-
getCharset
public java.nio.charset.Charset getCharset()
Description copied from interface:HttpData
Returns the Charset passed by the browser or null if not defined.- Specified by:
getCharset
in interfaceHttpData
- Returns:
- the Charset passed by the browser or null if not defined.
-
getName
public java.lang.String getName()
Description copied from interface:InterfaceHttpData
Returns the name of this InterfaceHttpData.- Specified by:
getName
in interfaceInterfaceHttpData
-
addContent
public void addContent(ByteBuf buffer, boolean last) throws java.io.IOException
Description copied from interface:HttpData
Add the content from the ChannelBufferReferenceCounted.release()
ownership ofbuffer
is transferred to thisHttpData
.- Specified by:
addContent
in interfaceHttpData
- Parameters:
buffer
- must be not null except if last is set to Falselast
- True of the buffer is the last one- Throws:
java.io.IOException
-
deallocate
protected void deallocate()
Description copied from class:AbstractReferenceCounted
Called onceAbstractReferenceCounted.refCnt()
is equals 0.- Specified by:
deallocate
in classAbstractReferenceCounted
-
delete
public void delete()
Description copied from interface:HttpData
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
-
get
public byte[] get() throws java.io.IOException
Description copied from interface:HttpData
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.
-
getByteBuf
public ByteBuf getByteBuf() throws java.io.IOException
Description copied from interface:HttpData
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.- Specified by:
getByteBuf
in interfaceHttpData
- Returns:
- the content of the file item as a ByteBuf
- Throws:
java.io.IOException
-
getString
public java.lang.String getString() throws java.io.IOException
Description copied from interface:HttpData
Returns the contents of the file item as a String, using the default character encoding.
-
getString
public java.lang.String getString(java.nio.charset.Charset encoding) throws java.io.IOException
Description copied from interface:HttpData
Returns the contents of the file item as a String, using the specified charset.
-
isInMemory
public boolean isInMemory()
Description copied from interface:HttpData
Provides a hint as to whether or not the file contents will be read from memory.- Specified by:
isInMemory
in interfaceHttpData
- Returns:
- True if the file contents is in memory.
-
length
public long length()
Description copied from interface:HttpData
Returns the size in byte of the InterfaceHttpData
-
renameTo
public boolean renameTo(java.io.File dest) throws java.io.IOException
Description copied from interface:HttpData
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.
-
setCharset
public void setCharset(java.nio.charset.Charset charset)
Description copied from interface:HttpData
Set the Charset passed by the browser if defined- Specified by:
setCharset
in interfaceHttpData
- Parameters:
charset
- Charset to set - must be not null
-
setContent
public void setContent(ByteBuf buffer) throws java.io.IOException
Description copied from interface:HttpData
Set the content from the ChannelBuffer (erase any previous data)ReferenceCounted.release()
ownership ofbuffer
is transferred to thisHttpData
.- Specified by:
setContent
in interfaceHttpData
- Parameters:
buffer
- must be not null- Throws:
java.io.IOException
-
setContent
public void setContent(java.io.File file) throws java.io.IOException
Description copied from interface:HttpData
Set the content from the file (erase any previous data)- Specified by:
setContent
in interfaceHttpData
- Parameters:
file
- must be not null- Throws:
java.io.IOException
-
setContent
public void setContent(java.io.InputStream inputStream) throws java.io.IOException
Description copied from interface:HttpData
Set the content from the inputStream (erase any previous data)- Specified by:
setContent
in interfaceHttpData
- Parameters:
inputStream
- must be not null- Throws:
java.io.IOException
-
isCompleted
public boolean isCompleted()
- Specified by:
isCompleted
in interfaceHttpData
- Returns:
- True if the InterfaceHttpData is completed (all data are stored)
-
getHttpDataType
public InterfaceHttpData.HttpDataType getHttpDataType()
- Specified by:
getHttpDataType
in interfaceInterfaceHttpData
- Returns:
- The HttpDataType
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
compareTo
public int compareTo(InterfaceHttpData o)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getChunk
public ByteBuf getChunk(int length) throws java.io.IOException
Description copied from interface:HttpData
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.
-
getFile
public java.io.File getFile() throws java.io.IOException
-
copy
public D copy()
Description copied from interface:ByteBufHolder
Creates a deep copy of thisByteBufHolder
.- Specified by:
copy
in interfaceByteBufHolder
- Specified by:
copy
in interfaceHttpData
-
duplicate
public D duplicate()
Description copied from interface:ByteBufHolder
Duplicates thisByteBufHolder
. Be aware that this will not automatically callByteBufHolder.retain()
.- Specified by:
duplicate
in interfaceByteBufHolder
- Specified by:
duplicate
in interfaceHttpData
-
retainedDuplicate
public D retainedDuplicate()
Description copied from interface:ByteBufHolder
Duplicates thisByteBufHolder
. This method returns a retained duplicate unlikeByteBufHolder.duplicate()
.- Specified by:
retainedDuplicate
in interfaceByteBufHolder
- Specified by:
retainedDuplicate
in interfaceHttpData
- See Also:
ByteBuf.retainedDuplicate()
-
replace
public D replace(ByteBuf content)
Description copied from interface:ByteBufHolder
Returns a newByteBufHolder
which contains the specifiedcontent
.- Specified by:
replace
in interfaceByteBufHolder
- Specified by:
replace
in interfaceHttpData
-
touch
public D 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 interfaceHttpData
- Specified by:
touch
in interfaceInterfaceHttpData
- Specified by:
touch
in interfaceReferenceCounted
- Overrides:
touch
in classAbstractReferenceCounted
-
touch
public D touch(java.lang.Object hint)
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 interfaceHttpData
- Specified by:
touch
in interfaceInterfaceHttpData
- Specified by:
touch
in interfaceReferenceCounted
-
retain
public D retain()
Description copied from interface:ReferenceCounted
Increases the reference count by1
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceHttpData
- Specified by:
retain
in interfaceInterfaceHttpData
- Specified by:
retain
in interfaceReferenceCounted
- Overrides:
retain
in classAbstractReferenceCounted
-
retain
public D retain(int increment)
Description copied from interface:ReferenceCounted
Increases the reference count by the specifiedincrement
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceHttpData
- Specified by:
retain
in interfaceInterfaceHttpData
- Specified by:
retain
in interfaceReferenceCounted
- Overrides:
retain
in classAbstractReferenceCounted
-
-