org.miniclient.impl

Class AbstractRestApiUserClient

java.lang.Object

org.miniclient.impl.AbstractRestApiUserClient

All Implemented Interfaces:

ApiClient, ApiUserClient, CrudMethodFilter, HttpMethodFilter, MethodFilter, FlexibleResourceClient, FlexibleUserClient, FlexibleWebClient, ResourceClient, ResourceUserClient, RestApiUserClient, RestClient, RestUserClient, UserClient, WebClient

Direct Known Subclasses:

DefaultRestApiUserClient

public abstract class AbstractRestApiUserClient
extends Object
implements RestApiUserClient, FlexibleResourceClient, FlexibleUserClient

Constructor Summary

Constructors

Constructor and Description
AbstractRestApiUserClient(RestApiServiceClient restApiServiceClient)
AbstractRestApiUserClient(RestApiServiceClient restApiServiceClient, UserCredential authCredential)

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.
Map<String,Object>	delete(String id, Map<String,Object> params) Both id and params cannot be null.
Object	get(String id) Returns the resource specified by the id.
Map<String,Object>	get(String id, Map<String,Object> params) Both id and params cannot be null.
AuthRefreshPolicy	getAuthRefreshPolicy()
AutoRedirectPolicy	getAutoRedirectPolicy()
CacheControlPolicy	getCacheControlPolicy()
ClientCachePolicy	getClientCachePolicy()
protected FlexibleResourceClient	getFlexibleRestApiServiceClient()
RequestRetryPolicy	getRequestRetryPolicy()
String	getResourceBaseUrl() Return the ResourceBaseUrl of this "resource".
protected RestApiServiceClient	getRestApiServiceClient()
UserCredential	getUserCredential() Returns the UserCredential associated with this UserClient.
protected void	init()
boolean	isMethodSupported(String methodName)
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 partialData, String id) Note: Partial update/PATCH support...
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.
void	setAuthRefreshPolicy(AuthRefreshPolicy authRefreshPolicy)
void	setAutoRedirectPolicy(AutoRedirectPolicy autoRedirectPolicy)
void	setCacheControlPolicy(CacheControlPolicy cacheControlPolicy)
void	setClientCachePolicy(ClientCachePolicy clientCachePolicy)
void	setRequestRetryPolicy(RequestRetryPolicy requestRetryPolicy)
void	setUserCredential(UserCredential userCredential)
String	toString()
Object	update(Object inputData, String id) Updates the resource instance, as defined by the inputData and id.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRestApiUserClient

public AbstractRestApiUserClient(RestApiServiceClient restApiServiceClient)

AbstractRestApiUserClient

public AbstractRestApiUserClient(RestApiServiceClient restApiServiceClient,
                         UserCredential authCredential)

Method Detail

init

protected void init()

getRestApiServiceClient

protected RestApiServiceClient getRestApiServiceClient()

getFlexibleRestApiServiceClient

protected FlexibleResourceClient getFlexibleRestApiServiceClient()

isMethodSupported

public boolean isMethodSupported(String methodName)

Specified by:

isMethodSupported in interface MethodFilter

getUserCredential

public UserCredential getUserCredential()

Description copied from interface: UserClient

Returns the UserCredential associated with this UserClient.

Specified by:

getUserCredential in interface UserClient

Returns:

UserCredential

setUserCredential

public void setUserCredential(UserCredential userCredential)

Specified by:

setUserCredential in interface FlexibleUserClient

getResourceBaseUrl

public String getResourceBaseUrl()

Description copied from interface: ResourceClient

Return the ResourceBaseUrl of this "resource".

Specified by:

getResourceBaseUrl in interface ResourceClient

Returns:

ResourceBaseUrl

getAuthRefreshPolicy

public AuthRefreshPolicy getAuthRefreshPolicy()

Specified by:

getAuthRefreshPolicy in interface WebClient

setAuthRefreshPolicy

public void setAuthRefreshPolicy(AuthRefreshPolicy authRefreshPolicy)

Specified by:

setAuthRefreshPolicy in interface FlexibleWebClient

getRequestRetryPolicy

public RequestRetryPolicy getRequestRetryPolicy()

Specified by:

getRequestRetryPolicy in interface WebClient

setRequestRetryPolicy

