Package io.micronaut.http.netty

Class NettyMutableHttpResponse<B>

java.lang.Object

io.micronaut.http.netty.NettyMutableHttpResponse<B>

Type Parameters:

B - The response body

All Implemented Interfaces:

AttributeHolder, MutableAttributeHolder, HttpMessage<B>, HttpResponse<B>, MutableHttpMessage<B>, MutableHttpResponse<B>, NettyHttpResponseBuilder

@Internal
public final class NettyMutableHttpResponse<B>
extends Object
implements MutableHttpResponse<B>, NettyHttpResponseBuilder

Delegates to Netty's FullHttpResponse.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor	Description
NettyMutableHttpResponse(ConversionService conversionService)
NettyMutableHttpResponse(io.netty.handler.codec.http.FullHttpResponse nettyResponse, ConversionService conversionService)
NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, ConversionService conversionService)	Creates a new instance.
NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, io.netty.handler.codec.http.HttpHeaders nettyHeaders, Object body, ConversionService conversionService)	Creates a new instance.
NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, Object body, ConversionService conversionService)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
<T> MutableHttpResponse<T>	body(T body)	Sets the body.
MutableHttpMessage<B>	bodyWriter(MessageBodyWriter<B> messageBodyWriter)	Sets the message body writer to use.
int	code()
MutableHttpResponse<B>	contentType(MediaType mediaType)	Set the response content type.
MutableHttpResponse<B>	cookie(Cookie cookie)	Adds the specified cookie to the response.
MutableHttpResponse<B>	cookies(Set<Cookie> cookies)	Adds the specified cookies to the response.
MutableConvertibleValues<Object>	getAttributes()	A MutableConvertibleValues of the attributes for this HTTP message.
Optional<B>	getBody()
<T> Optional<T>	getBody(ArgumentConversionContext<T> conversionContext)	Return the body, will use the provided conversion context if needed.
<T1> Optional<T1>	getBody(Class<T1> type)	Return the body as the given type.
Optional<MessageBodyWriter<B>>	getBodyWriter()
Optional<Cookie>	getCookie(String name)	Helper method for retrieving a single Cookie on a response.
Cookies	getCookies()	Helper method for retrieving all Cookies on a response.
MutableHttpHeaders	getHeaders()
io.netty.handler.codec.http.HttpHeaders	getNettyHeaders()	The netty headers.
io.netty.handler.codec.http.HttpResponseStatus	getNettyHttpStatus()	The netty http response status.
io.netty.handler.codec.http.HttpVersion	getNettyHttpVersion()	The netty http version.
boolean	isStream()
String	reason()
HttpResponse<B>	setAttribute(CharSequence name, Object value)	Sets an attribute on the message.
MutableHttpResponse<B>	status(int status, CharSequence message)	Sets the response status.
@NonNull io.netty.handler.codec.http.FullHttpResponse	toFullHttpResponse()	Converts this object to a full http response.
@NonNull io.netty.handler.codec.http.HttpResponse	toHttpResponse()	Converts this object to the most appropriate http response type.
static @NonNull io.netty.handler.codec.http.HttpResponse	toNoBodyResponse(HttpResponse<?> response)	Create a non-body netty response from the given MN response.
@NonNull StreamedHttpResponse	toStreamHttpResponse()	Converts this object to a streamed http response.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Methods inherited from interface io.micronaut.http.HttpMessage

getBody, getCharacterEncoding, getContentLength, getContentType, getLocale

Methods inherited from interface io.micronaut.http.HttpResponse

body, getStatus, header, status

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

removeAttribute

Methods inherited from interface io.micronaut.http.MutableHttpMessage

basicAuth, bearerAuth

Methods inherited from interface io.micronaut.http.MutableHttpResponse

attribute, characterEncoding, characterEncoding, contentEncoding, contentLength, contentType, header, headers, headers, locale, status, status, status, toMutableResponse

Constructor Details

NettyMutableHttpResponse

