io.micronaut.http.client.netty

Class FullNettyClientHttpResponse<B>

java.lang.Object

io.micronaut.http.client.netty.FullNettyClientHttpResponse<B>

Type Parameters:

B - The response type

All Implemented Interfaces:

Completable, AttributeHolder, MutableAttributeHolder, HttpMessage<B>, HttpResponse<B>, NettyHttpResponseBuilder

@Internal
public class FullNettyClientHttpResponse<B>
extends Object
implements HttpResponse<B>, Completable, NettyHttpResponseBuilder

Wraps a Netty FullHttpResponse for consumption by the HttpClient.

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method and Description
MutableConvertibleValues<Object>	getAttributes() A MutableConvertibleValues of the attributes for this HTTP message.
Optional<B>	getBody()
<T> Optional<T>	getBody(Argument<T> type) Return the body as the given type.
<T> Optional<T>	getBody(Class<T> type) Return the body as the given type.
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.
HttpHeaders	getHeaders()
io.netty.handler.codec.http.FullHttpResponse	getNativeResponse()
HttpStatus	getStatus()
boolean	isStream()
void	onComplete() * Successful terminal state.
String	reason()
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.HttpResponse

accepted, accepted, badRequest, badRequest, body, code, created, created, created, 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.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, toStreamHttpResponse, toStreamResponse

Method Detail

reason

public String reason()

Specified by:

reason in interface HttpResponse<B>

Returns:

The HTTP status reason phrase

getStatus

public HttpStatus getStatus()

Specified by:

getStatus in interface HttpResponse<B>

Returns:

The current status

getHeaders

public HttpHeaders getHeaders()

Specified by:

getHeaders in interface HttpMessage<B>

Returns:

The HttpHeaders 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

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 MutableAttributeHolder

Specified by:

getAttributes in interface HttpMessage<B>

Returns:

The attributes of the message

getBody

public Optional<B> getBody()

Specified by:

getBody in interface HttpMessage<B>

Returns:

The request body

getBody

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

Description copied from interface: HttpMessage

Return the body as the given type.

Specified by:

getBody in interface HttpMessage<B>

Type Parameters:

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

getNativeResponse

public io.netty.handler.codec.http.FullHttpResponse getNativeResponse()

Returns:

The Netty native response object

getBody

public <T> Optional<T> getBody(Argument<T> type)

Description copied from interface: HttpMessage

Return the body as the given type.

Specified by:

getBody in interface HttpMessage<B>

Type Parameters:

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

onComplete

public void onComplete()

Description copied from interface: Completable

* Successful terminal state. To be called when the operation is complete.

Specified by:

onComplete in interface Completable

See Also:

Subscriber.onComplete()

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

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.