Package org.apache.hc.client5.http.impl.classic

Class CloseableHttpResponse

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, org.apache.hc.core5.http.ClassicHttpResponse, org.apache.hc.core5.http.HttpEntityContainer, org.apache.hc.core5.http.HttpMessage, org.apache.hc.core5.http.HttpResponse, org.apache.hc.core5.http.MessageHeaders
    public final class CloseableHttpResponse
extends java.lang.Object
implements org.apache.hc.core5.http.ClassicHttpResponse
    Provided for backward compatibility with HttpClient 4.x.
    Since:
    4.3

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private ExecRuntime execRuntime  
      private org.apache.hc.core5.http.ClassicHttpResponse response  

    • Constructor Summary

      Constructors 
      Constructor Description
      CloseableHttpResponse​(org.apache.hc.core5.http.ClassicHttpResponse response, ExecRuntime execRuntime)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) static CloseableHttpResponse adapt​(org.apache.hc.core5.http.ClassicHttpResponse response)  
      void addHeader​(java.lang.String name, java.lang.Object value)  
      void addHeader​(org.apache.hc.core5.http.Header header)  
      void close()  
      boolean containsHeader​(java.lang.String name)  
      int countHeaders​(java.lang.String name)  
      int getCode()  
      org.apache.hc.core5.http.HttpEntity getEntity()  
      org.apache.hc.core5.http.Header getFirstHeader​(java.lang.String name)  
      org.apache.hc.core5.http.Header getHeader​(java.lang.String name)  
      org.apache.hc.core5.http.Header[] getHeaders()  
      org.apache.hc.core5.http.Header[] getHeaders​(java.lang.String name)  
      org.apache.hc.core5.http.Header getLastHeader​(java.lang.String name)  
      java.util.Locale getLocale()  
      java.lang.String getReasonPhrase()  
      org.apache.hc.core5.http.ProtocolVersion getVersion()  
      java.util.Iterator<org.apache.hc.core5.http.Header> headerIterator()  
      java.util.Iterator<org.apache.hc.core5.http.Header> headerIterator​(java.lang.String name)  
      boolean removeHeader​(org.apache.hc.core5.http.Header header)  
      boolean removeHeaders​(java.lang.String name)  
      void setCode​(int code)  
      void setEntity​(org.apache.hc.core5.http.HttpEntity entity)  
      void setHeader​(java.lang.String name, java.lang.Object value)  
      void setHeader​(org.apache.hc.core5.http.Header header)  
      void setHeaders​(org.apache.hc.core5.http.Header... headers)  
      void setLocale​(java.util.Locale loc)  
      void setReasonPhrase​(java.lang.String reason)  
      void setVersion​(org.apache.hc.core5.http.ProtocolVersion version)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • response

        private final org.apache.hc.core5.http.ClassicHttpResponse response

    • Constructor Detail

      • CloseableHttpResponse

        CloseableHttpResponse​(org.apache.hc.core5.http.ClassicHttpResponse response,
                      ExecRuntime execRuntime)

    • Method Detail

      • getCode

        public int getCode()
        Specified by:
        getCode in interface org.apache.hc.core5.http.HttpResponse

      • getEntity

        public org.apache.hc.core5.http.HttpEntity getEntity()
        Specified by:
        getEntity in interface org.apache.hc.core5.http.HttpEntityContainer

      • containsHeader

        public boolean containsHeader​(java.lang.String name)
        Specified by:
        containsHeader in interface org.apache.hc.core5.http.MessageHeaders

      • setVersion

        public void setVersion​(org.apache.hc.core5.http.ProtocolVersion version)
        Specified by:
        setVersion in interface org.apache.hc.core5.http.HttpMessage

      • setCode

        public void setCode​(int code)
        Specified by:
        setCode in interface org.apache.hc.core5.http.HttpResponse

      • getReasonPhrase

        public java.lang.String getReasonPhrase()
        Specified by:
        getReasonPhrase in interface org.apache.hc.core5.http.HttpResponse

      • countHeaders

        public int countHeaders​(java.lang.String name)
        Specified by:
        countHeaders in interface org.apache.hc.core5.http.MessageHeaders

      • setEntity

        public void setEntity​(org.apache.hc.core5.http.HttpEntity entity)
        Specified by:
        setEntity in interface org.apache.hc.core5.http.HttpEntityContainer

      • getVersion

        public org.apache.hc.core5.http.ProtocolVersion getVersion()
        Specified by:
        getVersion in interface org.apache.hc.core5.http.HttpMessage

      • setReasonPhrase

        public void setReasonPhrase​(java.lang.String reason)
        Specified by:
        setReasonPhrase in interface org.apache.hc.core5.http.HttpResponse

      • getHeaders

        public org.apache.hc.core5.http.Header[] getHeaders​(java.lang.String name)
        Specified by:
        getHeaders in interface org.apache.hc.core5.http.MessageHeaders

      • addHeader

        public void addHeader​(org.apache.hc.core5.http.Header header)
        Specified by:
        addHeader in interface org.apache.hc.core5.http.HttpMessage

      • getLocale

        public java.util.Locale getLocale()
        Specified by:
        getLocale in interface org.apache.hc.core5.http.HttpResponse

      • addHeader

        public void addHeader​(java.lang.String name,
                      java.lang.Object value)
        Specified by:
        addHeader in interface org.apache.hc.core5.http.HttpMessage

      • setLocale

        public void setLocale​(java.util.Locale loc)
        Specified by:
        setLocale in interface org.apache.hc.core5.http.HttpResponse

      • getHeader

        public org.apache.hc.core5.http.Header getHeader​(java.lang.String name)
                                          throws org.apache.hc.core5.http.ProtocolException
        Specified by:
        getHeader in interface org.apache.hc.core5.http.MessageHeaders
        Throws:
        org.apache.hc.core5.http.ProtocolException

      • setHeader

        public void setHeader​(org.apache.hc.core5.http.Header header)
        Specified by:
        setHeader in interface org.apache.hc.core5.http.HttpMessage

      • getFirstHeader

        public org.apache.hc.core5.http.Header getFirstHeader​(java.lang.String name)
        Specified by:
        getFirstHeader in interface org.apache.hc.core5.http.MessageHeaders

      • setHeader

        public void setHeader​(java.lang.String name,
                      java.lang.Object value)
        Specified by:
        setHeader in interface org.apache.hc.core5.http.HttpMessage

      • setHeaders

        public void setHeaders​(org.apache.hc.core5.http.Header... headers)
        Specified by:
        setHeaders in interface org.apache.hc.core5.http.HttpMessage

      • removeHeader

        public boolean removeHeader​(org.apache.hc.core5.http.Header header)
        Specified by:
        removeHeader in interface org.apache.hc.core5.http.HttpMessage

      • removeHeaders

        public boolean removeHeaders​(java.lang.String name)
        Specified by:
        removeHeaders in interface org.apache.hc.core5.http.HttpMessage

      • getLastHeader

        public org.apache.hc.core5.http.Header getLastHeader​(java.lang.String name)
        Specified by:
        getLastHeader in interface org.apache.hc.core5.http.MessageHeaders

      • getHeaders

        public org.apache.hc.core5.http.Header[] getHeaders()
        Specified by:
        getHeaders in interface org.apache.hc.core5.http.MessageHeaders

      • headerIterator

        public java.util.Iterator<org.apache.hc.core5.http.Header> headerIterator()
        Specified by:
        headerIterator in interface org.apache.hc.core5.http.MessageHeaders

      • headerIterator

        public java.util.Iterator<org.apache.hc.core5.http.Header> headerIterator​(java.lang.String name)
        Specified by:
        headerIterator in interface org.apache.hc.core5.http.MessageHeaders

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object