com.solidfire.core.client

Class ServiceBase

java.lang.Object

com.solidfire.core.client.ServiceBase

Direct Known Subclasses:

ElementServiceBase

public class ServiceBase
extends java.lang.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

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

Methods inherited from class java.lang.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 RequestDispatcher getRequestDispatcher()

Get the communication mechanism of this service.

getGsonBuilder

protected com.solidfire.gson.GsonBuilder getGsonBuilder()

Getter for property 'gsonBuilder'.

Returns:

Value for property 'gsonBuilder'.

sendRequest

public <TResult,TRequest> TResult sendRequest(java.lang.String method,
                                              TRequest requestParams,
                                              java.lang.Class<TRequest> requestParamsClass,
                                              java.lang.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> java.lang.String encodeRequest(java.lang.String method,
                                                    TRequest requestParams,
                                                    java.lang.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(java.lang.String response,
                                           java.lang.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(com.solidfire.gson.JsonObject resultObj)
                      throws ApiServerException

Throws:

ApiServerException

extractApiError

protected ApiServerException extractApiError(com.solidfire.gson.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