public NettyMutableHttpResponse(io.netty.handler.codec.http.FullHttpResponse nettyResponse,
 ConversionService conversionService)

Parameters:

nettyResponse - The FullHttpResponse

conversionService - The conversion service

NettyMutableHttpResponse

public NettyMutableHttpResponse(ConversionService conversionService)

Parameters:

conversionService - The conversion service

NettyMutableHttpResponse

public NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion,
 io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus,
 ConversionService conversionService)

Creates a new instance.

Parameters:

httpVersion - The http version

httpResponseStatus - THe http response status

conversionService - The conversion service

NettyMutableHttpResponse

public NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion,
 io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus,
 Object body,
 ConversionService conversionService)

Creates a new instance.

Parameters:

httpVersion - The http version

httpResponseStatus - THe http response status

body - The body

conversionService - The conversion service

NettyMutableHttpResponse

public NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion,
 io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus,
 io.netty.handler.codec.http.HttpHeaders nettyHeaders,
 Object body,
 ConversionService conversionService)

Creates a new instance.

Parameters:

httpVersion - The http version

httpResponseStatus - THe http response status

nettyHeaders - The http headers

body - The body

conversionService - The conversion service

Method Details

toNoBodyResponse

@NonNull
public static @NonNull io.netty.handler.codec.http.HttpResponse toNoBodyResponse(@NonNull
 HttpResponse<?> response)

Create a non-body netty response from the given MN response.

Parameters:

response - The mn response

Returns:

The netty response

getBodyWriter

public Optional<MessageBodyWriter<B>> getBodyWriter()

Specified by:

getBodyWriter in interface HttpMessage<B>

Returns:

The body writer.

bodyWriter

public MutableHttpMessage<B> bodyWriter(MessageBodyWriter<B> messageBodyWriter)

Description copied from interface: MutableHttpMessage

Sets the message body writer to use.

Specified by:

bodyWriter in interface MutableHttpMessage<B>

Parameters:

messageBodyWriter - The message body writer.

Returns:

This response

getNettyHttpVersion

public io.netty.handler.codec.http.HttpVersion getNettyHttpVersion()

The netty http version.

Returns:

http version

getNettyHttpStatus

public io.netty.handler.codec.http.HttpResponseStatus getNettyHttpStatus()

The netty http response status.

Returns:

http response status

getNettyHeaders

public io.netty.handler.codec.http.HttpHeaders getNettyHeaders()

The netty headers.

Returns:

netty headers

toString

public String toString()

Overrides:

toString in class Object

getHeaders

public MutableHttpHeaders getHeaders()

Specified by:

getHeaders in interface HttpMessage<B>

Specified by:

getHeaders in interface MutableHttpMessage<B>

Returns:

The HttpHeaders object

getAttributes

public MutableConvertibleValues<Object> getAttributes()

Description copied from interface: HttpMessage

A MutableConvertibleValues of the attributes for this HTTP message.

Attributes are designed for internal data sharing and hence are isolated from headers and parameters which are client supplied

Specified by:

getAttributes in interface AttributeHolder

Specified by:

getAttributes in interface HttpMessage<B>

Specified by:

getAttributes in interface MutableAttributeHolder

Returns:

The attributes of the message

setAttribute

public HttpResponse<B> setAttribute(CharSequence name,
 Object value)

Description copied from interface: MutableAttributeHolder

Sets an attribute on the message.

Specified by:

setAttribute in interface HttpMessage<B>

Specified by:

setAttribute in interface HttpResponse<B>

Specified by:

setAttribute in interface MutableAttributeHolder

Parameters:

name - The name of the attribute

value - The value of the attribute

Returns:

This message

code

public int code()

Specified by:

code in interface HttpResponse<B>

Returns:

The response status code

reason

public String reason()

Specified by:

reason in interface HttpResponse<B>

Returns:

The HTTP status reason phrase

cookie

public MutableHttpResponse<B> cookie(Cookie cookie)

