io.netty.handler.codec.http

Class DefaultFullHttpRequest

java.lang.Object

io.netty.handler.codec.http.DefaultHttpObject

io.netty.handler.codec.http.DefaultHttpMessage

io.netty.handler.codec.http.DefaultHttpRequest

io.netty.handler.codec.http.DefaultFullHttpRequest

All Implemented Interfaces:

ByteBufHolder, DecoderResultProvider, FullHttpMessage, FullHttpRequest, HttpContent, HttpMessage, HttpObject, HttpRequest, LastHttpContent, ReferenceCounted

public class DefaultFullHttpRequest
extends DefaultHttpRequest
implements FullHttpRequest

Default implementation of FullHttpRequest.

Field Summary

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

EMPTY_LAST_CONTENT

Constructor Summary

Constructors

Constructor and Description
DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri) Create a full HTTP response with the given HTTP version, method, and URI.
DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri, boolean validateHeaders) Deprecated. Use the DefaultFullHttpRequest(HttpVersion, HttpMethod, String, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri, ByteBuf content) Create a full HTTP response with the given HTTP version, method, URI, and contents.
DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri, ByteBuf content, boolean validateHeaders) Deprecated. Use the DefaultFullHttpRequest(HttpVersion, HttpMethod, String, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.
DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri, ByteBuf content, HttpHeadersFactory headersFactory, HttpHeadersFactory trailersFactory) Create a full HTTP response with the given HTTP version, method, URI, contents, and factories for creating headers and trailers.
DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri, ByteBuf content, HttpHeaders headers, HttpHeaders trailingHeader) Create a full HTTP response with the given HTTP version, method, URI, contents, and header and trailer objects.

Method Summary

Modifier and Type	Method and Description
ByteBuf	content() Return the data which is held by this ByteBufHolder.
FullHttpRequest	copy() Creates a deep copy of this ByteBufHolder.
FullHttpRequest	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.
FullHttpRequest	replace(ByteBuf content) Returns a new ByteBufHolder which contains the specified content.
FullHttpRequest	retain() Increases the reference count by 1.
FullHttpRequest	retain(int increment) Increases the reference count by the specified increment.
FullHttpRequest	retainedDuplicate() Duplicates this ByteBufHolder.
FullHttpRequest	setMethod(HttpMethod method) Set the HttpMethod of this HttpRequest.
FullHttpRequest	setProtocolVersion(HttpVersion version) Set the protocol version of this HttpMessage
FullHttpRequest	setUri(String uri) Set the requested URI (or alternatively, path)
String	toString()
FullHttpRequest	touch() Records the current access location of this object for debugging purposes.
FullHttpRequest	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.DefaultHttpRequest

getMethod, getUri, method, uri

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.HttpRequest

getMethod, getUri, method, uri

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

DefaultFullHttpRequest

public DefaultFullHttpRequest(HttpVersion httpVersion,
                              HttpMethod method,
                              String uri)

Create a full HTTP response with the given HTTP version, method, and URI.

DefaultFullHttpRequest

public DefaultFullHttpRequest(HttpVersion httpVersion,
                              HttpMethod method,
                              String uri,
                              ByteBuf content)

Create a full HTTP response with the given HTTP version, method, URI, and contents.

DefaultFullHttpRequest

@Deprecated
public DefaultFullHttpRequest(HttpVersion httpVersion,
                                          HttpMethod method,
                                          String uri,
                                          boolean validateHeaders)

Deprecated. Use the DefaultFullHttpRequest(HttpVersion, HttpMethod, String, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.

Create a full HTTP response with the given HTTP version, method, URI, and optional validation.

DefaultFullHttpRequest

@Deprecated
public DefaultFullHttpRequest(HttpVersion httpVersion,
                                          HttpMethod method,
                                          String uri,
                                          ByteBuf content,
                                          boolean validateHeaders)

Deprecated. Use the DefaultFullHttpRequest(HttpVersion, HttpMethod, String, ByteBuf, HttpHeadersFactory, HttpHeadersFactory) constructor instead.

Create a full HTTP response with the given HTTP version, method, URI, contents, and optional validation.

DefaultFullHttpRequest

public DefaultFullHttpRequest(HttpVersion httpVersion,
                              HttpMethod method,
                              String uri,
                              ByteBuf content,
                              HttpHeadersFactory headersFactory,
                              HttpHeadersFactory trailersFactory)

Create a full HTTP response with the given HTTP version, method, URI, contents, and factories for creating headers and trailers.

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

DefaultFullHttpRequest

public DefaultFullHttpRequest(HttpVersion httpVersion,
                              HttpMethod method,
                              String uri,
                              ByteBuf content,
                              HttpHeaders headers,
                              HttpHeaders trailingHeader)

Create a full HTTP response with the given HTTP version, method, URI, contents, and header and trailer objects.

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 FullHttpRequest 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 FullHttpRequest

Specified by:

retain in interface HttpContent

Specified by:

retain in interface LastHttpContent

Specified by:

retain in interface ReferenceCounted

retain

public FullHttpRequest 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 FullHttpRequest

Specified by:

retain in interface HttpContent

Specified by:

retain in interface LastHttpContent

Specified by:

retain in interface ReferenceCounted

touch

public FullHttpRequest 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 FullHttpRequest

Specified by:

touch in interface HttpContent

Specified by:

touch in interface LastHttpContent

Specified by:

touch in interface ReferenceCounted

touch

public FullHttpRequest 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 FullHttpRequest

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 FullHttpRequest setProtocolVersion(HttpVersion version)

Description copied from interface: HttpMessage

Set the protocol version of this HttpMessage

Specified by:

setProtocolVersion in interface FullHttpRequest

Specified by:

setProtocolVersion in interface HttpMessage

Specified by:

setProtocolVersion in interface HttpRequest

Overrides:

setProtocolVersion in class DefaultHttpRequest

setMethod

public FullHttpRequest setMethod(HttpMethod method)

Description copied from interface: HttpRequest

Set the HttpMethod of this HttpRequest.

Specified by:

setMethod in interface FullHttpRequest

Specified by:

setMethod in interface HttpRequest

Overrides:

setMethod in class DefaultHttpRequest

setUri

public FullHttpRequest setUri(String uri)

Description copied from interface: HttpRequest

Set the requested URI (or alternatively, path)

Specified by:

setUri in interface FullHttpRequest

Specified by:

setUri in interface HttpRequest

Overrides:

setUri in class DefaultHttpRequest

copy

public FullHttpRequest 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 FullHttpRequest

Specified by:

copy in interface HttpContent

Specified by:

copy in interface LastHttpContent

duplicate

public FullHttpRequest 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 FullHttpRequest

Specified by:

duplicate in interface HttpContent

Specified by:

duplicate in interface LastHttpContent

retainedDuplicate

public FullHttpRequest 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 FullHttpRequest

Specified by:

retainedDuplicate in interface HttpContent

Specified by:

retainedDuplicate in interface LastHttpContent

See Also:

ByteBuf.retainedDuplicate()

replace

public FullHttpRequest 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 FullHttpRequest

Specified by:

replace in interface HttpContent

Specified by:

replace in interface LastHttpContent

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultHttpRequest

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultHttpRequest

toString

public String toString()

Overrides:

toString in class DefaultHttpRequest