Constructor Detail

• public ResponseObject()

• public ResponseObject(String responseText)

Method Detail

• public ResponseObject clone()

  Creates and returns a copy of this ResponseObject with the following properties:

  • All primitive fields are copied by value
  • The responseText field is copied by reference (shallow copy)
  • The headerFields map is deep-copied with new HashMap
  • The responseBodyContent is copied by reference (shallow copy)

  Returns:

  A new ResponseObject instance with copied values

  Since:

  10.3.0

• public String extractSOAPBodyAsContent()

• @Override public HttpBodyContent getBodyContent()

• public String getContentCharset()

  Returns:

  Returns the Charset specified in the Content-Type of this response or the "UTF-8" charset as a default.

  Since:

  5.4

• public String getContentDisposition()

  Get the content disposition

  Returns:

  the content disposition

• @Override public long getContentDownloadTime()

• public String getContentType()

  Get the content type

  Returns:

  the content type

• @Override public long getElapsedTime()

• public String getHeaderField(String name)

• public Map<String, List<String>> getHeaderFields()

  Get the header fields as a Map

  Returns:

  the header fields as a Map

• public String getResponseBodyContent()

• public long getResponseBodySize()

• public long getResponseHeaderSize()

  Returns headers size (byte) as long value of the response.

  See Also:

  getResponseBodySize()

  getResponseSize()

• public long getResponseSize()

  Returns size (byte) as long value of the response.
  
  Response size = Header size + Body size

  See Also:

  getResponseHeaderSize()

  getResponseBodySize()

• public String getResponseText()

  Get the raw response text

  throws:

  IOException if content could not be parsed to String.

  Returns:

  the raw response text

• public int getStatusCode()

  Get the status code

  Returns:

  the status code

• @Override public long getWaitingTime()

• public boolean isJsonContentType()

  Check if the content type of this response is json

  Returns:

  true if the content type of this response is json, otherwise false

• public boolean isSOAPResponse()

  Check if this response is soap

  Returns:

  true if this response is soap, otherwise false

• public boolean isTextContentType()

  Check if the content type of this response is raw text

  Returns:

  true if the content type of this response is raw text, otherwise false

• public boolean isXmlContentType()

  Check if the content type of this response is xml

  Returns:

  true if the content type of this response is xml, otherwise false

• public void setBodyContent(HttpBodyContent bodyContent)

• public void setContentCharset(String contentCharset)

• public void setContentDisposition(String contentDisposition)

  Set the content disposition

  Parameters:

  contentDisposition - the new content disposition

• public void setContentDownloadTime(long contentDownloadTime)

• public void setContentType(String contentType)

  Set the content type

  Parameters:

  contentType - the new content type

• public void setHeaderFields(Map<String, List<String>> headerFields)

  Set the header fields

  Parameters:

  headerFields - the new header fields as a Map

• public void setResponseBodySize(long reponseBodySize)

  Returns body size (byte) as long value of the response.

  See Also:

  getResponseHeaderSize()

  getResponseSize()

• public void setResponseHeaderSize(long reponseHeaderSize)

• public void setResponseText(String responseText)

  Set the raw response text

  deprecated:

  from 5.4

  Parameters:

  responseText - the new raw response text

• public void setStatusCode(int statusCode)

  Set the status code

  Parameters:

  statusCode - the status code

• public void setWaitingTime(long waitingTime)

• @Override public String toString()

• public void writeResponseBodyToFile(String absoluteFilePath)

  Writes the response body content to a file at the specified path. If the file already exists, it will be overwritten.

  This method handles both text and binary content types automatically based on the content type of the response. For text content, the file will be written using the character encoding specified by getContentCharset(). For binary content, the file will be written as raw bytes.

  throws:

  IllegalStateException if the response body content is null

  throws:

  IllegalArgumentException if the file path is null or empty

  throws:

  IOException if the file already exists, if parent directories cannot be created, or if any I/O error occurs during writing

  throws:

  UnsupportedOperationException if the content type is neither text nor binary

  throws:

  Exception if any other error occurs during the operation

  Parameters:

  absoluteFilePath - the absolute path where the file should be created and written to

  Since:

  10.3.0