com.jsunsoft.http

Interface Response

All Superinterfaces:

AutoCloseable, Closeable, org.apache.http.client.methods.CloseableHttpResponse, org.apache.http.HttpMessage, org.apache.http.HttpResponse

public interface Response
extends org.apache.http.client.methods.CloseableHttpResponse

Method Summary

Modifier and Type	Method and Description
default org.apache.http.entity.ContentType	getContentType()
default int	getStatusCode()
URI	getURI()
default boolean	hasEntity()
default boolean	isNonSuccess()
default boolean	isSuccess()
<T> T	readEntity(Class<T> responseType) Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.
<T> T	readEntity(TypeReference<T> responseType) Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.
<T> T	readEntityChecked(Class<T> responseType) Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.
<T> T	readEntityChecked(TypeReference<T> responseType) Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.

Methods inherited from interface org.apache.http.HttpResponse

getEntity, getLocale, getStatusLine, setEntity, setLocale, setReasonPhrase, setStatusCode, setStatusLine, setStatusLine, setStatusLine

Methods inherited from interface org.apache.http.HttpMessage

addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, getProtocolVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Methods inherited from interface java.io.Closeable

close

Method Detail

readEntity

<T> T readEntity(Class<T> responseType)

Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.

Note: method will throw any unchecked exception which will occurred in specified ResponseBodyReader.

Type Parameters:

T - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

Response entity

Throws:

ResponseBodyProcessingException - when body processing failed.

readEntity

<T> T readEntity(TypeReference<T> responseType)

Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.

Note: method will throw any unchecked exception which will occurred in specified ResponseBodyReader.

Type Parameters:

T - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

Response entity

Throws:

ResponseBodyProcessingException - when body processing failed.

readEntityChecked

@Beta
<T> T readEntityChecked(Class<T> responseType)
                       throws IOException

Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.

Note: method will throw any unchecked exception which will occurred in specified ResponseBodyReader.

Type Parameters:

T - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

Response entity

Throws:

IOException - If the stream could not be created or error occurs reading the input stream.

ResponseBodyReaderException - If Cannot deserialize content

readEntityChecked

@Beta
<T> T readEntityChecked(TypeReference<T> responseType)
                       throws IOException

Read the entity input stream as an instance of specified Java type using a ResponseBodyReader.

Note: method will throw any unchecked exception which will occurred in specified ResponseBodyReader.

Type Parameters:

T - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

Response entity

Throws:

IOException - If the stream could not be created or error occurs reading the input stream.

ResponseBodyReaderException - If Cannot deserialize content

getURI

URI getURI()

Returns:

the request URI

hasEntity

default boolean hasEntity()

getContentType

default org.apache.http.entity.ContentType getContentType()

Returns:

Content type of response

getStatusCode

default int getStatusCode()

Returns:

Status code

isSuccess

default boolean isSuccess()

Returns:

Returns true if status code contains [200, 300) else false

isNonSuccess

default boolean isNonSuccess()

Returns:

Returns true if status code isn't contains [200, 300) else false