org.miniclient.impl

Class AbstractApiServiceClient

java.lang.Object

org.miniclient.impl.AbstractApiServiceClient

All Implemented Interfaces:

ApiClient, ApiServiceClient, CrudMethodFilter, DataAccessClient, MethodFilter, FlexibleResourceClient, FlexibleServiceClient, FlexibleWebClient, ResourceClient, ResourceServiceClient, ServiceClient, WebClient

Direct Known Subclasses:

DefaultApiServiceClient

public abstract class AbstractApiServiceClient
extends Object
implements ApiServiceClient, FlexibleResourceClient, FlexibleServiceClient

Constructor Summary

Constructors

Constructor and Description
AbstractApiServiceClient(String resourceBaseUrl)

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)
AuthRefreshPolicy	getAuthRefreshPolicy()
AutoRedirectPolicy	getAutoRedirectPolicy()
CacheControlPolicy	getCacheControlPolicy()
ClientCachePolicy	getClientCachePolicy()
ClientCredential	getClientCredential() Returns the ClientCredential associated with this ServiceClient
CrudMethodFilter	getCrudMethodFilter()
protected FlexibleResourceClient	getFlexibleRestServiceClient()
ListResponseType	getListResponseType()
RequestRetryPolicy	getRequestRetryPolicy()
Set<String>	getRequiredScopes()
String	getResourceBaseUrl() Return the ResourceBaseUrl of this "resource".
AuthRefreshPolicy	getRestServiceAuthRefreshPolicy()
AutoRedirectPolicy	getRestServiceAutoRedirectPolicy()
CacheControlPolicy	getRestServiceCacheControlPolicy()
protected 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)
protected ApiServiceClientMaker	makeApiServiceClientMaker()
protected AuthRefreshPolicy	makeAuthRefreshPolicy()
protected AutoRedirectPolicy	makeAutoRedirectPolicy()
protected CacheControlPolicy	makeCacheControlPolicy()
protected ClientCachePolicy	makeClientCachePolicy()
protected CrudMethodFilter	makeCrudMethodFilter()
protected RequestRetryPolicy	makeRequestRetryPolicy()
protected RestServiceClient	makeRestClient(String resourceBaseUrl)
Object	modify(UserCredential credential, Object partialData, String id) Partial update/PATCH support
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	setListResponseType(ListResponseType listResponseType)
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

AbstractApiServiceClient

public AbstractApiServiceClient(String resourceBaseUrl)

Method Detail

init

protected void init()

getRestServiceClient

protected RestServiceClient getRestServiceClient()

getFlexibleRestServiceClient

protected FlexibleResourceClient getFlexibleRestServiceClient()

makeApiServiceClientMaker

protected ApiServiceClientMaker makeApiServiceClientMaker()

makeRestClient

protected RestServiceClient makeRestClient(String resourceBaseUrl)

makeCrudMethodFilter

protected CrudMethodFilter makeCrudMethodFilter()

makeAuthRefreshPolicy

protected AuthRefreshPolicy makeAuthRefreshPolicy()

makeRequestRetryPolicy

protected RequestRetryPolicy makeRequestRetryPolicy()

makeClientCachePolicy

protected ClientCachePolicy makeClientCachePolicy()

makeCacheControlPolicy

protected CacheControlPolicy makeCacheControlPolicy()

makeAutoRedirectPolicy

protected AutoRedirectPolicy makeAutoRedirectPolicy()

getCrudMethodFilter

public CrudMethodFilter getCrudMethodFilter()

isMethodSupported

public boolean isMethodSupported(String methodName)

Specified by:

isMethodSupported in interface MethodFilter

getListResponseType

public ListResponseType getListResponseType()

setListResponseType

public void setListResponseType(ListResponseType listResponseType)

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

getAutoRedirectPolicy

public AutoRedirectPolicy getAutoRedirectPolicy()

Specified by:

getAutoRedirectPolicy in interface WebClient

setAutoRedirectPolicy

public void setAutoRedirectPolicy(AutoRedirectPolicy autoRedirectPolicy)

Specified by:

setAutoRedirectPolicy in interface FlexibleWebClient

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

getCacheControlPolicy

public CacheControlPolicy getCacheControlPolicy()

Specified by:

getCacheControlPolicy in interface WebClient

setCacheControlPolicy

public void setCacheControlPolicy(CacheControlPolicy cacheControlPolicy)

Specified by:

setCacheControlPolicy in interface FlexibleWebClient