Class BasicHttpResponse

    • Constructor Detail

      • BasicHttpResponse

        public BasicHttpResponse​(StatusLine statusline,
                                 ReasonPhraseCatalog catalog,
                                 java.util.Locale locale)
        Creates a new response. This is the constructor to which all others map.
        Parameters:
        statusline - the status line
        catalog - the reason phrase catalog, or null to disable automatic reason phrase lookup
        locale - the locale for looking up reason phrases, or null for the system locale
      • BasicHttpResponse

        public BasicHttpResponse​(StatusLine statusline)
        Creates a response from a status line. The response will not have a reason phrase catalog and use the system default locale.
        Parameters:
        statusline - the status line
      • BasicHttpResponse

        public BasicHttpResponse​(ProtocolVersion ver,
                                 int code,
                                 java.lang.String reason)
        Creates a response from elements of a status line. The response will not have a reason phrase catalog and use the system default locale.
        Parameters:
        ver - the protocol version of the response
        code - the status code of the response
        reason - the reason phrase to the status code, or null
    • Method Detail

      • getStatusLine

        public StatusLine getStatusLine()
        Description copied from interface: HttpResponse
        Obtains the status line of this response. The status line can be set using one of the setStatusLine methods, or it can be initialized in a constructor.
        Specified by:
        getStatusLine in interface HttpResponse
        Returns:
        the status line, or null if not yet set
      • getEntity

        public HttpEntity getEntity()
        Description copied from interface: HttpResponse
        Obtains the message entity of this response, if any. The entity is provided by calling setEntity.
        Specified by:
        getEntity in interface HttpResponse
        Returns:
        the response entity, or null if there is none
      • 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
      • setStatusLine

        public void setStatusLine​(StatusLine statusline)
        Description copied from interface: HttpResponse
        Sets the status line of this response.
        Specified by:
        setStatusLine in interface HttpResponse
        Parameters:
        statusline - the status line of this response
      • setStatusLine

        public void setStatusLine​(ProtocolVersion ver,
                                  int code)
        Description copied from interface: HttpResponse
        Sets the status line of this response. The reason phrase will be determined based on the current locale.
        Specified by:
        setStatusLine in interface HttpResponse
        Parameters:
        ver - the HTTP version
        code - the status code
      • setStatusLine

        public void setStatusLine​(ProtocolVersion ver,
                                  int code,
                                  java.lang.String reason)
        Description copied from interface: HttpResponse
        Sets the status line of this response with a reason phrase.
        Specified by:
        setStatusLine in interface HttpResponse
        Parameters:
        ver - the HTTP version
        code - the status code
        reason - the reason phrase, or null to omit
      • setLocale

        public void setLocale​(java.util.Locale locale)
        Description copied from interface: HttpResponse
        Changes the locale of this response.
        Specified by:
        setLocale in interface HttpResponse
        Parameters:
        locale - the new locale
      • getReason

        protected java.lang.String getReason​(int code)
        Looks up a reason phrase. This method evaluates the currently set catalog and locale. It also handles a missing catalog.
        Parameters:
        code - the status code for which to look up the reason
        Returns:
        the reason phrase, or null if there is none
      • toString

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