Package com.atlassian.confluence.util.http

Interface HttpResponse

All Known Implementing Classes:
HttpClientUnAuthorisedResponse
@Deprecated(forRemoval=true) public interface HttpResponse
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    finish()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getCharset()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the charset of the response.
    String
    getContentType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the type of the response content.
    String[]
    getHeaders(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieves all HTTP response headers with the specified name and returns an array of their values.
    String
    getMIMEType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the MIME type of the response.
    InputStream
    getResponse()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    URI
    getResponseURI()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the URI of the site that the response came from.
    int
    getStatusCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getStatusMessage()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isCached()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isFailed()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isNotFound()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isNotPermitted()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Details

    • isCached

      boolean isCached()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isFailed

      boolean isFailed()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isNotFound

      boolean isNotFound()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isNotPermitted

      boolean isNotPermitted()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getResponse

      InputStream getResponse() throws IOException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      IOException

    • getResponseURI

      URI getResponseURI()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the URI of the site that the response came from. The URI will be absolute if the host configuration has been set and relative otherwise.
      Returns:
      the URI of the response
      Since:
      5.1.5

    • getCharset

      String getCharset()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the charset of the response.
      Returns:
      the charset of the response, or null.
      Since:
      5.1.5

    • getMIMEType

      String getMIMEType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the MIME type of the response.
      Returns:
      the MIME type of the response.
      Since:
      5.1.5

    • getContentType

      String getContentType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the type of the response content.
      Returns:
      a string containing the MIME type and the charset of the response.
      See Also:

    • getHeaders

      String[] getHeaders(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves all HTTP response headers with the specified name and returns an array of their values.
      Parameters:
      name - the HTTP response header to retreive. Must not be null, or an IllegalArgumentException will be thrown.
      Returns:
      an array of the header values found on the response, or an empty array. Must not return null.
      Throws:
      IllegalArgumentException - if the name parameter is null
      Since:
      2.10

    • getStatusMessage

      String getStatusMessage()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getStatusCode

      int getStatusCode()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • finish

      void finish()
      Deprecated, for removal: This API element is subject to removal in a future version.