Top Description Fields Constructors Methods
io.netty.handler.codec.http

public Class DefaultFullHttpRequest

extends DefaultHttpRequest
implements FullHttpRequest
Class Inheritance
All Implemented Interfaces
io.netty.handler.codec.http.FullHttpRequest, io.netty.handler.codec.http.FullHttpMessage, io.netty.handler.codec.http.LastHttpContent, io.netty.handler.codec.http.HttpContent, io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted, io.netty.handler.codec.http.HttpObject, io.netty.handler.codec.DecoderResultProvider, io.netty.handler.codec.http.HttpMessage, io.netty.handler.codec.http.HttpRequest
Imports
io.netty.buffer.ByteBuf, .ByteBufUtil, .Unpooled, io.netty.util.IllegalReferenceCountException
Default implementation of FullHttpRequest.

Field Summary

Modifier and TypeField and Description
private final ByteBuf
content

private int
hash

Used to cache the value of the hash code and avoid IllegalReferenceCountException.

private final HttpHeaders
trailingHeader

Constructor Summary

AccessConstructor and Description
public
DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri)

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

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

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

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

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 Summary

Modifier and TypeMethod and Description
public ByteBuf
content()

Implements io.netty.buffer.ByteBufHolder.content.

Return the data which is held by this ByteBufHolder.
public FullHttpRequest
copy()

Implements io.netty.handler.codec.http.FullHttpRequest.copy.

Creates a deep copy of this ByteBufHolder.
public FullHttpRequest
duplicate()

Implements io.netty.handler.codec.http.FullHttpRequest.duplicate.

Duplicates this ByteBufHolder.
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides io.netty.handler.codec.http.DefaultHttpRequest.hashCode.

Returns a hash code value for the object.
public int
refCnt()

Implements io.netty.util.ReferenceCounted.refCnt.

Returns the reference count of this object.
public boolean
release()

Implements io.netty.util.ReferenceCounted.release.

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
public boolean
release(int decrement)

Implements io.netty.util.ReferenceCounted.release.

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
public FullHttpRequest
replace(ByteBuf content)

Implements io.netty.handler.codec.http.FullHttpRequest.replace.

Returns a new ByteBufHolder which contains the specified content.
public FullHttpRequest
retain()

Implements io.netty.handler.codec.http.FullHttpRequest.retain.

Increases the reference count by 1.
public FullHttpRequest
retain(int increment)

Implements io.netty.handler.codec.http.FullHttpRequest.retain.

Increases the reference count by the specified increment.
public FullHttpRequest
retainedDuplicate()

Implements io.netty.handler.codec.http.FullHttpRequest.retainedDuplicate.

Duplicates this ByteBufHolder.
public FullHttpRequest
setMethod(HttpMethod method)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.setMethod.

Implements io.netty.handler.codec.http.FullHttpRequest.setMethod, io.netty.handler.codec.http.HttpRequest.setMethod.

Set the HttpMethod of this HttpRequest.
public FullHttpRequest
setProtocolVersion(HttpVersion version)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.setProtocolVersion.

Implements io.netty.handler.codec.http.FullHttpRequest.setProtocolVersion, io.netty.handler.codec.http.HttpRequest.setProtocolVersion, io.netty.handler.codec.http.HttpMessage.setProtocolVersion.

Set the protocol version of this HttpMessage
public FullHttpRequest
setUri(String uri)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.setUri.

Implements io.netty.handler.codec.http.FullHttpRequest.setUri, io.netty.handler.codec.http.HttpRequest.setUri.

Set the requested URI (or alternatively, path)
public String
toString()

Overrides io.netty.handler.codec.http.DefaultHttpRequest.toString.

Returns a string representation of the object.
public FullHttpRequest
touch()

Implements io.netty.handler.codec.http.FullHttpRequest.touch.

Records the current access location of this object for debugging purposes.
public FullHttpRequest
touch(Object hint)

Implements io.netty.handler.codec.http.FullHttpRequest.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes.
public HttpHeaders
trailingHeaders()

Implements io.netty.handler.codec.http.LastHttpContent.trailingHeaders.

Inherited from io.netty.handler.codec.http.DefaultHttpRequest:
getMethodgetUrimethoduri

Field Detail

contentback to summary
private final ByteBuf content
hashback to summary
private int hash

Used to cache the value of the hash code and avoid IllegalReferenceCountException.

trailingHeaderback to summary
private final HttpHeaders trailingHeader