Description copied from interface: MutableHttpResponse

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

Specified by:

cookie in interface MutableHttpResponse<B>

Parameters:

cookie - the Cookie to return to the client

Returns:

This response object

cookies

public MutableHttpResponse<B> cookies(Set<Cookie> cookies)

Description copied from interface: MutableHttpResponse

Adds the specified cookies to the response.

Specified by:

cookies in interface MutableHttpResponse<B>

Parameters:

cookies - the Set of Cookies to return to the client

Returns:

This response object

getCookies

public Cookies getCookies()

Description copied from interface: HttpResponse

Helper method for retrieving all Cookies on a response.

Specified by:

getCookies in interface HttpResponse<B>

Returns:

The cookies on the response

getCookie

public Optional<Cookie> getCookie(String name)

Description copied from interface: HttpResponse

Helper method for retrieving a single Cookie on a response.

Specified by:

getCookie in interface HttpResponse<B>

Parameters:

name - The name of the Cookie

Returns:

The Cookie

getBody

public Optional<B> getBody()

Specified by:

getBody in interface HttpMessage<B>

Returns:

The request body

getBody

public <T1> Optional<T1> getBody(Class<T1> type)

Description copied from interface: HttpMessage

Return the body as the given type.

Specified by:

getBody in interface HttpMessage<B>

Type Parameters:

T1 - The generic type

Parameters:

type - The type of the body

Returns:

An Optional of the type or Optional.empty() if the body cannot be returned as the given type

getBody

public <T> Optional<T> getBody(ArgumentConversionContext<T> conversionContext)

Description copied from interface: HttpMessage

Return the body, will use the provided conversion context if needed.

Specified by:

getBody in interface HttpMessage<B>

Type Parameters:

T - The generic type

Parameters:

conversionContext - The body conversion context

Returns:

An Optional of the type or Optional.empty() if the body cannot be returned as the given type

status

public MutableHttpResponse<B> status(int status,
 CharSequence message)

Description copied from interface: MutableHttpResponse

Sets the response status.

Specified by:

status in interface MutableHttpResponse<B>

Parameters:

status - The status

message - The message

Returns:

This response object

body

public <T> MutableHttpResponse<T> body(@Nullable
 T body)

Description copied from interface: MutableHttpResponse

Sets the body.

Specified by:

body in interface MutableHttpMessage<B>

Specified by:

body in interface MutableHttpResponse<B>

Type Parameters:

T - The new body type

Parameters:

body - The body

Returns:

This response object

contentType

public MutableHttpResponse<B> contentType(MediaType mediaType)

Description copied from interface: MutableHttpMessage

Set the response content type.

Specified by:

contentType in interface MutableHttpMessage<B>

Specified by:

contentType in interface MutableHttpResponse<B>

Parameters:

mediaType - The media type

Returns:

This response

toFullHttpResponse

@NonNull
public @NonNull io.netty.handler.codec.http.FullHttpResponse toFullHttpResponse()

Description copied from interface: NettyHttpResponseBuilder

Converts this object to a full http response.

Specified by:

toFullHttpResponse in interface NettyHttpResponseBuilder

Returns:

a full http response

toStreamHttpResponse

@NonNull
public @NonNull StreamedHttpResponse toStreamHttpResponse()

Description copied from interface: NettyHttpResponseBuilder

Converts this object to a streamed http response.

Specified by:

toStreamHttpResponse in interface NettyHttpResponseBuilder

Returns:

The streamed response

toHttpResponse

@NonNull
public @NonNull io.netty.handler.codec.http.HttpResponse toHttpResponse()

Description copied from interface: NettyHttpResponseBuilder

Converts this object to the most appropriate http response type.

Specified by:

toHttpResponse in interface NettyHttpResponseBuilder

Returns:

The http response

isStream

public boolean isStream()

Specified by:

isStream in interface NettyHttpResponseBuilder

Returns:

Is the response a stream.