org.miniclient.impl

Class AbstractRestServiceClient

java.lang.Object

org.miniclient.impl.AbstractRestServiceClient

All Implemented Interfaces:

DataAccessClient, HttpMethodFilter, MethodFilter, ResourceUrlBuilder, FlexibleResourceClient, FlexibleServiceClient, FlexibleWebClient, ResourceClient, ResourceServiceClient, RestClient, RestServiceClient, ServiceClient, WebClient

Direct Known Subclasses:

DefaultRestServiceClient

public abstract class AbstractRestServiceClient
extends Object
implements RestServiceClient, FlexibleResourceClient, FlexibleServiceClient, ResourceUrlBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractRestServiceClient(String resourceBaseUrl)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addRequiredScope(String scope)
boolean	addRequiredScopes(Collection<String> scopes)
void	clearRequiredScopes()
Map<String,Object>	delete(UserCredential credential, String id, Map<String,Object> params) Both id and params cannot be null.
Map<String,Object>	get(UserCredential credential, String id, Map<String,Object> params) Both id and params cannot be null.
AuthRefreshPolicy	getAuthRefreshPolicy()
AutoRedirectPolicy	getAutoRedirectPolicy()
CacheControlPolicy	getCacheControlPolicy()
ClientCachePolicy	getClientCachePolicy()
ClientCredential	getClientCredential() Returns the ClientCredential associated with this ServiceClient
UserCredential	getDefaultAuthCredential()
HttpMethodFilter	getHttpMethodFilter()
String	getRequestFormat()
RequestRetryPolicy	getRequestRetryPolicy()
Set<String>	getRequiredScopes()
String	getResourceBaseUrl() Return the ResourceBaseUrl of this "resource".
String	getResourceDeleteUrl(String id, Map<String,Object> params) Both id and params cannot be null.
String	getResourceGetUrl(String id, Map<String,Object> params) Both id and params cannot be null.
String	getResourcePatchUrl(String id) Returns the URL for PUT'ing to the resource specified by the id.
String	getResourcePostUrl() Returns the URL for POST'ing to the resource.
String	getResourcePutUrl(String id) Returns the URL for PUT'ing to the resource specified by the id.
ResourceUrlBuilder	getResourceUrlBuilder()
String	getResponseFormat()
int	getTimeoutSeconds()
protected void	init()
boolean	isAccessAllowed(DataAccessCredential dataAccessCredential)
boolean	isAuthCredentialRequired()
boolean	isMethodSupported(String methodName)
protected AuthRefreshPolicy	makeAuthRefreshPolicy()
protected AutoRedirectPolicy	makeAutoRedirectPolicy()
protected CacheControlPolicy	makeCacheControlPolicy()
protected ClientCachePolicy	makeClientCachePolicy()
protected DataAccessClient	makeDataAccessClient()
protected HttpMethodFilter	makeHttpMethodFilter()
protected RequestRetryPolicy	makeRequestRetryPolicy()
protected ResourceUrlBuilder	makeResourceUrlBuilder(String resourceBaseUrl)
protected RestServiceClientMaker	makeRestServiceClientMaker()
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.
protected Map<String,Object>	process(String method, UserCredential userCredential, Object inputData, String id, Map<String,Object> params)
protected Map<String,Object>	process(String method, UserCredential userCredential, Object inputData, String id, Map<String,Object> params, boolean retrying)
Map<String,Object>	put(UserCredential credential, Object inputData, String id) Returns the resource created/updated by the given input.
boolean	removeRequiredScope(String scope)
boolean	removeRequiredScopes(Collection<String> scopes)
boolean	requiresScope(String scope)
void	setAuthCredentialRequired(boolean authCredentialRequired)
void	setAuthRefreshPolicy(AuthRefreshPolicy authRefreshPolicy)
void	setAutoRedirectPolicy(AutoRedirectPolicy autoRedirectPolicy)
void	setCacheControlPolicy(CacheControlPolicy cacheControlPolicy)
void	setClientCachePolicy(ClientCachePolicy clientCachePolicy)
void	setClientCredential(ClientCredential clientCredential)
void	setDefaultAuthCredential(UserCredential defaultAuthCredential)
void	setRequestFormat(String requestFormat)
void	setRequestRetryPolicy(RequestRetryPolicy requestRetryPolicy)
boolean	setRequiredScopes(Collection<String> scopes)
void	setResponseFormat(String responseFormat)
void	setTimeoutSeconds(int timeoutSeconds)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRestServiceClient

public AbstractRestServiceClient(String resourceBaseUrl)

Method Detail

init

protected void init()

getResourceUrlBuilder

public ResourceUrlBuilder getResourceUrlBuilder()

getHttpMethodFilter

public HttpMethodFilter getHttpMethodFilter()

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 ResourceUrlBuilder

Specified by:

getResourceBaseUrl in interface ResourceClient

Returns:

ResourceBaseUrl

getResourceGetUrl

