Top Description Fields Constructors Methods
org.springframework.http.client

pack-priv final Class HttpComponentsClientHttpResponse

extends Object
implements ClientHttpResponse
Class Inheritance
All Implemented Interfaces
org.springframework.http.client.ClientHttpResponse, java.io.Closeable, java.lang.AutoCloseable, org.springframework.http.HttpInputMessage, org.springframework.http.HttpMessage
Imports
java.io.IOException, .InputStream, org.apache.hc.core5.http.ClassicHttpResponse, .HttpEntity, org.apache.hc.core5.http.io.entity.EntityUtils, org.springframework.http.HttpHeaders, .HttpStatusCode, org.springframework.http.support.HttpComponentsHeadersAdapter, org.springframework.lang.Nullable, org.springframework.util.MultiValueMap
ClientHttpResponse implementation based on Apache HttpComponents HttpClient.

Created via the HttpComponentsClientHttpRequest.

Authors
Oleg Kalnichevski, Arjen Poutsma
Since
3.1
See Also
HttpComponentsClientHttpRequest#execute()

Field Summary

Modifier and TypeField and Description
private HttpHeaders
headers

private final ClassicHttpResponse
httpResponse

Constructor Summary

AccessConstructor and Description
pack-priv
HttpComponentsClientHttpResponse(ClassicHttpResponse httpResponse)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements org.springframework.http.client.ClientHttpResponse.close.

Close this response, freeing any resources created.

public InputStream
getBody()

Implements org.springframework.http.HttpInputMessage.getBody.

Return the body of the message as an input stream.

public HttpHeaders
getHeaders()

Implements org.springframework.http.HttpMessage.getHeaders.

Return the headers of this message.

public HttpStatusCode
getStatusCode()

Implements org.springframework.http.client.ClientHttpResponse.getStatusCode.

Get the HTTP status code as an HttpStatusCode.

public String
getStatusText()

Implements org.springframework.http.client.ClientHttpResponse.getStatusText.

Get the HTTP status text of the response.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

headersback to summary
private HttpHeaders headers
Annotations
@Nullable
httpResponseback to summary
private final ClassicHttpResponse httpResponse

Constructor Detail

HttpComponentsClientHttpResponseback to summary
pack-priv HttpComponentsClientHttpResponse(ClassicHttpResponse httpResponse)

Method Detail

closeback to summary
public void close()

Implements org.springframework.http.client.ClientHttpResponse.close.

Doc from org.springframework.http.client.ClientHttpResponse.close.

Close this response, freeing any resources created.

Annotations
@Override
getBodyback to summary
public InputStream getBody() throws IOException

Implements org.springframework.http.HttpInputMessage.getBody.

Doc from org.springframework.http.HttpInputMessage.getBody.

Return the body of the message as an input stream.

Returns:InputStream

the input stream body (never null)

Annotations
@Override
Exceptions
IOException:
in case of I/O errors
getHeadersback to summary
public HttpHeaders getHeaders()

Implements org.springframework.http.HttpMessage.getHeaders.

Doc from org.springframework.http.HttpMessage.getHeaders.

Return the headers of this message.

Returns:HttpHeaders

a corresponding HttpHeaders object (never null)

Annotations
@Override
getStatusCodeback to summary
public HttpStatusCode getStatusCode()

Implements org.springframework.http.client.ClientHttpResponse.getStatusCode.

Doc from org.springframework.http.client.ClientHttpResponse.getStatusCode.

Get the HTTP status code as an HttpStatusCode.

Returns:HttpStatusCode

the HTTP status as HttpStatusCode value (never null)

Annotations
@Override
getStatusTextback to summary
public String getStatusText()

Implements org.springframework.http.client.ClientHttpResponse.getStatusText.

Doc from org.springframework.http.client.ClientHttpResponse.getStatusText.

Get the HTTP status text of the response.

Returns:String

the HTTP status text

Annotations
@Override