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:

io.micronaut.core.attr.AttributeHolder, io.micronaut.core.attr.MutableAttributeHolder, io.micronaut.http.HttpMessage<B>, io.micronaut.http.HttpResponse<B>, io.micronaut.http.MutableHttpMessage<B>, io.micronaut.http.MutableHttpResponse<B>, NettyHttpResponseBuilder

@Internal
public class NettyMutableHttpResponse<B>
extends java.lang.Object
implements io.micronaut.http.MutableHttpResponse<B>, NettyHttpResponseBuilder

Delegates to Netty's FullHttpResponse.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
NettyMutableHttpResponse(io.micronaut.core.convert.ConversionService conversionService)
NettyMutableHttpResponse(io.netty.handler.codec.http.FullHttpResponse nettyResponse, io.micronaut.core.convert.ConversionService conversionService)
NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, io.micronaut.core.convert.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, java.lang.Object body, io.micronaut.core.convert.ConversionService conversionService) Creates a new instance.
NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, java.lang.Object body, io.micronaut.core.convert.ConversionService conversionService) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
<T> io.micronaut.http.MutableHttpResponse<T>	body(T body)
int	code()
io.micronaut.http.MutableHttpResponse<B>	cookie(io.micronaut.http.cookie.Cookie cookie)
io.micronaut.http.MutableHttpResponse<B>	cookies(java.util.Set<io.micronaut.http.cookie.Cookie> cookies)
io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>	getAttributes()
java.util.Optional<B>	getBody()
<T> java.util.Optional<T>	getBody(io.micronaut.core.type.Argument<T> type)
<T1> java.util.Optional<T1>	getBody(java.lang.Class<T1> type)
io.micronaut.http.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.
io.netty.handler.codec.http.cookie.ServerCookieEncoder	getServerCookieEncoder()
io.micronaut.http.HttpStatus	getStatus()
boolean	isStream()
java.lang.String	reason()
void	setServerCookieEncoder(io.netty.handler.codec.http.cookie.ServerCookieEncoder serverCookieEncoder)
io.micronaut.http.MutableHttpResponse<B>	status(io.micronaut.http.HttpStatus status, java.lang.CharSequence message)
io.netty.handler.codec.http.FullHttpResponse	toFullHttpResponse() Converts this object to a full http response.
io.netty.handler.codec.http.HttpResponse	toHttpResponse() Converts this object to the most appropriate http response type.
StreamedHttpResponse	toStreamHttpResponse() Converts this object to a streamed http response.
java.lang.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.http.MutableHttpResponse

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

Methods inherited from interface io.micronaut.http.HttpResponse

accepted, accepted, badRequest, badRequest, body, created, created, created, getCookie, getCookies, header, noContent, notAllowed, notAllowed, notAllowedGeneric, notFound, notFound, notModified, ok, ok, permanentRedirect, redirect, seeOther, serverError, serverError, setAttribute, status, status, status, temporaryRedirect, unauthorized, unprocessableEntity, uri

Methods inherited from interface io.micronaut.http.MutableHttpMessage

basicAuth, bearerAuth

Methods inherited from interface io.micronaut.http.HttpMessage

getCharacterEncoding, getContentLength, getContentType, getLocale

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

removeAttribute

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

getAttribute, getAttribute

Methods inherited from interface io.micronaut.http.netty.NettyHttpResponseBuilder

toHttpResponse, toStreamResponse

Constructor Detail

NettyMutableHttpResponse

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

Parameters:

nettyResponse - The FullHttpResponse

conversionService - The conversion service

NettyMutableHttpResponse

public NettyMutableHttpResponse(io.micronaut.core.convert.ConversionService conversionService)

Parameters:

conversionService - The conversion service

NettyMutableHttpResponse

public NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion,
                                io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus,
                                io.micronaut.core.convert.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,
                                java.lang.Object body,
                                io.micronaut.core.convert.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,
                                java.lang.Object body,
                                io.micronaut.core.convert.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 Detail

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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHeaders

public io.micronaut.http.MutableHttpHeaders getHeaders()

Specified by:

getHeaders in interface io.micronaut.http.HttpMessage<B>

Specified by:

getHeaders in interface io.micronaut.http.MutableHttpMessage<B>

getAttributes

public io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object> getAttributes()

Specified by:

getAttributes in interface io.micronaut.core.attr.AttributeHolder

Specified by:

getAttributes in interface io.micronaut.core.attr.MutableAttributeHolder

Specified by:

getAttributes in interface io.micronaut.http.HttpMessage<B>

getStatus

public io.micronaut.http.HttpStatus getStatus()

Specified by:

getStatus in interface io.micronaut.http.HttpResponse<B>

code

public int code()

Specified by:

code in interface io.micronaut.http.HttpResponse<B>

reason

public java.lang.String reason()

Specified by:

reason in interface io.micronaut.http.HttpResponse<B>

cookie

public io.micronaut.http.MutableHttpResponse<B> cookie(io.micronaut.http.cookie.Cookie cookie)

Specified by:

cookie in interface io.micronaut.http.MutableHttpResponse<B>

cookies

public io.micronaut.http.MutableHttpResponse<B> cookies(java.util.Set<io.micronaut.http.cookie.Cookie> cookies)

Specified by:

cookies in interface io.micronaut.http.MutableHttpResponse<B>

getBody

public java.util.Optional<B> getBody()

Specified by:

getBody in interface io.micronaut.http.HttpMessage<B>

getBody

public <T1> java.util.Optional<T1> getBody(java.lang.Class<T1> type)

Specified by:

getBody in interface io.micronaut.http.HttpMessage<B>

getBody

public <T> java.util.Optional<T> getBody(io.micronaut.core.type.Argument<T> type)

Specified by:

getBody in interface io.micronaut.http.HttpMessage<B>

status

public io.micronaut.http.MutableHttpResponse<B> status(io.micronaut.http.HttpStatus status,
                                                       java.lang.CharSequence message)

Specified by:

status in interface io.micronaut.http.MutableHttpResponse<B>

body

public <T> io.micronaut.http.MutableHttpResponse<T> body(@Nullable
                                                         T body)

Specified by:

body in interface io.micronaut.http.MutableHttpMessage<B>

Specified by:

body in interface io.micronaut.http.MutableHttpResponse<B>

getServerCookieEncoder

public io.netty.handler.codec.http.cookie.ServerCookieEncoder getServerCookieEncoder()

Returns:

Server cookie encoder

setServerCookieEncoder

public void setServerCookieEncoder(io.netty.handler.codec.http.cookie.ServerCookieEncoder serverCookieEncoder)

Parameters:

serverCookieEncoder - Server cookie encoder

toFullHttpResponse

@NonNull
public 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 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 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.