Package eu.cloudnetservice.driver.network.netty.http

Class NettyHttpServerResponse

java.lang.Object

eu.cloudnetservice.driver.network.netty.http.NettyHttpMessage

eu.cloudnetservice.driver.network.netty.http.NettyHttpServerResponse

All Implemented Interfaces:

HttpMessage<HttpResponse>, HttpResponse

final class NettyHttpServerResponse
extends NettyHttpMessage
implements HttpResponse

The default netty based implementation of a http response.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final NettyHttpServerContext	context
(package private) final io.netty5.handler.codec.http.FullHttpResponse	httpResponse
private InputStream	responseInputStream

Constructor Summary

Constructors

Constructor	Description
NettyHttpServerResponse(@NonNull NettyHttpServerContext context, @NonNull io.netty5.handler.codec.http.HttpRequest httpRequest)	Constructs a new netty http response instance.

Method Summary

Modifier and Type	Method	Description
byte[]	body()	Get the body content of this http message converted to a byte array.
@NonNull HttpResponse	body(byte[] byteArray)	Sets the body of the http message.
@NonNull HttpResponse	body(@NonNull String text)	Sets the body to the given string.
@NonNull HttpResponse	body(InputStream body)	Sets the body of this http message to the given input stream.
@NonNull String	bodyAsString()	Converts the body of the http message into an utf-8 encoded string.
InputStream	bodyStream()	Get the body as a streamable content source to reduce the heap load when reading the body content.
@NonNull HttpResponse	clearHeaders()	Removes all headers from this message.
@NonNull HttpContext	context()	Get the context this message is processed in.
boolean	hasBody()	Get if the current http message has a body present.
boolean	hasHeader(@NonNull String name)	Checks if this message has a header with the given name set.
@Nullable String	header(@NonNull String name)	Get a header value by the given name.
@NonNull HttpResponse	header(@NonNull String name, @NonNull String value)	Sets the given header, replacing the current one if already set.
boolean	headerAsBoolean(@NonNull String name)	Get the header value by the given name, converted to a bool.
@Nullable Integer	headerAsInt(@NonNull String name)	Get a header value by the given name, converted to an int.
@NonNull Map<String,String>	headers()	Get all headers of this message converted to a map.
@NonNull HttpResponse	removeHeader(@NonNull String name)	Removes a header by the given name from this message.
@NonNull HttpResponseCode	status()	The status code of the http response.
@NonNull HttpResponse	status(@NonNull HttpResponseCode code)	Sets the status of this response.
@NonNull HttpVersion	version()	Get the http version of this http message.
@NonNull HttpResponse	version(@NonNull HttpVersion version)	Sets the version of this http message.

Methods inherited from class eu.cloudnetservice.driver.network.netty.http.NettyHttpMessage

versionFromNetty, versionToNetty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

httpResponse

final io.netty5.handler.codec.http.FullHttpResponse httpResponse

context

private final NettyHttpServerContext context

responseInputStream

private InputStream responseInputStream

Constructor Details

NettyHttpServerResponse

public NettyHttpServerResponse(@NonNull
 @NonNull NettyHttpServerContext context,
 @NonNull
 @NonNull io.netty5.handler.codec.http.HttpRequest httpRequest)

Constructs a new netty http response instance.

Parameters:

context - the context in which the request (and this response to the request) is handled.

httpRequest - the original unwrapped request sent to the server.

Throws:

NullPointerException - if either the context or request is null.

Method Details

status

@NonNull
public @NonNull HttpResponseCode status()

The status code of the http response. The response status code set here should, but must not be a valid one. See the mdn documentation about status codes for more information.

Specified by:

status in interface HttpResponse

Returns:

the http response code of this response.

status

@NonNull
public @NonNull HttpResponse status(@NonNull
 @NonNull HttpResponseCode code)

Sets the status of this response.

Specified by:

status in interface HttpResponse

Parameters:

code - the new response status.

Returns:

the same instance as used to call the method, for chaining.

context

@NonNull
public @NonNull HttpContext context()

Get the context this message is processed in.

Specified by:

context in interface HttpMessage<HttpResponse>

Returns:

the associated context of this message.

header

@Nullable
public @Nullable String header(@NonNull
 @NonNull String name)

Get a header value by the given name.

Specified by:

header in interface HttpMessage<HttpResponse>

Parameters:

name - the name of the header to get.

Returns:

the header value or null if the header does not exist.

headerAsInt

@Nullable
public @Nullable Integer headerAsInt(@NonNull
 @NonNull String name)

Get a header value by the given name, converted to an int. Returns null if the header cannot be converted to an int or does not exist.

