Module net.bis5.mattermost4j.core

Package net.bis5.mattermost.client4

Class ApiResponse<T>

java.lang.Object

net.bis5.mattermost.client4.ApiResponse<T>

public abstract class ApiResponse<T>
extends Object

API response.

Author:

Takayuki Maruyama

Field Summary

Fields

Modifier and Type	Field	Description
protected javax.ws.rs.core.Response	response
protected static String	STATUS
protected static String	STATUS_OK

Constructor Summary

Constructors

Constructor	Description
ApiResponse(javax.ws.rs.core.Response response)

Method Summary

Modifier and Type	Method	Description
protected ApiResponse<Boolean>	checkJsonStatusOk(javax.ws.rs.core.Response response)
protected ApiResponse<Boolean>	checkPlainStatusOk(javax.ws.rs.core.Response response)
ApiResponse<Boolean>	checkStatusOk()	a convenience function for checking the standard OK response from the web service.
String	getEtag()
javax.ws.rs.core.Response	getRawResponse()
boolean	hasError()	If remote api returns error response, this method also return false.
static <T> ApiResponse<T>	of(javax.ws.rs.core.Response response, Class<T> entityClass)
static <T> ApiResponse<T>	of(javax.ws.rs.core.Response response, javax.ws.rs.core.GenericType<T> genericType)
static <T> ApiResponse<T>	of(javax.ws.rs.core.Response response, T data)
abstract T	readEntity()
ApiError	readError()

Methods inherited from class java.lang.Object

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

Field Detail

response

protected final javax.ws.rs.core.Response response

STATUS

protected static final String STATUS

See Also:

Constant Field Values

STATUS_OK

protected static final String STATUS_OK

See Also:

Constant Field Values

Constructor Detail

ApiResponse

public ApiResponse(javax.ws.rs.core.Response response)

Method Detail

readEntity

public abstract T readEntity()

readError

public ApiError readError()

hasError

public boolean hasError()

If remote api returns error response, this method also return false.

getRawResponse

public javax.ws.rs.core.Response getRawResponse()

getEtag

public String getEtag()

checkStatusOk

public ApiResponse<Boolean> checkStatusOk()

a convenience function for checking the standard OK response from the web service.

Returns:

The api response contains true when status OK, otherwise false.

checkPlainStatusOk

protected ApiResponse<Boolean> checkPlainStatusOk(javax.ws.rs.core.Response response)

checkJsonStatusOk

protected ApiResponse<Boolean> checkJsonStatusOk(javax.ws.rs.core.Response response)

of

public static <T> ApiResponse<T> of(javax.ws.rs.core.Response response,
                                    Class<T> entityClass)

of

public static <T> ApiResponse<T> of(javax.ws.rs.core.Response response,
                                    javax.ws.rs.core.GenericType<T> genericType)

of

public static <T> ApiResponse<T> of(javax.ws.rs.core.Response response,
                                    T data)