CloseableHttpResponse

java.lang.Object
- org.apache.hc.client5.http.impl.classic.CloseableHttpResponse

All Implemented Interfaces:

Closeable, AutoCloseable, ClassicHttpResponse, HttpEntityContainer, HttpMessage, HttpResponse, MessageHeaders
```
public final class CloseableHttpResponse
extends Object
implements ClassicHttpResponse
```
Provided for backward compatibility with HttpClient 4.x.

Since:

4.3

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(Header header)` Adds a header to this message.
`void`	`addHeader(String name, Object value)` Adds a header to this message.
`void`	`close()` Closes this stream and releases any system resources associated with it.
`boolean`	`containsHeader(String name)` Checks if a certain header is present in this message.
`int`	`countHeaders(String name)` Checks if a certain header is present in this message and how many times.
`int`	`getCode()` Obtains the code of this response message.
`HttpEntity`	`getEntity()` Obtains the message entity, if available.
`Header`	`getFirstHeader(String name)` Returns the first header with a specified name of this message.
`Header`	`getHeader(String name)` Gets single first header with the given name.
`Header[]`	`getHeaders()` Returns all the headers of this message.
`Header[]`	`getHeaders(String name)` Returns all the headers with a specified name of this message.
`Header`	`getLastHeader(String name)` Returns the last header with a specified name of this message.
`java.util.Locale`	`getLocale()` Obtains the locale of this response.
`String`	`getReasonPhrase()` Obtains the reason phrase of this response if available.
`ProtocolVersion`	`getVersion()` Returns protocol version or `null` when not available.
`Iterator<Header>`	`headerIterator()` Returns an iterator of all the headers.
`Iterator<Header>`	`headerIterator(String name)` Returns an iterator of the headers with a given name.
`boolean`	`removeHeader(Header header)` Removes a header from this message.
`boolean`	`removeHeaders(String name)` Removes all headers with a certain name from this message.
`void`	`setCode(int code)` Updates status code of this response message.
`void`	`setEntity(HttpEntity entity)` Sets an entity for this message.
`void`	`setHeader(Header header)` Overwrites the first header with the same name.
`void`	`setHeader(String name, Object value)` Overwrites the first header with the same name.
`void`	`setHeaders(Header... headers)` Overwrites all the headers in the message.
`void`	`setLocale(java.util.Locale loc)` Changes the locale of this response.
`void`	`setReasonPhrase(String reason)` Updates the status line of this response with a new reason phrase.
`void`	`setVersion(ProtocolVersion version)` Sets protocol version.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - addHeader
```
public void addHeader(Header header)
```
    Description copied from interface: HttpMessage
    
    Adds a header to this message. The header will be appended to the end of the list.
    
    Specified by:
    
    addHeader in interface HttpMessage
    
    Parameters:
    
    header - the header to append.
  - addHeader
```
public void addHeader(String name,
                      Object value)
```
    Description copied from interface: HttpMessage
    
    Adds a header to this message. The header will be appended to the end of the list.
    
    Specified by:
    
    addHeader in interface HttpMessage
    
    Parameters:
    
    name - the name of the header.
    
    value - the value of the header, taken as the value's Object.toString().
  - close
```
public void close()
           throws IOException
