org.springframework.web.client

Class MessageBodyClientHttpResponseWrapper

java.lang.Object

org.springframework.web.client.MessageBodyClientHttpResponseWrapper

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ClientHttpResponse, HttpInputMessage, HttpMessage

class MessageBodyClientHttpResponseWrapper
extends java.lang.Object
implements ClientHttpResponse

Implementation of ClientHttpResponse that can not only check if the response has a message body, but also if its length is 0 (i.e. empty) by actually reading the input stream.

Since:

4.1.5

Author:

Brian Clozel

See Also:

rfc7230 Section 3.3.3

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.PushbackInputStream	pushbackInputStream
private ClientHttpResponse	response

Constructor Summary

Constructors

Constructor and Description
MessageBodyClientHttpResponseWrapper(ClientHttpResponse response)

Method Summary

Modifier and Type	Method and Description
void	close() Close this response, freeing any resources created.
java.io.InputStream	getBody() Return the body of the message as an input stream.
HttpHeaders	getHeaders() Return the headers of this message.
int	getRawStatusCode() Return the HTTP status code of the response as integer
HttpStatus	getStatusCode() Return the HTTP status code of the response.
java.lang.String	getStatusText() Return the HTTP status text of the response.
boolean	hasEmptyMessageBody() Indicates whether the response has an empty message body.
boolean	hasMessageBody() Indicates whether the response has a message body.

Methods inherited from class java.lang.Object

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

Field Detail

response

private final ClientHttpResponse response

pushbackInputStream

private java.io.PushbackInputStream pushbackInputStream

Constructor Detail

MessageBodyClientHttpResponseWrapper

public MessageBodyClientHttpResponseWrapper(ClientHttpResponse response)
                                     throws java.io.IOException

Throws:

java.io.IOException

Method Detail

hasMessageBody

public boolean hasMessageBody()
                       throws java.io.IOException

Indicates whether the response has a message body.

Implementation returns false for:

• a response status of 1XX, 204 or 304
• a Content-Length header of 0

Returns:

true if the response has a message body, false otherwise

Throws:

java.io.IOException - in case of I/O errors

hasEmptyMessageBody

public boolean hasEmptyMessageBody()
                            throws java.io.IOException

Indicates whether the response has an empty message body.

Implementation tries to read the first bytes of the response stream:

• if no bytes are available, the message body is empty
• otherwise it is not empty and the stream is reset to its start for further reading

Returns:

true if the response has a zero-length message body, false otherwise

Throws:

java.io.IOException - in case of I/O errors

getHeaders

public HttpHeaders getHeaders()

Description copied from interface: HttpMessage

Return the headers of this message.

Specified by:

getHeaders in interface HttpMessage

Returns:

a corresponding HttpHeaders object (never null)

getBody

public java.io.InputStream getBody()
                            throws java.io.IOException

Description copied from interface: HttpInputMessage

Return the body of the message as an input stream.

Specified by:

getBody in interface HttpInputMessage

Returns:

the input stream body (never null)

Throws:

java.io.IOException - in case of I/O Errors

getStatusCode

public HttpStatus getStatusCode()
                         throws java.io.IOException

Description copied from interface: ClientHttpResponse

Return the HTTP status code of the response.

Specified by:

getStatusCode in interface ClientHttpResponse

Returns:

the HTTP status as an HttpStatus enum value

Throws:

java.io.IOException - in case of I/O errors

getRawStatusCode

public int getRawStatusCode()
                     throws java.io.IOException

Description copied from interface: ClientHttpResponse

Return the HTTP status code of the response as integer

Specified by:

getRawStatusCode in interface ClientHttpResponse

Returns:

the HTTP status as an integer

Throws:

java.io.IOException - in case of I/O errors

getStatusText

public java.lang.String getStatusText()
                               throws java.io.IOException

Description copied from interface: ClientHttpResponse

Return the HTTP status text of the response.

Specified by:

getStatusText in interface ClientHttpResponse

Returns:

the HTTP status text

Throws:

java.io.IOException - in case of I/O errors

close

public void close()

Description copied from interface: ClientHttpResponse

Close this response, freeing any resources created.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ClientHttpResponse