io.devcon5.commons.rest

Class SimpleRestClient.Response

java.lang.Object

io.devcon5.commons.rest.SimpleRestClient.Response

Enclosing class:

SimpleRestClient

public static class SimpleRestClient.Response
extends Object

A Response handle around a HttpURLConnection

Method Summary

Modifier and Type	Method and Description
<T> Optional<T>	as(Class<T> targetType, int... validResponseCodes) Tries to parse the returned content into the specified target type.
byte[]	asBytes(int... validResponseCodes) Reads the response as byte array if the response represents is valid (by response code)
InputStream	asInputStream(int... validResponseCodes) Reads the response as InputStream if the response represents is valid (by response code)
String	asString(int... validResponseCodes) Reads the response as String if the response represents is valid (by response code)
String	getMessage() The HTTP repsonse message
int	getStatusCode() The http response code
boolean	hasValidResponseCode(int... validResponseCodes) Checks if the response code returned by the server is one of the valid response code provided.

Methods inherited from class java.lang.Object

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

Method Detail

getStatusCode

public int getStatusCode()

The http response code

Returns:

getMessage

public String getMessage()

The HTTP repsonse message

Returns:

hasValidResponseCode

public boolean hasValidResponseCode(int... validResponseCodes)
                             throws IOException

Checks if the response code returned by the server is one of the valid response code provided. If the actual code is not valid, an IllegalStateException is thrown.

Parameters:

validResponseCodes - list of valid response codes

Throws:

IOException

asInputStream

public InputStream asInputStream(int... validResponseCodes)

Reads the response as InputStream if the response represents is valid (by response code)

Parameters:

validResponseCodes - the response codes that denote the response as valid

Returns:

asString

public String asString(int... validResponseCodes)

Reads the response as String if the response represents is valid (by response code)

Parameters:

validResponseCodes - the response codes that denote the response as valid

Returns:

asBytes

public byte[] asBytes(int... validResponseCodes)

Reads the response as byte array if the response represents is valid (by response code)

Parameters:

validResponseCodes - the response codes that denote the response as valid

Returns:

as

public <T> Optional<T> as(Class<T> targetType,
                          int... validResponseCodes)

Tries to parse the returned content into the specified target type. In order to parse the data, an EntityReader must be provided via ServiceLoader that supports the received content-type and data.

Type Parameters:

T -

Parameters:

targetType - the target type to which the received data should be marshalled

Returns:

an optional instance of the target type. If no entity reader was found, the resulting optional is empty. The content could not be parsed by a provided Entity reader, an exception is thrown, depending on the used EntityReader