io.netty.handler.codec.http.multipart

Class AbstractHttpData

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.codec.http.multipart.AbstractHttpData

All Implemented Interfaces:

ByteBufHolder, HttpData, InterfaceHttpData, ReferenceCounted, Comparable<InterfaceHttpData>

Direct Known Subclasses:

AbstractDiskHttpData, AbstractMemoryHttpData

public abstract class AbstractHttpData
extends AbstractReferenceCounted
implements HttpData

Abstract HttpData implementation

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 and Description
protected long	definedSize
protected long	size

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpData(String name, Charset charset, long size)

Method Summary

Modifier and Type	Method and Description
void	checkSize(long newSize) Check if the new size is not reaching the max limit allowed.
ByteBuf	content() Return the data which is held by this ByteBufHolder.
protected void	deallocate() Called once AbstractReferenceCounted.refCnt() is equals 0.
long	definedLength() Returns the defined length of the HttpData.
Charset	getCharset() Returns the Charset passed by the browser or null if not defined.
long	getMaxSize() Returns the maxSize for this HttpData.
String	getName() Returns the name of this InterfaceHttpData.
boolean	isCompleted()
long	length() Returns the size in byte of the InterfaceHttpData
HttpData	retain() Increases the reference count by 1.
HttpData	retain(int increment) Increases the reference count by the specified increment.
void	setCharset(Charset charset) Set the Charset passed by the browser if defined
protected void	setCompleted()
protected void	setCompleted(boolean completed)
void	setMaxSize(long maxSize) Set the maxSize for this HttpData.
abstract HttpData	touch() Records the current access location of this object for debugging purposes.
abstract HttpData	touch(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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.handler.codec.http.multipart.HttpData

addContent, copy, delete, duplicate, get, getByteBuf, getChunk, getFile, getString, getString, isInMemory, renameTo, replace, retainedDuplicate, setContent, setContent, setContent

Methods inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData

getHttpDataType

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Field Detail

definedSize

protected long definedSize

size

protected long size

Constructor Detail

AbstractHttpData

protected AbstractHttpData(String name,
                           Charset charset,
                           long size)

Method Detail

getMaxSize

public long getMaxSize()

Description copied from interface: HttpData

Returns the maxSize for this HttpData.

Specified by:

getMaxSize in interface HttpData

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 interface HttpData

checkSize

public void checkSize(long newSize)
               throws 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.

Specified by:

checkSize in interface HttpData

Throws:

IOException

getName

public String getName()

Description copied from interface: InterfaceHttpData

Returns the name of this InterfaceHttpData.

Specified by:

getName in interface InterfaceHttpData

isCompleted

public boolean isCompleted()

Specified by:

isCompleted in interface HttpData

Returns:

True if the InterfaceHttpData is completed (all data are stored)

setCompleted

protected void setCompleted()

setCompleted

protected void setCompleted(boolean completed)

getCharset

public Charset getCharset()

Description copied from interface: HttpData

Returns the Charset passed by the browser or null if not defined.

Specified by:

getCharset in interface HttpData

Returns:

the Charset passed by the browser or null if not defined.

setCharset

public void setCharset(Charset charset)

Description copied from interface: HttpData

Set the Charset passed by the browser if defined

Specified by:

setCharset in interface HttpData

Parameters:

charset - Charset to set - must be not null

length

public long length()

Description copied from interface: HttpData

Returns the size in byte of the InterfaceHttpData

Specified by:

length in interface HttpData

Returns:

the size of the InterfaceHttpData

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 one FileUpload or any known big Attribute.

Specified by:

definedLength in interface HttpData

Returns:

the defined length of the HttpData

content

public ByteBuf content()

Description copied from interface: ByteBufHolder

Return the data which is held by this ByteBufHolder.

Specified by:

content in interface ByteBufHolder

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted

retain

public HttpData retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface HttpData

Specified by:

retain in interface InterfaceHttpData

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

retain

public HttpData retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface HttpData

Specified by:

retain in interface InterfaceHttpData

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

touch

public abstract 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 via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface HttpData

Specified by:

touch in interface InterfaceHttpData

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractReferenceCounted

touch

public abstract HttpData touch(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 via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface HttpData

Specified by:

touch in interface InterfaceHttpData

Specified by:

touch in interface ReferenceCounted