io.netty.handler.codec.http

Class DefaultFullHttpResponse

java.lang.Object

io.netty.handler.codec.http.DefaultHttpObject

io.netty.handler.codec.http.DefaultHttpMessage

io.netty.handler.codec.http.DefaultHttpResponse

io.netty.handler.codec.http.DefaultFullHttpResponse

All Implemented Interfaces:

ByteBufHolder, DecoderResultProvider, FullHttpMessage, FullHttpResponse, HttpContent, HttpMessage, HttpObject, HttpResponse, LastHttpContent, ReferenceCounted

public class DefaultFullHttpResponse
extends DefaultHttpResponse
implements FullHttpResponse

Default implementation of a FullHttpResponse.

Field Summary

Fields inherited from interface io.netty.handler.codec.http.LastHttpContent

EMPTY_LAST_CONTENT

Constructor Summary

Constructors

Constructor and Description
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status) Create an empty HTTP response with the given HTTP version and status.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, boolean validateHeaders) Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, boolean validateHeaders, boolean singleFieldHeaders) Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content) Create an HTTP response with the given HTTP version, status, and contents.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, boolean validateHeaders) Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, boolean validateHeaders, boolean singleFieldHeaders) Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, HttpHeadersFactory headersFactory, HttpHeadersFactory trailersFactory) Create an HTTP response with the given HTTP version, status, contents, and with headers and trailers created by the given header factories.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, HttpHeaders headers, HttpHeaders trailingHeaders) Create an HTTP response with the given HTTP version, status, contents, headers and trailers.

Method Summary

Modifier and Type	Method and Description
ByteBuf	content() Return the data which is held by this ByteBufHolder.
FullHttpResponse	copy() Creates a deep copy of this ByteBufHolder.
FullHttpResponse	duplicate() Duplicates this ByteBufHolder.
boolean	equals(Object o)
int	hashCode()
int	refCnt() Returns the reference count of this object.
boolean	release() Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement) Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
FullHttpResponse	replace(ByteBuf content) Returns a new ByteBufHolder which contains the specified content.
FullHttpResponse	retain() Increases the reference count by 1.
FullHttpResponse	retain(int increment) Increases the reference count by the specified increment.
FullHttpResponse	retainedDuplicate() Duplicates this ByteBufHolder.
FullHttpResponse	setProtocolVersion(HttpVersion version) Set the protocol version of this HttpMessage
FullHttpResponse	setStatus(HttpResponseStatus status) Set the status of this HttpResponse.
String	toString()
FullHttpResponse	touch() Records the current access location of this object for debugging purposes.
FullHttpResponse	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.
HttpHeaders	trailingHeaders()

Methods inherited from class io.netty.handler.codec.http.DefaultHttpResponse

getStatus, status

Methods inherited from class io.netty.handler.codec.http.DefaultHttpMessage

getProtocolVersion, headers, protocolVersion

Methods inherited from class io.netty.handler.codec.http.DefaultHttpObject

decoderResult, getDecoderResult, setDecoderResult

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.handler.codec.http.HttpResponse

getStatus, status

Methods inherited from interface io.netty.handler.codec.http.HttpMessage

getProtocolVersion, headers, protocolVersion

Methods inherited from interface io.netty.handler.codec.http.HttpObject

getDecoderResult

Methods inherited from interface io.netty.handler.codec.DecoderResultProvider

decoderResult, setDecoderResult

Constructor Detail

DefaultFullHttpResponse

public DefaultFullHttpResponse(HttpVersion version,
                               HttpResponseStatus status)

Create an empty HTTP response with the given HTTP version and status.

DefaultFullHttpResponse

public DefaultFullHttpResponse(HttpVersion version,
                               HttpResponseStatus status,
                               ByteBuf content)

Create an HTTP response with the given HTTP version, status, and contents.

DefaultFullHttpResponse

@Deprecated
public DefaultFullHttpResponse(HttpVersion version,
                                           HttpResponseStatus status,
                                           boolean validateHeaders)

Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.

Create an empty HTTP response with the given HTTP version, status, and optional header validation.

DefaultFullHttpResponse

@Deprecated
public DefaultFullHttpResponse(HttpVersion version,
                                           HttpResponseStatus status,
                                           boolean validateHeaders,
                                           boolean singleFieldHeaders)

Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.

Create an empty HTTP response with the given HTTP version, status, optional header validation, and optional header combining.

DefaultFullHttpResponse

@Deprecated
public DefaultFullHttpResponse(HttpVersion version,
                                           HttpResponseStatus status,
                                           ByteBuf content,
                                           boolean validateHeaders)

Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.

Create an HTTP response with the given HTTP version, status, contents, and optional header validation.

DefaultFullHttpResponse

