org.miniclient.impl

Class AbstractRestApiServiceClient

java.lang.Object

org.miniclient.impl.AbstractRestApiServiceClient

All Implemented Interfaces:

ApiClient, ApiServiceClient, CrudMethodFilter, DataAccessClient, HttpMethodFilter, MethodFilter, FlexibleResourceClient, FlexibleServiceClient, FlexibleWebClient, ResourceClient, ResourceServiceClient, RestApiServiceClient, RestClient, RestServiceClient, ServiceClient, WebClient

Direct Known Subclasses:

DefaultRestApiServiceClient

public abstract class AbstractRestApiServiceClient
extends Object
implements RestApiServiceClient, FlexibleResourceClient, FlexibleServiceClient

Constructor Summary

Constructors

Constructor and Description
AbstractRestApiServiceClient()

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)
Map<String,Object>	delete(UserCredential credential, String id, Map<String,Object> params) Both id and params cannot be null.
Object	get(UserCredential credential, String id)
Map<String,Object>	get(UserCredential credential, String id, Map<String,Object> params) Both id and params cannot be null.
ApiServiceClient	getApiServiceClient()
AuthRefreshPolicy	getAuthRefreshPolicy()
AutoRedirectPolicy	getAutoRedirectPolicy()
CacheControlPolicy	getCacheControlPolicy()
ClientCachePolicy	getClientCachePolicy()
ClientCredential	getClientCredential() Returns the ClientCredential associated with this ServiceClient
protected FlexibleResourceClient	getFlexibleApiServiceClient()
protected FlexibleResourceClient	getFlexibleRestServiceClient()
RequestRetryPolicy	getRequestRetryPolicy()
Set<String>	getRequiredScopes()
String	getResourceBaseUrl() Return the ResourceBaseUrl of this "resource".
AuthRefreshPolicy	getRestServiceAuthRefreshPolicy()
AutoRedirectPolicy	getRestServiceAutoRedirectPolicy()
CacheControlPolicy	getRestServiceCacheControlPolicy()
RestServiceClient	getRestServiceClient()
ClientCachePolicy	getRestServiceClientCachePolicy()
RequestRetryPolicy	getRestServiceRequestRetryPolicy()
protected void	init()
boolean	isAccessAllowed(DataAccessCredential dataAccessCredential)
boolean	isMethodSupported(String methodName)
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
Map<String,Object>	patch(UserCredential credential, Object partialData, String id)
Map<String,Object>	post(UserCredential credential, Object inputData) Returns the new resource created by the given input.
Map<String,Object>	put(UserCredential credential, Object inputData, String id) Returns the resource created/updated by the given input.
boolean	requiresScope(String scope)
void	setAuthRefreshPolicy(AuthRefreshPolicy authRefreshPolicy)
void	setAutoRedirectPolicy(AutoRedirectPolicy autoRedirectPolicy)
void	setCacheControlPolicy(CacheControlPolicy cacheControlPolicy)
void	setClientCachePolicy(ClientCachePolicy clientCachePolicy)
void	setClientCredential(ClientCredential clientCredential)
void	setRequestRetryPolicy(RequestRetryPolicy requestRetryPolicy)
void	setRestServiceAuthRefreshPolicy(AuthRefreshPolicy authRefreshPolicy)
void	setRestServiceAutoRedirectPolicy(AutoRedirectPolicy autoRedirectPolicy)
void	setRestServiceCacheControlPolicy(CacheControlPolicy cacheControlPolicy)
void	setRestServiceClientCachePolicy(ClientCachePolicy clientCachePolicy)
void	setRestServiceRequestRetryPolicy(RequestRetryPolicy requestRetryPolicy)
String	toString()
Object	update(UserCredential credential, Object inputData, String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRestApiServiceClient

public AbstractRestApiServiceClient()

Method Detail

init

protected void init()

getRestServiceClient

public RestServiceClient getRestServiceClient()

getFlexibleRestServiceClient

protected FlexibleResourceClient getFlexibleRestServiceClient()

getApiServiceClient

public ApiServiceClient getApiServiceClient()

getFlexibleApiServiceClient

protected FlexibleResourceClient getFlexibleApiServiceClient()

isMethodSupported

public boolean isMethodSupported(String methodName)

Specified by:

isMethodSupported in interface MethodFilter

getResourceBaseUrl

public String getResourceBaseUrl()

Description copied from interface: ResourceClient

Return the ResourceBaseUrl of this "resource".

Specified by:

getResourceBaseUrl in interface ResourceClient

Returns:

ResourceBaseUrl

getClientCredential

public ClientCredential getClientCredential()

Description copied from interface: ServiceClient

Returns the ClientCredential associated with this ServiceClient

Specified by:

getClientCredential in interface ServiceClient

Returns:

ClientCredential

setClientCredential

public void setClientCredential(ClientCredential clientCredential)

Specified by:

setClientCredential in interface FlexibleServiceClient

getRestServiceAuthRefreshPolicy

public AuthRefreshPolicy getRestServiceAuthRefreshPolicy()

setRestServiceAuthRefreshPolicy

public void setRestServiceAuthRefreshPolicy(AuthRefreshPolicy authRefreshPolicy)

getRestServiceRequestRetryPolicy

public RequestRetryPolicy getRestServiceRequestRetryPolicy()

setRestServiceRequestRetryPolicy

public void setRestServiceRequestRetryPolicy(RequestRetryPolicy requestRetryPolicy)

getRestServiceClientCachePolicy

public ClientCachePolicy getRestServiceClientCachePolicy()

setRestServiceClientCachePolicy

public void setRestServiceClientCachePolicy(ClientCachePolicy clientCachePolicy)

getRestServiceCacheControlPolicy

public CacheControlPolicy getRestServiceCacheControlPolicy()

setRestServiceCacheControlPolicy

public void setRestServiceCacheControlPolicy(CacheControlPolicy cacheControlPolicy)

getRestServiceAutoRedirectPolicy

public AutoRedirectPolicy getRestServiceAutoRedirectPolicy()

setRestServiceAutoRedirectPolicy

public void setRestServiceAutoRedirectPolicy(AutoRedirectPolicy autoRedirectPolicy)

getRequiredScopes

public Set<String> getRequiredScopes()

Specified by:

getRequiredScopes in interface DataAccessClient

requiresScope

public boolean requiresScope(String scope)

Specified by:

requiresScope in interface DataAccessClient

isAccessAllowed

public boolean isAccessAllowed(DataAccessCredential dataAccessCredential)

Specified by:

isAccessAllowed in interface DataAccessClient

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(UserCredential credential,
                     String id,
                     Map<String,Object> params)
                       throws IOException

Description copied from interface: RestServiceClient

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 RestServiceClient

Parameters:

credential - Auth credential of a user needed to access the resource on behalf of the user.

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(UserCredential credential,
                      Object inputData)
                        throws IOException

Description copied from interface: RestServiceClient

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

Specified by:

post in interface RestServiceClient

Parameters:

credential - Auth credential of a user needed to access the resource on behalf of the user.

inputData - The object to be created.

Returns:

The new resource.

Throws:

IOException - TODO

put

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

Description copied from interface: RestServiceClient

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 RestServiceClient

Parameters:

credential - Auth credential of a user needed to access the resource on behalf of the user.

inputData - The new resource.

id - Resource id.

Returns:

The new created/updated resource.

Throws:

IOException - TODO

patch

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

Specified by:

patch in interface RestServiceClient

Throws:

IOException

delete

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

Description copied from interface: RestServiceClient

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 RestServiceClient

Parameters:

credential - Auth credential of a user needed to access the resource on behalf of the user.

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(UserCredential credential,
         String id)
           throws RestApiException,
                  IOException

Specified by:

get in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

list

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

Specified by:

list in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

keys

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

Specified by:

keys in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

create

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

Specified by:

create in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

create

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

Specified by:

create in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

update

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

Specified by:

update in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

modify

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

Description copied from interface: ApiServiceClient

Partial update/PATCH support

Specified by:

modify in interface ApiServiceClient

Returns:

Throws:

RestApiException

IOException

delete

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

Specified by:

delete in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

delete

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

Specified by:

delete in interface ApiServiceClient

Returns:

Throws:

RestApiException - TODO

IOException - TODO

toString

public String toString()

Overrides:

toString in class Object