org.miniclient

Interface ApiUserClient

All Superinterfaces:

ApiClient, CrudMethodFilter, MethodFilter, ResourceClient, ResourceUserClient, UserClient, WebClient

All Known Subinterfaces:

DecoratedApiUserClient, DecoratedRestApiUserClient, RestApiUserClient

All Known Implementing Classes:

AbstractApiUserClient, AbstractRestApiUserClient, DefaultApiUserClient, DefaultRestApiUserClient

public interface ApiUserClient
extends ResourceUserClient, ApiClient, CrudMethodFilter

API Client. User-specific. (That is, these instances are not shared among different users.)

Method Summary

Methods

Modifier and Type	Method and Description
Object	create(Object inputData) Creates a new instance of the given resource, as defined by the inputData.
Object	create(Object inputData, String id) Creates a new instance of the given resource, as defined by the inputData and id.
int	delete(Map<String,Object> params) Deletes the resource instances specified by the params.
boolean	delete(String id) Deletes the resource instance specified by id.
Object	get(String id) Returns the resource specified by the id.
List<String>	keys(Map<String,Object> params) Returns the list of keys of the resources filtered by the params.
List<Object>	list(Map<String,Object> params) Returns the list of objects/resources specified by the params.
Object	modify(Object partialtData, String id) Note: Partial update/PATCH support...
Object	update(Object inputData, String id) Updates the resource instance, as defined by the inputData and 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.UserClient

getUserCredential

Methods inherited from interface org.miniclient.common.MethodFilter

isMethodSupported

Method Detail

get

Object get(String id)
           throws RestApiException,
                  IOException

Returns the resource specified by the id.

Parameters:

id - Unique id of the resource.

Returns:

The resource/object.

Throws:

RestApiException

IOException

list

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

Returns the list of objects/resources specified by the params.

Parameters:

params - Selection filter.

Returns:

The list of resource instances.

Throws:

RestApiException

IOException

keys

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

Returns the list of keys of the resources filtered by the params.

Parameters:

params - Selection filter.

Returns:

The list of keys/ids of the resources selected by the params.

Throws:

RestApiException

IOException

create

Object create(Object inputData)
              throws RestApiException,
                     IOException

Creates a new instance of the given resource, as defined by the inputData.

Parameters:

inputData - A representation of the resource instance to be created.

Returns:

The newly created resource object.

Throws:

RestApiException

IOException

create

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

Creates a new instance of the given resource, as defined by the inputData and id.

Parameters:

inputData - A representation of the resource instance to be created.

id - The unique resource id.

Returns:

The newly created resource object.

Throws:

RestApiException

IOException

update

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

Updates the resource instance, as defined by the inputData and id.

Parameters:

inputData - A new resource instance.

id - The resource id.

Returns:

The updated resource object.

Throws:

RestApiException

IOException

modify

Object modify(Object partialtData,
            String id)
              throws RestApiException,
                     IOException

Note: Partial update/PATCH support... Not all Web services support PATCH. (Not fully implemented yet....) Updates the resource instance, as defined by the partialtData and id.

Parameters:

partialtData - A "partial" representation of the new resource instance.

id - The resource id.

Returns:

The modified resource object. (TBD: Are we returning the partial object? Or, the full object?)

Throws:

RestApiException

IOException

delete

boolean delete(String id)
               throws RestApiException,
                      IOException

Deletes the resource instance specified by id.

Parameters:

id - The resource id.

Returns:

true if the operation is successful.

Throws:

RestApiException

IOException

delete

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

Deletes the resource instances specified by the params. (Not fully implemented yet....)

Parameters:

params -

Returns:

The number of resource objects successfully deleted. (TBD: Is it possible to do that in general? Just return boolean?)

Throws:

RestApiException

IOException