Package 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:

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

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

Wraps a Netty FullHttpResponse for consumption by the HttpClient.

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method	Description
int	code()
@NonNull MutableConvertibleValues<Object>	getAttributes()	A MutableConvertibleValues of the attributes for this HTTP message.
@NonNull Optional<B>	getBody()
<T> @NonNull Optional<T>	getBody(@NonNull Argument<T> type)	Return the body as the given type.
<T> @NonNull Optional<T>	getBody(@NonNull 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.
@NonNull HttpHeaders	getHeaders()
boolean	isStream()
String	reason()
@NonNull 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.core.attr.AttributeHolder

getAttribute, getAttribute

Methods inherited from interface io.micronaut.http.HttpMessage

getBody, getBodyWriter, getCharacterEncoding, getContentLength, getContentType, getLocale

Methods inherited from interface io.micronaut.http.HttpResponse

body, getStatus, header, setAttribute, status, toMutableResponse

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

removeAttribute

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

toStreamHttpResponse

Method Details

reason

public String reason()

Specified by:

reason in interface HttpResponse<B>

Returns:

The HTTP status reason phrase

code

public int code()

Specified by:

code in interface HttpResponse<B>

Returns:

The response status code

getHeaders

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

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

getBody

@NonNull
public @NonNull Optional<B> getBody()

Specified by:

getBody in interface HttpMessage<B>

Returns:

The request body

getBody

@NonNull
public <T> @NonNull Optional<T> getBody(@NonNull
 @NonNull 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

getBody

@NonNull
public <T> @NonNull Optional<T> getBody(@NonNull
 @NonNull 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

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

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.