```
    Description copied from interface: Closeable
    
    Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - if an I/O error occurs
  - containsHeader
```
public boolean containsHeader(String name)
```
    Description copied from interface: MessageHeaders
    
    Checks if a certain header is present in this message. Header values are ignored.
    
    Specified by:
    
    containsHeader in interface MessageHeaders
    
    Parameters:
    
    name - the header name to check for.
    
    Returns:
    
    true if at least one header with this name is present.
  - countHeaders
```
public int countHeaders(String name)
```
    Description copied from interface: MessageHeaders
    
    Checks if a certain header is present in this message and how many times.
    
    Specified by:
    
    countHeaders in interface MessageHeaders
    
    Parameters:
    
    name - the header name to check for.
    
    Returns:
    
    number of occurrences of the header in the message.
  - getCode
```
public int getCode()
```
    Description copied from interface: HttpResponse
    
    Obtains the code of this response message.
    
    Specified by:
    
    getCode in interface HttpResponse
    
    Returns:
    
    the status code.
  - getEntity
```
public HttpEntity getEntity()
```
    Description copied from interface: HttpEntityContainer
    
    Obtains the message entity, if available.
    
    Specified by:
    
    getEntity in interface HttpEntityContainer
    
    Returns:
    
    the message entity, or null if not available
  - getFirstHeader
```
public Header getFirstHeader(String name)
```
    Description copied from interface: MessageHeaders
    
    Returns the first header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the first element of MessageHeaders.getHeaders(String) is returned. If there is no matching header in the message null is returned.
    
    Specified by:
    
    getFirstHeader in interface MessageHeaders
    
    Parameters:
    
    name - the name of the header to return.
    
    Returns:
    
    the first header whose name property equals name or null if no such header could be found.
  - getHeader
```
public Header getHeader(String name)
                 throws ProtocolException
```
    Description copied from interface: MessageHeaders
    
    Gets single first header with the given name.
    Header name comparison is case insensitive.
    
    Specified by:
    
    getHeader in interface MessageHeaders
    
    Parameters:
    
    name - the name of the header to get
    
    Returns:
    
    the first header or null
    
    Throws:
    
    ProtocolException - in case multiple headers with the given name are found.
  - getHeaders
```
public Header[] getHeaders()
```
    Description copied from interface: MessageHeaders
    
    Returns all the headers of this message. Headers are orderd in the sequence they will be sent over a connection.
    
    Specified by:
    
    getHeaders in interface MessageHeaders
    
    Returns:
    
    all the headers of this message
  - getHeaders
```
public Header[] getHeaders(String name)
```
    Description copied from interface: MessageHeaders
    
    Returns all the headers with a specified name of this message. Header values are ignored. Headers are orderd in the sequence they will be sent over a connection.
    
    Specified by:
    
    getHeaders in interface MessageHeaders
    
    Parameters:
    
    name - the name of the headers to return.
    
    Returns:
    
    the headers whose name property equals name.
  - getLastHeader
```
public Header getLastHeader(String name)
```
    Description copied from interface: MessageHeaders
    
    Returns the last header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the last element of MessageHeaders.getHeaders(String) is returned. If there is no matching header in the message null is returned.
    
    Specified by:
    
    getLastHeader in interface MessageHeaders
    
    Parameters:
    
    name - the name of the header to return.
    
    Returns:
    
    the last header whose name property equals name. or null if no such header could be found.
  - getLocale
```
public java.util.Locale getLocale()
```
    Description copied from interface: HttpResponse
    
    Obtains the locale of this response. The locale is used to determine the reason phrase for the status code. It can be changed using setLocale.
    
    Specified by:
    
    getLocale in interface HttpResponse
    
    Returns:
    
    the locale of this response, never null
  - getReasonPhrase
```
public String getReasonPhrase()
```
    Description copied from interface: HttpResponse
    
    Obtains the reason phrase of this response if available.
    
    Specified by:
    
    getReasonPhrase in interface HttpResponse
    
    Returns:
    
    the reason phrase.
  - getVersion
```
public ProtocolVersion getVersion()
```
    Description copied from interface: HttpMessage
    
    Returns protocol version or null when not available.
    For incoming messages it represents protocol version this message was transmitted with. For outgoing messages it represents a hint what protocol version should be used to transmit the message.
    
    Specified by:
    
    getVersion in interface HttpMessage
  - headerIterator
```
public Iterator<Header> headerIterator()
```
    Description copied from interface: MessageHeaders
    
    Returns an iterator of all the headers.
    
    Specified by:
    
    headerIterator in interface MessageHeaders
    
    Returns:
    
    Iterator that returns Header objects in the sequence they are sent over a connection.
  - headerIterator
```
public Iterator<Header> headerIterator(String name)
```
    Description copied from interface: MessageHeaders
    
    Returns an iterator of the headers with a given name.
    
    Specified by:
    
    headerIterator in interface MessageHeaders
    
    Parameters:
    
    name - the name of the headers over which to iterate, or null for all headers
    
    Returns:
    
    Iterator that returns Header objects with the argument name in the sequence they are sent over a connection.
  - removeHeader
```
public boolean removeHeader(Header header)
```
    Description copied from interface: HttpMessage
    
    Removes a header from this message.
    
    Specified by:
    
    removeHeader in interface HttpMessage
    
    Parameters:
    
    header - the header to remove.
    
    Returns:
    
    true if a header was removed as a result of this call.
  - removeHeaders
```
public boolean removeHeaders(String name)
```
    Description copied from interface: HttpMessage
    
    Removes all headers with a certain name from this message.
    
    Specified by:
    
    removeHeaders in interface HttpMessage
    
    Parameters:
    
    name - The name of the headers to remove.
    
    Returns:
    
    true if any header was removed as a result of this call.
  - setCode
```
public void setCode(int code)
```
    Description copied from interface: HttpResponse
    
    Updates status code of this response message.
    
    Specified by:
    
    setCode in interface HttpResponse
    
    Parameters:
    
    code - the HTTP status code.
    
    See Also:
    
    HttpStatus
  - setEntity
```
public void setEntity(HttpEntity entity)
```
    Description copied from interface: HttpEntityContainer
    
    Sets an entity for this message.
    Please note that if an entity has already been set it is responsibility of the caller to ensure release of the resources that may be associated with that entity.
    
    Specified by:
    
    setEntity in interface HttpEntityContainer
    
    Parameters:
    
    entity - the entity to set of this message, or null to unset
  - setHeader
```
public void setHeader(Header header)
```
    Description copied from interface: HttpMessage
    
    Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.
    
    Specified by:
    
    setHeader in interface HttpMessage
    
    Parameters:
    
    header - the header to set.
  - setHeader
```
public void setHeader(String name,
                      Object value)
