com.solidfire.core.client

Class ServiceBase

Object

ServiceBase

Direct Known Subclasses:

ElementServiceBase

public class ServiceBase
extends Object

The base class for SolidFire services.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceBase(RequestDispatcher requestDispatcher) Create a service with the given connection.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkForError(JsonObject resultObj)
protected <TResult> TResult	decodeResponse(String response, Class<TResult> resultParamsClass) Decodes the JSON-RPC response.
protected <TRequest> String	encodeRequest(String method, TRequest requestParams, Class<TRequest> requestParamsClass) Constructs the JSON-RPC request.
protected ApiServerException	extractApiError(JsonElement errorElem) Decodes the error portion, if it exists, from the JSON-RPC response.
protected GsonBuilder	getGsonBuilder() Getter for property 'gsonBuilder'.
RequestDispatcher	getRequestDispatcher() Get the communication mechanism of this service.
<TResult,TRequest> TResult	sendRequest(String method, TRequest requestParams, Class<TRequest> requestParamsClass, Class<TResult> resultParamsClass) Send the request to the remote system.

Methods inherited from class Object

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

Constructor Detail

ServiceBase

protected ServiceBase(RequestDispatcher requestDispatcher)

Create a service with the given connection.

Parameters:

requestDispatcher - is the mechanism for sending requests to some location.

Method Detail

getRequestDispatcher

public final RequestDispatcher getRequestDispatcher()

Get the communication mechanism of this service.

getGsonBuilder

protected final GsonBuilder getGsonBuilder()

Getter for property 'gsonBuilder'.

Returns:

Value for property 'gsonBuilder'.

sendRequest

public <TResult,TRequest> TResult sendRequest(String method,
                                     TRequest requestParams,
                                     Class<TRequest> requestParamsClass,
                                     Class<TResult> resultParamsClass)

Send the request to the remote system.

Parameters:

method - the api method name

requestParams - the object containing the request parameters

requestParamsClass - the class (type) of the request object

resultParamsClass - the class (type) of the results object

Returns:

the result (response) of the the API call

encodeRequest

protected <TRequest> String encodeRequest(String method,
                              TRequest requestParams,
                              Class<TRequest> requestParamsClass)

Constructs the JSON-RPC request.

Parameters:

method - the api method name

requestParams - the object containing the request parameters

requestParamsClass - the class (type) of the request object

Returns:

the request encoded in JSON-RPC format

decodeResponse

protected <TResult> TResult decodeResponse(String response,
                               Class<TResult> resultParamsClass)

Decodes the JSON-RPC response.

Parameters:

response - the JSON encoded response

resultParamsClass - the class (type) of the result object returned

Returns:

the result (response) object

checkForError

protected void checkForError(JsonObject resultObj)
                      throws ApiServerException

Throws:

ApiServerException

extractApiError

protected ApiServerException extractApiError(JsonElement errorElem)

Decodes the error portion, if it exists, from the JSON-RPC response.

Parameters:

errorElem - the JSON error object

Returns:

a ApiServerException with name, code and message