org.miniclient.impl

Class AbstractRestUserClient

java.lang.Object

org.miniclient.impl.AbstractRestUserClient

All Implemented Interfaces:

HttpMethodFilter, MethodFilter, ResourceUrlBuilder, FlexibleResourceClient, FlexibleUserClient, FlexibleWebClient, ResourceClient, ResourceUserClient, RestClient, RestUserClient, UserClient, WebClient

Direct Known Subclasses:

DefaultRestUserClient

public abstract class AbstractRestUserClient
extends Object
implements RestUserClient, FlexibleResourceClient, FlexibleUserClient, ResourceUrlBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractRestUserClient(RestServiceClient restServiceClient)
AbstractRestUserClient(RestServiceClient restServiceClient, UserCredential userCredential)
AbstractRestUserClient(String resourceBaseUrl)
AbstractRestUserClient(String resourceBaseUrl, UserCredential userCredential)

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.
AuthRefreshPolicy	getAuthRefreshPolicy()
AutoRedirectPolicy	getAutoRedirectPolicy()
CacheControlPolicy	getCacheControlPolicy()
ClientCachePolicy	getClientCachePolicy()
protected FlexibleResourceClient	getFlexibleRestServiceClient()
RequestRetryPolicy	getRequestRetryPolicy()
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.
protected RestServiceClient	getRestServiceClient()
UserCredential	getUserCredential() Returns the UserCredential associated with this UserClient.
protected void	init()
boolean	isAccessAllowed()
boolean	isMethodSupported(String methodName)
protected RestUserClientMaker	makeRestUserClientMaker()
protected RestServiceClient	makeServiceClient(String resourceBaseUrl)
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRestUserClient

public AbstractRestUserClient(String resourceBaseUrl)

AbstractRestUserClient

public AbstractRestUserClient(String resourceBaseUrl,
                      UserCredential userCredential)

AbstractRestUserClient

public AbstractRestUserClient(RestServiceClient restServiceClient)

AbstractRestUserClient

public AbstractRestUserClient(RestServiceClient restServiceClient,
                      UserCredential userCredential)

Method Detail

init

protected void init()

getRestServiceClient

protected RestServiceClient getRestServiceClient()

getFlexibleRestServiceClient

protected FlexibleResourceClient getFlexibleRestServiceClient()

makeRestUserClientMaker

protected RestUserClientMaker makeRestUserClientMaker()

makeServiceClient

protected RestServiceClient makeServiceClient(String resourceBaseUrl)

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.

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

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

isAccessAllowed

public boolean isAccessAllowed()

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

toString

public String toString()

Overrides:

toString in class Object