```
    Description copied from interface: HttpMessage
    
    Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.
    
    Specified by:
    
    setHeader in interface HttpMessage
    
    Parameters:
    
    name - the name of the header.
    
    value - the value of the header, taken as the value's Object.toString().
  - setHeaders
```
public void setHeaders(Header... headers)
```
    Description copied from interface: HttpMessage
    
    Overwrites all the headers in the message.
    
    Specified by:
    
    setHeaders in interface HttpMessage
    
    Parameters:
    
    headers - the array of headers to set.
  - setLocale
```
public void setLocale(java.util.Locale loc)
```
    Description copied from interface: HttpResponse
    
    Changes the locale of this response.
    
    Specified by:
    
    setLocale in interface HttpResponse
    
    Parameters:
    
    loc - the new locale
  - setReasonPhrase
```
public void setReasonPhrase(String reason)
```
    Description copied from interface: HttpResponse
    
    Updates the status line of this response with a new reason phrase.
    
    Specified by:
    
    setReasonPhrase in interface HttpResponse
    
    Parameters:
    
    reason - the new reason phrase as a single-line string, or null to unset the reason phrase
  - setVersion
```
public void setVersion(ProtocolVersion version)
```
    Description copied from interface: HttpMessage
    
    Sets protocol version.
    For incoming messages it represents protocol version this message was transmitted with. For outgoing messages it represents a hint what protocol version should be used to transmit the message.
    
    Specified by:
    
    setVersion in interface HttpMessage
  - toString
```
public String toString()
```
    Description copied from class: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class CloseableHttpResponse

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addHeader

addHeader

close

containsHeader

countHeaders

getCode

getEntity

getFirstHeader

getHeader

getHeaders

getHeaders

getLastHeader

getLocale

getReasonPhrase

getVersion

headerIterator

headerIterator

removeHeader

removeHeaders

setCode

setEntity

setHeader

setHeader

setHeaders

setLocale

setReasonPhrase

setVersion

toString