Package com.azure.core.http
Class HttpResponse
java.lang.Object
com.azure.core.http.HttpResponse
- All Implemented Interfaces:
Closeable
,AutoCloseable
The response of an
HttpRequest
.-
Constructor Summary
ModifierConstructorDescriptionprotected
HttpResponse
(HttpRequest request) Creates an instance ofHttpResponse
. -
Method Summary
Modifier and TypeMethodDescriptionbuffer()
Gets a newresponse
object wrapping this response with its content buffered into memory.void
close()
Closes the response content stream, if any.abstract Flux<ByteBuffer>
getBody()
Get the publisher emitting response content chunks.Gets theBinaryData
that represents the body of the response.abstract Mono<byte[]>
Gets the response content as abyte[]
.Gets the response content as anInputStream
.Gets the response content as aString
.getBodyAsString
(Charset charset) Gets the response content as aString
.abstract HttpHeaders
Get all response headers.getHeaderValue
(HttpHeaderName headerName) Lookup a response header with the providerHttpHeaderName
.abstract String
getHeaderValue
(String name) Lookup a response header with the provided name.final HttpRequest
Gets therequest
which resulted in this response.abstract int
Get the response status code.void
writeBodyTo
(WritableByteChannel channel) Transfers body bytes to theWritableByteChannel
.writeBodyToAsync
(AsynchronousByteChannel channel) Transfers body bytes to theAsynchronousByteChannel
.
-
Constructor Details
-
HttpResponse
Creates an instance ofHttpResponse
.- Parameters:
request
- TheHttpRequest
that resulted in thisHttpResponse
.
-
-
Method Details
-
getStatusCode
public abstract int getStatusCode()Get the response status code.- Returns:
- The response status code
-
getHeaderValue
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.
-
getHeaderValue
Lookup a response header with the providerHttpHeaderName
.- Parameters:
headerName
- the name of the header to lookup.- Returns:
- the value of the header, or null if the header doesn't exist in the response.
-
getHeaders
Get all response headers.- Returns:
- the response headers
-
getBody
Get the publisher emitting response content chunks.Returns a stream of the response's body content. Emissions may occur on Reactor threads which should not be blocked. Blocking should be avoided as much as possible/practical in reactive programming but if you do use methods like
block()
on the stream then be sure to usepublishOn
before the blocking call.- Returns:
- The response's content as a stream of
ByteBuffer
.
-
getBodyAsBinaryData
Gets theBinaryData
that represents the body of the response.Subclasses should override this method.
- Returns:
- The
BinaryData
response body.
-
getBodyAsByteArray
Gets the response content as abyte[]
.- Returns:
- The response content as a
byte[]
.
-
getBodyAsString
Gets the response content as aString
.By default, this method will inspect the response body for containing a byte order mark (BOM) to determine the encoding of the string (UTF-8, UTF-16, etc.). If a BOM isn't found this will default to using UTF-8 as the encoding, if a specific encoding is required use
getBodyAsString(Charset)
.- Returns:
- The response content as a
String
.
-
getBodyAsString
Gets the response content as aString
. -
getBodyAsInputStream
Gets the response content as anInputStream
.- Returns:
- The response content as an
InputStream
.
-
getRequest
Gets therequest
which resulted in this response.- Returns:
- The
request
which resulted in this response.
-
buffer
Gets a newresponse
object wrapping this response with its content buffered into memory.- Returns:
- A new
response
with the content buffered.
-
writeBodyToAsync
Transfers body bytes to theAsynchronousByteChannel
.- Parameters:
channel
- The destinationAsynchronousByteChannel
.- Returns:
- A
Mono
that completes when transfer is completed. - Throws:
NullPointerException
- Whenchannel
is null.
-
writeBodyTo
Transfers body bytes to theWritableByteChannel
.- Parameters:
channel
- The destinationWritableByteChannel
.- Throws:
IOException
- When I/O operation fails.NullPointerException
- Whenchannel
is null.
-
close
public void close()Closes the response content stream, if any.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-