Constructor Detail

DefaultFullHttpRequestback to summary
public DefaultFullHttpRequest(HttpVersion httpVersion, HttpMethod method, String uri)

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

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

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

DefaultFullHttpRequestback to summary
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.

Annotations
@Deprecated
DefaultFullHttpRequestback to summary
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.

Annotations
@Deprecated
DefaultFullHttpRequestback to summary
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().

DefaultFullHttpRequestback to summary
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

contentback to summary
public ByteBuf content()

Implements io.netty.buffer.ByteBufHolder.content.

Doc from io.netty.buffer.ByteBufHolder.content.

Return the data which is held by this ByteBufHolder.

Annotations
@Override
copyback to summary
public FullHttpRequest copy()

Implements io.netty.handler.codec.http.FullHttpRequest.copy.

Doc from io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

Annotations
@Override
duplicateback to summary
public FullHttpRequest duplicate()

Implements io.netty.handler.codec.http.FullHttpRequest.duplicate.

Doc from io.netty.buffer.ByteBufHolder.duplicate.

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

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides io.netty.handler.codec.http.DefaultHttpRequest.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
refCntback to summary
public int refCnt()

Implements io.netty.util.ReferenceCounted.refCnt.

Doc from io.netty.util.ReferenceCounted.refCnt.

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

Annotations
@Override
releaseback to summary
public boolean release()

Implements io.netty.util.ReferenceCounted.release.

Doc from io.netty.util.ReferenceCounted.release.

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

Returns:boolean

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

Annotations
@Override
releaseback to summary
public boolean release(int decrement)

Implements io.netty.util.ReferenceCounted.release.

Doc from io.netty.util.ReferenceCounted.release.

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

Returns:boolean

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

Annotations
@Override
replaceback to summary
public FullHttpRequest replace(ByteBuf content)

Implements io.netty.handler.codec.http.FullHttpRequest.replace.

Doc from io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Annotations
@Override
retainback to summary
public FullHttpRequest retain()

Implements io.netty.handler.codec.http.FullHttpRequest.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations
@Override
retainback to summary
public FullHttpRequest retain(int increment)

Implements io.netty.handler.codec.http.FullHttpRequest.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations
@Override
retainedDuplicateback to summary
public FullHttpRequest retainedDuplicate()

Implements io.netty.handler.codec.http.FullHttpRequest.retainedDuplicate.

Doc from io.netty.buffer.ByteBufHolder.retainedDuplicate.

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

Annotations
@Override
setMethodback to summary
public FullHttpRequest setMethod(HttpMethod method)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.setMethod.

Implements io.netty.handler.codec.http.FullHttpRequest.setMethod, io.netty.handler.codec.http.HttpRequest.setMethod.

Doc from io.netty.handler.codec.http.HttpRequest.setMethod.

Set the HttpMethod of this HttpRequest.

Annotations
@Override
setProtocolVersionback to summary
public FullHttpRequest setProtocolVersion(HttpVersion version)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.setProtocolVersion.

Implements io.netty.handler.codec.http.FullHttpRequest.setProtocolVersion, io.netty.handler.codec.http.HttpRequest.setProtocolVersion, io.netty.handler.codec.http.HttpMessage.setProtocolVersion.

Doc from io.netty.handler.codec.http.HttpMessage.setProtocolVersion.

Set the protocol version of this HttpMessage

Annotations
@Override
setUriback to summary
public FullHttpRequest setUri(String uri)

Overrides io.netty.handler.codec.http.DefaultHttpRequest.setUri.

Implements io.netty.handler.codec.http.FullHttpRequest.setUri, io.netty.handler.codec.http.HttpRequest.setUri.

Doc from io.netty.handler.codec.http.HttpRequest.setUri.

Set the requested URI (or alternatively, path)

Annotations
@Override
toStringback to summary
public String toString()

Overrides io.netty.handler.codec.http.DefaultHttpRequest.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
touchback to summary
public FullHttpRequest touch()

Implements io.netty.handler.codec.http.FullHttpRequest.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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

Annotations
@Override
touchback to summary
public FullHttpRequest touch(Object hint)

Implements io.netty.handler.codec.http.FullHttpRequest.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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.

Annotations
@Override
trailingHeadersback to summary
public HttpHeaders trailingHeaders()

Implements io.netty.handler.codec.http.LastHttpContent.trailingHeaders.

Annotations
@Override