com.dkfqs.tools.http

Class HTTPResponse

java.lang.Object

com.dkfqs.tools.http.HTTPResponse

public class HTTPResponse
extends java.lang.Object

A received HTTP response.

Method Summary

Modifier and Type	Method and Description
HTTPContentType	getContentType() Get all parts of the HTTP header field "Content-Type".
HTTPPerformanceData	getHttpPerformanceData() Get the performance data of the successful executed HTTP call.
HTTPRequest	getHttpRequest() Get the corresponding HTTP request.
HTTPResponseContent	getHttpResponseContent() Get the received HTTP response content.
HTTPResponseHeader	getHttpResponseHeader() Get the received HTTP response header.
int	getHttpStatusCode() Get the received HTTP status code.
java.lang.String	getReceivedHttpStatusText() Get the received HTTP status text.
java.lang.String	getRedirectUrl() Get the absolute URL of an HTTP redirect.
long	getTotalResponseSize() Get the total received response size.
boolean	isRedirect() Get if this HTTP response is an HTTP redirect.
JsonObject	toJsonObject() Get a JSON object of this instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHttpRequest

public HTTPRequest getHttpRequest()

Get the corresponding HTTP request.

Returns:

the corresponding HTTP request

getHttpResponseHeader

public HTTPResponseHeader getHttpResponseHeader()

Get the received HTTP response header.

Returns:

the received HTTP response header, or null if no such data is available

getHttpResponseContent

public HTTPResponseContent getHttpResponseContent()

Get the received HTTP response content.

Returns:

the received HTTP response content, or null if no such data is available

getTotalResponseSize

public long getTotalResponseSize()

Get the total received response size.

Returns:

the total received response size in bytes (HTTP response header + HTTP response content)

getHttpStatusCode

public int getHttpStatusCode()

Get the received HTTP status code.

Returns:

the received HTTP status code, or -1 if no such data is available

getReceivedHttpStatusText

public java.lang.String getReceivedHttpStatusText()

Get the received HTTP status text.

Returns:

the received HTTP status text (in uppercase), or an empty string if no such data is received from the server

getContentType

public HTTPContentType getContentType()

Get all parts of the HTTP header field "Content-Type".

Returns:

all parts of the HTTP header field "Content-Type"

getHttpPerformanceData

public HTTPPerformanceData getHttpPerformanceData()

Get the performance data of the successful executed HTTP call.

Returns:

the performance data of the successful executed HTTP call, or null if no such data are available

isRedirect

public boolean isRedirect()

Get if this HTTP response is an HTTP redirect.

Returns:

true if this HTTP response is an HTTP redirect

See Also:

getRedirectUrl()

getRedirectUrl

public java.lang.String getRedirectUrl()
                                throws java.net.URISyntaxException

Get the absolute URL of an HTTP redirect. Relative URLs are converted to absolute URLs.

Returns:

the absolute URL of the HTTP redirect, or null if there was no 'Location' HTTP response header field received

Throws:

java.net.URISyntaxException - if the base URL of the HTTP request is invalid

See Also:

isRedirect()

toJsonObject

public JsonObject toJsonObject()
                        throws HTTPContentTooLargeException,
                               HTTPContentTruncatedException,
                               java.io.IOException

Get a JSON object of this instance.

Returns:

a JSON object of this instance

Throws:

HTTPContentTooLargeException - if the received content is larger than 2^31-1 bytes

HTTPContentTruncatedException - if the stored HTTP response content was truncated (but was still fully read)

java.io.IOException - if the content was compressed and the decompression fails