org.miniclient.common

Interface ResourceUrlBuilder

All Known Implementing Classes:

AbstractResourceUrlBuilder, AbstractRestServiceClient, AbstractRestUserClient, DefaultResourceUrlBuilder, DefaultRestServiceClient, DefaultRestUserClient

public interface ResourceUrlBuilder

Defines a "rule" to create a set of URLs (for GET, POST, PUT, DELETE). TBD: Some Web service require a "suffix" to indicate the desired response format. (e.g., http://twitter/status/update/123.json) How to support this without making the API overly complex???

Method Summary

Methods

Modifier and Type	Method and Description
String	getResourceBaseUrl() Returns the Web service URL corresponding to the given 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.

Method Detail

getResourceBaseUrl

String getResourceBaseUrl()

Returns the Web service URL corresponding to the given resource.

Returns:

Resource base URL.

getResourceGetUrl

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

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.

Parameters:

id - Resource id.

params - URL query parameters to select a collection.

Returns:

Returns URL for a single resource or a collection.

getResourcePostUrl

String getResourcePostUrl()

Returns the URL for POST'ing to the resource.

Returns:

the resource URL for posting.

getResourcePutUrl

String getResourcePutUrl(String id)

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

Parameters:

id - Resource id.

Returns:

the resource URL for PUT'ing.

getResourcePatchUrl

String getResourcePatchUrl(String id)

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

Parameters:

id - Resource id.

Returns:

the resource URL for PUT'ing.

getResourceDeleteUrl

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

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.

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.