public String getResourceGetUrl(String id,
                       Map<String,Object> params)

Description copied from interface: ResourceUrlBuilder

Both id and params cannot be null. If id is specified, params is ignored. It returns the URL corresponding to the resource specified by id. If params is specified. It returns the URL corresponding to the collection of resources specified by the params. If neither id nor params is specified, then it's an error.

Specified by:

getResourceGetUrl in interface ResourceUrlBuilder

Parameters:

id - Resource id.

params - URL query parameters to select a collection.

Returns:

Returns URL for a single resource or a collection.

getResourcePostUrl

public String getResourcePostUrl()

Description copied from interface: ResourceUrlBuilder

Returns the URL for POST'ing to the resource.

Specified by:

getResourcePostUrl in interface ResourceUrlBuilder

Returns:

the resource URL for posting.

getResourcePutUrl

public String getResourcePutUrl(String id)

Description copied from interface: ResourceUrlBuilder

Returns the URL for PUT'ing to the resource specified by the id.

Specified by:

getResourcePutUrl in interface ResourceUrlBuilder

Parameters:

id - Resource id.

Returns:

the resource URL for PUT'ing.

getResourcePatchUrl

public String getResourcePatchUrl(String id)

Description copied from interface: ResourceUrlBuilder

Returns the URL for PUT'ing to the resource specified by the id.

Specified by:

getResourcePatchUrl in interface ResourceUrlBuilder

Parameters:

id - Resource id.

Returns:

the resource URL for PUT'ing.

getResourceDeleteUrl

public String getResourceDeleteUrl(String id,
                          Map<String,Object> params)

Description copied from interface: ResourceUrlBuilder

Both id and params cannot be null. If id is specified, params is ignored. It returns the URL for deleting the resource specified by id. If params is specified. It returns the URL for deleting the collection of resources specified by the params. If neither id nor params is specified, then it's an error.

Specified by:

getResourceDeleteUrl in interface ResourceUrlBuilder

Parameters:

id - Resource id.

params - URL query parameters to select a collection.

Returns:

Returns URL for deleting a single resource or a collection or resources.

makeRestServiceClientMaker

protected RestServiceClientMaker makeRestServiceClientMaker()

makeResourceUrlBuilder

protected ResourceUrlBuilder makeResourceUrlBuilder(String resourceBaseUrl)

makeHttpMethodFilter

protected HttpMethodFilter makeHttpMethodFilter()

makeDataAccessClient

protected DataAccessClient makeDataAccessClient()

makeAuthRefreshPolicy

protected AuthRefreshPolicy makeAuthRefreshPolicy()

makeRequestRetryPolicy

protected RequestRetryPolicy makeRequestRetryPolicy()

makeClientCachePolicy

protected ClientCachePolicy makeClientCachePolicy()

makeCacheControlPolicy

protected CacheControlPolicy makeCacheControlPolicy()

makeAutoRedirectPolicy

protected AutoRedirectPolicy makeAutoRedirectPolicy()

isAuthCredentialRequired

public boolean isAuthCredentialRequired()

setAuthCredentialRequired

public void setAuthCredentialRequired(boolean authCredentialRequired)

getDefaultAuthCredential

public UserCredential getDefaultAuthCredential()

setDefaultAuthCredential

public void setDefaultAuthCredential(UserCredential defaultAuthCredential)

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

getRequiredScopes

public Set<String> getRequiredScopes()

Specified by:

getRequiredScopes in interface DataAccessClient

addRequiredScope

public boolean addRequiredScope(String scope)

addRequiredScopes

public boolean addRequiredScopes(Collection<String> scopes)

setRequiredScopes

public boolean setRequiredScopes(Collection<String> scopes)

removeRequiredScope

public boolean removeRequiredScope(String scope)

removeRequiredScopes

public boolean removeRequiredScopes(Collection<String> scopes)

clearRequiredScopes

public void clearRequiredScopes()

requiresScope

public boolean requiresScope(String scope)

Specified by:

requiresScope in interface DataAccessClient

isAccessAllowed

public boolean isAccessAllowed(DataAccessCredential dataAccessCredential)

Specified by:

isAccessAllowed in interface DataAccessClient

getRequestFormat

public String getRequestFormat()

setRequestFormat

public void setRequestFormat(String requestFormat)

getResponseFormat

public String getResponseFormat()

setResponseFormat

public void setResponseFormat(String responseFormat)

getTimeoutSeconds

public int getTimeoutSeconds()

setTimeoutSeconds

public void setTimeoutSeconds(int timeoutSeconds)

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

process

protected Map<String,Object> process(String method,
                         UserCredential userCredential,
                         Object inputData,
                         String id,
                         Map<String,Object> params)
                              throws IOException

Throws:

IOException

process

protected Map<String,Object> process(String method,
                         UserCredential userCredential,
                         Object inputData,
                         String id,
                         Map<String,Object> params,
                         boolean retrying)
                              throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object