Specified by:

headerAsInt in interface HttpMessage<HttpResponse>

Parameters:

name - the name of the header to get.

Returns:

the header value converted to an int or null.

headerAsBoolean

public boolean headerAsBoolean(@NonNull
 @NonNull String name)

Get the header value by the given name, converted to a bool. If the header does not exist the method defaults to false.

Specified by:

headerAsBoolean in interface HttpMessage<HttpResponse>

Parameters:

name - the name of the header to get.

Returns:

the value converted to a bool or false if the header does not exist.

header

@NonNull
public @NonNull HttpResponse header(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull String value)

Sets the given header, replacing the current one if already set.

Specified by:

header in interface HttpMessage<HttpResponse>

Parameters:

name - the name of the header.

value - the value of the header.

Returns:

the same message as used to call the method, for chaining.

removeHeader

@NonNull
public @NonNull HttpResponse removeHeader(@NonNull
 @NonNull String name)

Removes a header by the given name from this message.

Specified by:

removeHeader in interface HttpMessage<HttpResponse>

Parameters:

name - the name of the header to remove.

Returns:

the same message as used to call the method, for chaining.

clearHeaders

@NonNull
public @NonNull HttpResponse clearHeaders()

Removes all headers from this message.

Specified by:

clearHeaders in interface HttpMessage<HttpResponse>

Returns:

the same message as used to call the method, for chaining.

hasHeader

public boolean hasHeader(@NonNull
 @NonNull String name)

Checks if this message has a header with the given name set.

Specified by:

hasHeader in interface HttpMessage<HttpResponse>

Parameters:

name - the name of the header to check.

Returns:

true if the header is present, false otherwise.

headers

@NonNull
public @NonNull Map<String,String> headers()

Get all headers of this message converted to a map. The key of the map represents the name of the header, the value of the map represents the value of the header. This map does not allow duplicates.

Specified by:

headers in interface HttpMessage<HttpResponse>

Returns:

all headers of the message collected to a map, duplication free.

version

@NonNull
public @NonNull HttpVersion version()

Get the http version of this http message. CloudNet currently only supports Http 1 and Http 1.1.

Specified by:

version in interface HttpMessage<HttpResponse>

Returns:

the version of this http message.

version

@NonNull
public @NonNull HttpResponse version(@NonNull
 @NonNull HttpVersion version)

Sets the version of this http message.

Specified by:

version in interface HttpMessage<HttpResponse>

Parameters:

version - the version to use.

Returns:

the same message as used to call the method, for chaining.

body

public byte[] body()

Get the body content of this http message converted to a byte array. If there is no need to read the body fully into the heap, prefer HttpMessage.bodyStream() instead.

Specified by:

body in interface HttpMessage<HttpResponse>

Returns:

the body content of this http message.

bodyAsString

@NonNull
public @NonNull String bodyAsString()

Converts the body of the http message into an utf-8 encoded string.

Specified by:

bodyAsString in interface HttpMessage<HttpResponse>

Returns:

the body of the message converted to a string.

body

@NonNull
public @NonNull HttpResponse body(byte[] byteArray)

Sets the body of the http message. If there is no need to load the full body into the heap, prefer streaming the content by using HttpMessage.body(InputStream) instead.

Specified by:

body in interface HttpMessage<HttpResponse>

Parameters:

byteArray - the body as a byte array.

Returns:

the same message as used to call the method, for chaining.

body

@NonNull
public @NonNull HttpResponse body(@NonNull
 @NonNull String text)

Sets the body to the given string. This might be useful to e.g. return a json response.

Specified by:

body in interface HttpMessage<HttpResponse>

Parameters:

text - the body as a string.

Returns:

the same message as used to call the method, for chaining.

bodyStream

public InputStream bodyStream()

Get the body as a streamable content source to reduce the heap load when reading the body content. This method returns null if no http body is provided in the message.

Specified by:

bodyStream in interface HttpMessage<HttpResponse>

Returns:

the body as a content stream, or null if the message has no http body.

body

@NonNull
public @NonNull HttpResponse body(InputStream body)

Sets the body of this http message to the given input stream. Closing of the stream will be done automatically and should not be made after calling the method. Setting the body stream to null will remove the current body.

Specified by:

body in interface HttpMessage<HttpResponse>

Parameters:

body - the new body stream to use.

Returns:

the same message as used to call the method, for chaining.

hasBody

public boolean hasBody()

Get if the current http message has a body present.

Specified by:

hasBody in interface HttpMessage<HttpResponse>

Returns:

if a body is present.