org.miniclient

Interface RestUserClient

All Superinterfaces:

HttpMethodFilter, MethodFilter, ResourceClient, ResourceUserClient, RestClient, UserClient, WebClient

All Known Subinterfaces:

DecoratedRestApiUserClient, DecoratedRestUserClient, RestApiUserClient

All Known Implementing Classes:

AbstractRestApiUserClient, AbstractRestUserClient, DefaultRestApiUserClient, DefaultRestUserClient

public interface RestUserClient
extends ResourceUserClient, RestClient, HttpMethodFilter

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

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	delete(String id, Map<String,Object> params) Both id and params cannot be null.
Map<String,Object>	get(String id, Map<String,Object> params) Both id and params cannot be null.
Map<String,Object>	patch(Object partialData, String id)
Map<String,Object>	post(Object inputData) Returns the new resource created by the given input.
Map<String,Object>	put(Object inputData, String id) Returns the resource created/updated by the given input.

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

Map<String,Object> get(String id,
                     Map<String,Object> params)
                       throws IOException

Both id and params cannot be null. It supports two use cases: (1) If id is specified, then it returns the resource specified by id. Params should not normally be used in this case. (2) If id is not specified, then params is required. It returns the collection of resources specified by the params. If neither id nor params is specified, then it's an error.

Parameters:

id - Resource id.

params - URL query parameters to select a collection.

Returns:

Returns a single resource or a collection.

Throws:

IOException - TODO

post

Map<String,Object> post(Object inputData)
                        throws IOException

Returns the new resource created by the given input. The inputData should be a complete representation of the resource.

Parameters:

inputData - The object to be created.

Returns:

The new resource.

Throws:

IOException - TODO

put

Map<String,Object> put(Object inputData,
                     String id)
                       throws IOException

Returns the resource created/updated by the given input. If the resource exists for the given id, the resource is updated. Otherwise, a new resource is created.

Parameters:

inputData - The new resource.

id - Resource id.

Returns:

The new created/updated resource.

Throws:

IOException - TODO

patch

Map<String,Object> patch(Object partialData,
                       String id)
                         throws IOException

Throws:

IOException

delete

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

Both id and params cannot be null. It supports two use cases: (1) If id is specified, then it deletes the resource specified by id. Params should not normally be used in this case. (2) If id is not specified, then params is required. It deletes the collection of all resources specified by the params. If neither id nor params is specified, then it's an error.

Parameters:

id - Resource id.

params - URL query parameters to select a collection.

Returns:

boolean variable to indicate the success/failure.

Throws:

IOException - TODO