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:

io.netty.buffer.ByteBufHolder, io.netty.handler.codec.DecoderResultProvider, FullHttpMessage, FullHttpResponse, HttpContent, HttpMessage, HttpObject, HttpResponse, LastHttpContent, io.netty.util.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, io.netty.buffer.ByteBuf content) Create an HTTP response with the given HTTP version, status, and contents.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, io.netty.buffer.ByteBuf content, boolean validateHeaders) Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, io.netty.buffer.ByteBuf content, boolean validateHeaders, boolean singleFieldHeaders) Deprecated. Prefer the DefaultFullHttpResponse(HttpVersion, HttpResponseStatus, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, io.netty.buffer.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, io.netty.buffer.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
io.netty.buffer.ByteBuf	content()
FullHttpResponse	copy()
FullHttpResponse	duplicate()
boolean	equals(Object o)
int	hashCode()
int	refCnt()
boolean	release()
boolean	release(int decrement)
FullHttpResponse	replace(io.netty.buffer.ByteBuf content)
FullHttpResponse	retain()
FullHttpResponse	retain(int increment)
FullHttpResponse	retainedDuplicate()
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()
FullHttpResponse	touch(Object hint)
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,
                               io.netty.buffer.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,
                                           io.netty.buffer.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,
                                           io.netty.buffer.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,
                               io.netty.buffer.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,
                               io.netty.buffer.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 io.netty.buffer.ByteBuf content()

Specified by:

content in interface io.netty.buffer.ByteBufHolder

refCnt

public int refCnt()

Specified by:

refCnt in interface io.netty.util.ReferenceCounted

retain

public FullHttpResponse retain()

Specified by:

retain in interface io.netty.buffer.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 io.netty.util.ReferenceCounted

retain

public FullHttpResponse retain(int increment)

Specified by:

retain in interface io.netty.buffer.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 io.netty.util.ReferenceCounted

touch

public FullHttpResponse touch()

Specified by:

touch in interface io.netty.buffer.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 io.netty.util.ReferenceCounted

touch

public FullHttpResponse touch(Object hint)

Specified by:

touch in interface io.netty.buffer.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 io.netty.util.ReferenceCounted

release

public boolean release()

Specified by:

release in interface io.netty.util.ReferenceCounted

release

public boolean release(int decrement)

Specified by:

release in interface io.netty.util.ReferenceCounted

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()

Specified by:

copy in interface io.netty.buffer.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()

Specified by:

duplicate in interface io.netty.buffer.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()

Specified by:

retainedDuplicate in interface io.netty.buffer.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

replace

public FullHttpResponse replace(io.netty.buffer.ByteBuf content)

Specified by:

replace in interface io.netty.buffer.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