public void setRequestRetryPolicy(RequestRetryPolicy requestRetryPolicy)

Specified by:

setRequestRetryPolicy in interface FlexibleWebClient

getClientCachePolicy

public ClientCachePolicy getClientCachePolicy()

Specified by:

getClientCachePolicy in interface WebClient

setClientCachePolicy

public void setClientCachePolicy(ClientCachePolicy clientCachePolicy)

Specified by:

setClientCachePolicy in interface FlexibleWebClient

getCacheControlPolicy

public CacheControlPolicy getCacheControlPolicy()

Specified by:

getCacheControlPolicy in interface WebClient

setCacheControlPolicy

public void setCacheControlPolicy(CacheControlPolicy cacheControlPolicy)

Specified by:

setCacheControlPolicy in interface FlexibleWebClient

getAutoRedirectPolicy

public AutoRedirectPolicy getAutoRedirectPolicy()

Specified by:

getAutoRedirectPolicy in interface WebClient

setAutoRedirectPolicy

public void setAutoRedirectPolicy(AutoRedirectPolicy autoRedirectPolicy)

Specified by:

setAutoRedirectPolicy in interface FlexibleWebClient

get

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

Description copied from interface: RestUserClient

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.

Specified by:

get in interface RestUserClient

Parameters:

id - Resource id.

params - URL query parameters to select a collection.

Returns:

Returns a single resource or a collection.

Throws:

IOException - TODO

post

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

Description copied from interface: RestUserClient

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

Specified by:

post in interface RestUserClient

Parameters:

inputData - The object to be created.

Returns:

The new resource.

Throws:

IOException - TODO

put

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

Description copied from interface: RestUserClient

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.

Specified by:

put in interface RestUserClient

Parameters:

inputData - The new resource.

id - Resource id.

Returns:

The new created/updated resource.

Throws:

IOException - TODO

patch

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

Specified by:

patch in interface RestUserClient

Throws:

IOException

delete

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

Description copied from interface: RestUserClient

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.

Specified by:

delete in interface RestUserClient

Parameters:

id - Resource id.

params - URL query parameters to select a collection.

Returns:

boolean variable to indicate the success/failure.

Throws:

IOException - TODO

get

public Object get(String id)
           throws RestApiException,
                  IOException

Description copied from interface: ApiUserClient

Returns the resource specified by the id.

Specified by:

get in interface ApiUserClient

Parameters:

id - Unique id of the resource.

Returns:

The resource/object.

Throws:

RestApiException

IOException

list

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

Description copied from interface: ApiUserClient

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

Specified by:

list in interface ApiUserClient

Parameters:

params - Selection filter.

Returns:

The list of resource instances.

Throws:

RestApiException

IOException

keys

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

Description copied from interface: ApiUserClient

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

Specified by:

keys in interface ApiUserClient

Parameters:

params - Selection filter.

Returns:

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

Throws:

RestApiException

IOException

create

public Object create(Object inputData)
              throws RestApiException,
                     IOException

Description copied from interface: ApiUserClient

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

Specified by:

create in interface ApiUserClient

Parameters:

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

Returns:

The newly created resource object.

Throws:

RestApiException

IOException

create

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

Description copied from interface: ApiUserClient

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

Specified by:

create in interface ApiUserClient

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

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

Description copied from interface: ApiUserClient

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

Specified by:

update in interface ApiUserClient

Parameters:

inputData - A new resource instance.

id - The resource id.

Returns:

The updated resource object.

Throws:

RestApiException

IOException

modify

public Object modify(Object partialData,
            String id)
              throws RestApiException,
                     IOException

Description copied from interface: ApiUserClient

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.

Specified by:

modify in interface ApiUserClient

Parameters:

partialData - 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

public boolean delete(String id)
               throws RestApiException,
                      IOException

Description copied from interface: ApiUserClient

Deletes the resource instance specified by id.

Specified by:

delete in interface ApiUserClient

Parameters:

id - The resource id.

Returns:

true if the operation is successful.

Throws:

RestApiException

IOException

delete

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

Description copied from interface: ApiUserClient

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

Specified by:

delete in interface ApiUserClient

Returns:

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

Throws:

RestApiException

IOException

toString

public String toString()

Overrides:

toString in class Object