@Deprecated
public DefaultFullHttpResponse(HttpVersion version,
                                           HttpResponseStatus status,
                                           ByteBuf content,
                                           boolean validateHeaders,
                                           boolean singleFieldHeaders)

Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.

Create an HTTP response with the given HTTP version, status, contents, optional header validation, and optional header combining.

DefaultFullHttpResponse

public DefaultFullHttpResponse(HttpVersion version,
                               HttpResponseStatus status,
                               ByteBuf content,
                               HttpHeadersFactory headersFactory,
                               HttpHeadersFactory trailersFactory)

Create an HTTP response with the given HTTP version, status, contents, and with headers and trailers created by the given header factories.

The recommended header factory is DefaultHttpHeadersFactory.headersFactory(), and the recommended trailer factory is DefaultHttpHeadersFactory.trailersFactory().

DefaultFullHttpResponse

public DefaultFullHttpResponse(HttpVersion version,
                               HttpResponseStatus status,
                               ByteBuf content,
                               HttpHeaders headers,
                               HttpHeaders trailingHeaders)

Create an HTTP response with the given HTTP version, status, contents, headers and trailers.

Method Detail

trailingHeaders

public HttpHeaders trailingHeaders()

Specified by:

trailingHeaders in interface LastHttpContent

content

public ByteBuf content()

Description copied from interface: ByteBufHolder

Return the data which is held by this ByteBufHolder.

Specified by:

content in interface ByteBufHolder

refCnt

public int refCnt()

Description copied from interface: ReferenceCounted

Returns the reference count of this object. If 0, it means this object has been deallocated.

Specified by:

refCnt in interface ReferenceCounted

retain

public FullHttpResponse retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface FullHttpMessage

Specified by:

retain in interface FullHttpResponse

Specified by:

retain in interface HttpContent

Specified by:

retain in interface LastHttpContent

Specified by:

retain in interface ReferenceCounted

retain

public FullHttpResponse 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 FullHttpMessage

Specified by:

retain in interface FullHttpResponse

Specified by:

retain in interface HttpContent

Specified by:

retain in interface LastHttpContent

Specified by:

retain in interface ReferenceCounted

touch

public FullHttpResponse 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 FullHttpMessage

Specified by:

touch in interface FullHttpResponse

Specified by:

touch in interface HttpContent

Specified by:

touch in interface LastHttpContent

Specified by:

touch in interface ReferenceCounted

touch

public FullHttpResponse 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 FullHttpMessage

Specified by:

touch in interface FullHttpResponse

Specified by:

touch in interface HttpContent

Specified by:

touch in interface LastHttpContent

Specified by:

touch in interface ReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

setProtocolVersion

public FullHttpResponse setProtocolVersion(HttpVersion version)

Description copied from interface: HttpMessage

Set the protocol version of this HttpMessage

Specified by:

setProtocolVersion in interface FullHttpResponse

Specified by:

setProtocolVersion in interface HttpMessage

Specified by:

setProtocolVersion in interface HttpResponse

Overrides:

setProtocolVersion in class DefaultHttpResponse

setStatus

public FullHttpResponse setStatus(HttpResponseStatus status)

Description copied from interface: HttpResponse

Set the status of this HttpResponse.

Specified by:

setStatus in interface FullHttpResponse

Specified by:

setStatus in interface HttpResponse

Overrides:

setStatus in class DefaultHttpResponse

copy

public FullHttpResponse copy()

Description copied from interface: ByteBufHolder

Creates a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface FullHttpMessage

Specified by:

copy in interface FullHttpResponse

Specified by:

copy in interface HttpContent

Specified by:

copy in interface LastHttpContent

duplicate

public FullHttpResponse duplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface FullHttpMessage

Specified by:

duplicate in interface FullHttpResponse

Specified by:

duplicate in interface HttpContent

Specified by:

duplicate in interface LastHttpContent

retainedDuplicate

public FullHttpResponse retainedDuplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

Specified by:

retainedDuplicate in interface ByteBufHolder

Specified by:

retainedDuplicate in interface FullHttpMessage

Specified by:

retainedDuplicate in interface FullHttpResponse

Specified by:

retainedDuplicate in interface HttpContent

Specified by:

retainedDuplicate in interface LastHttpContent

See Also:

ByteBuf.retainedDuplicate()

replace

public FullHttpResponse replace(ByteBuf content)

Description copied from interface: ByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in interface FullHttpMessage

Specified by:

replace in interface FullHttpResponse

Specified by:

replace in interface HttpContent

Specified by:

replace in interface LastHttpContent

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultHttpResponse

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultHttpResponse

toString

public String toString()

Overrides:

toString in class DefaultHttpResponse