com.azure.core.http

Class HttpResponse

java.lang.Object

com.azure.core.http.HttpResponse

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class HttpResponse
extends Object
implements Closeable

The type representing response of HttpRequest.

Constructor Summary

Constructors

Constructor and Description
HttpResponse()

Method Summary

Modifier and Type	Method and Description
abstract reactor.core.publisher.Flux<io.netty.buffer.ByteBuf>	body() Get the publisher emitting response content chunks.
abstract reactor.core.publisher.Mono<byte[]>	bodyAsByteArray() Get the response content as a byte[].
abstract reactor.core.publisher.Mono<String>	bodyAsString() Get the response content as a string.
abstract reactor.core.publisher.Mono<String>	bodyAsString(Charset charset) Get the response content as a string.
HttpResponse	buffer() Get a new Response object wrapping this response with it's content buffered into memory.
void	close() Closes the response content stream, if any.
abstract HttpHeaders	headers() Get all response headers.
abstract String	headerValue(String name) Lookup a response header with the provided name.
HttpRequest	request() Get the request which resulted in this response.
HttpResponse	request(HttpRequest request) Sets the request which resulted in this HttpResponse.
abstract int	statusCode() Get the response status code.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponse

public HttpResponse()

Method Detail

statusCode

public abstract int statusCode()

Get the response status code.

Returns:

the response status code

headerValue

public abstract String headerValue(String name)

Lookup a response header with the provided name.

Parameters:

name - the name of the header to lookup.

Returns:

the value of the header, or null if the header doesn't exist in the response.

headers

public abstract HttpHeaders headers()

Get all response headers.

Returns:

the response headers

body

public abstract reactor.core.publisher.Flux<io.netty.buffer.ByteBuf> body()

Get the publisher emitting response content chunks.

Returns a stream of the response's body content. Emissions may occur on the Netty EventLoop threads which are shared across channels and should not be blocked. Blocking should be avoided as much as possible/practical in reactive programming but if you do use methods like blockingSubscribe or blockingGet on the stream then be sure to use subscribeOn and observeOn before the blocking call. For example:

 
   response.body()
     .map(bb -> bb.limit())
     .reduce((x,y) -> x + y)
     .subscribeOn(Schedulers.io())
     .observeOn(Schedulers.io())
     .blockingGet();
 
 

The above code is a simplistic example and would probably run fine without the `subscribeOn` and `observeOn` but should be considered a template for more complex situations.

Returns:

The response's content as a stream of ByteBuf.

bodyAsByteArray

public abstract reactor.core.publisher.Mono<byte[]> bodyAsByteArray()

Get the response content as a byte[].

Returns:

this response content as a byte[]

bodyAsString

public abstract reactor.core.publisher.Mono<String> bodyAsString()

Get the response content as a string.

Returns:

This response content as a string

bodyAsString

public abstract reactor.core.publisher.Mono<String> bodyAsString(Charset charset)

Get the response content as a string.

Parameters:

charset - the charset to use as encoding

Returns:

This response content as a string

request

public final HttpRequest request()

Get the request which resulted in this response.

Returns:

the request which resulted in this response.

request

public final HttpResponse request(HttpRequest request)

Sets the request which resulted in this HttpResponse.

Parameters:

request - the request

Returns:

this HTTP response

buffer

public HttpResponse buffer()

Get a new Response object wrapping this response with it's content buffered into memory.

Returns:

the new Response object

close

public void close()

Closes the response content stream, if any.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable