org.miniclient

Interface ApiServiceClient

All Superinterfaces:

ApiClient, CrudMethodFilter, DataAccessClient, MethodFilter, ResourceClient, ResourceServiceClient, ServiceClient, WebClient

All Known Subinterfaces:

DecoratedApiServiceClient, DecoratedRestApiServiceClient, RestApiServiceClient

All Known Implementing Classes:

AbstractApiServiceClient, AbstractRestApiServiceClient, DefaultApiServiceClient, DefaultRestApiServiceClient

public interface ApiServiceClient
extends ResourceServiceClient, ApiClient, CrudMethodFilter

"High-level" API (compared to that of "REST Client"). This API uses CRUD verbs. (On the other hand, REST client uses HTTP method verbs.)

Method Summary

Methods

Modifier and Type	Method and Description
Object	create(UserCredential credential, Object inputData)
Object	create(UserCredential credential, Object inputData, String id)
int	delete(UserCredential credential, Map<String,Object> params)
boolean	delete(UserCredential credential, String id)
Object	get(UserCredential credential, String id)
List<String>	keys(UserCredential credential, Map<String,Object> params)
List<Object>	list(UserCredential credential, Map<String,Object> params)
Object	modify(UserCredential credential, Object partialData, String id) Partial update/PATCH support
Object	update(UserCredential credential, Object inputData, String id)

Methods inherited from interface org.miniclient.ResourceClient

getResourceBaseUrl

Methods inherited from interface org.miniclient.WebClient

getAuthRefreshPolicy, getAutoRedirectPolicy, getCacheControlPolicy, getClientCachePolicy, getRequestRetryPolicy

Methods inherited from interface org.miniclient.ServiceClient

getClientCredential

Methods inherited from interface org.miniclient.common.DataAccessClient

getRequiredScopes, isAccessAllowed, requiresScope

Methods inherited from interface org.miniclient.common.MethodFilter

isMethodSupported

Method Detail

get

Object get(UserCredential credential,
         String id)
           throws RestApiException,
                  IOException

Parameters:

credential -

id -

Returns:

Throws:

RestApiException - TODO

IOException - TODO

list

List<Object> list(UserCredential credential,
                Map<String,Object> params)
                  throws RestApiException,
                         IOException

Parameters:

credential -

params -

Returns:

Throws:

RestApiException - TODO

IOException - TODO

keys

List<String> keys(UserCredential credential,
                Map<String,Object> params)
                  throws RestApiException,
                         IOException

Parameters:

credential -

params -

Returns:

Throws:

RestApiException - TODO

IOException - TODO

create

Object create(UserCredential credential,
            Object inputData)
              throws RestApiException,
                     IOException

Parameters:

credential -

inputData -

Returns:

Throws:

RestApiException - TODO

IOException - TODO

create

Object create(UserCredential credential,
            Object inputData,
            String id)
              throws RestApiException,
                     IOException

Parameters:

credential -

inputData -

id -

Returns:

Throws:

RestApiException - TODO

IOException - TODO

update

Object update(UserCredential credential,
            Object inputData,
            String id)
              throws RestApiException,
                     IOException

Parameters:

credential -

inputData -

id -

Returns:

Throws:

RestApiException - TODO

IOException - TODO

modify

Object modify(UserCredential credential,
            Object partialData,
            String id)
              throws RestApiException,
                     IOException

Partial update/PATCH support

Parameters:

credential -

partialData -

id -

Returns:

Throws:

RestApiException

IOException

delete

boolean delete(UserCredential credential,
             String id)
               throws RestApiException,
                      IOException

Parameters:

credential -

id -

Returns:

Throws:

RestApiException - TODO

IOException - TODO

delete

int delete(UserCredential credential,
         Map<String,Object> params)
           throws RestApiException,
                  IOException

Parameters:

credential -

params -

Returns:

Throws:

RestApiException - TODO

IOException - TODO