org.miniclient.common.impl

Class AbstractResourceUrlBuilder

java.lang.Object

org.miniclient.common.impl.AbstractResourceUrlBuilder

All Implemented Interfaces:

Serializable, ResourceUrlBuilder

Direct Known Subclasses:

DefaultResourceUrlBuilder

public abstract class AbstractResourceUrlBuilder
extends Object
implements ResourceUrlBuilder, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractResourceUrlBuilder(String resourceBaseUrl)
AbstractResourceUrlBuilder(String resourceBaseUrl, String suffix)
AbstractResourceUrlBuilder(String parentResourceBaseUrl, String parentResourceId, String resourceName)
AbstractResourceUrlBuilder(String parentResourceBaseUrl, String parentResourceId, String resourceName, String suffix)

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildBaseUrl(String parentResourceBaseUrl, String parentResourceId, String resourceName)
static String	buildResourceDeleteUrl(String baseUrl, String id, Map<String,Object> params, String sufx)
static String	buildResourceGetUrl(String baseUrl, String id, Map<String,Object> params, String sufx)
static String	buildResourcePatchUrl(String baseUrl, String id, String sufx)
static String	buildResourcePostUrl(String baseUrl, String sufx)
static String	buildResourcePutUrl(String baseUrl, String id, String sufx)
String	getParentResourceBaseUrl()
String	getParentResourceId()
String	getResourceBaseUrl() Returns the Web service URL corresponding to the given resource.
String	getResourceDeleteUrl(Map<String,Object> params)
String	getResourceDeleteUrl(String id)
String	getResourceDeleteUrl(String id, Map<String,Object> params) Both id and params cannot be null.
String	getResourceGetUrl(Map<String,Object> params)
String	getResourceGetUrl(String id)
String	getResourceGetUrl(String id, Map<String,Object> params) Both id and params cannot be null.
String	getResourceName()
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.
String	getSuffix()
protected void	init()
void	setParentResourceBaseUrl(String parentResourceBaseUrl)
void	setParentResourceId(String parentResourceId)
void	setResourceBaseUrl(String resourceBaseUrl)
void	setResourceName(String resourceName)
void	setSuffix(String suffix)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResourceUrlBuilder

public AbstractResourceUrlBuilder(String resourceBaseUrl)

AbstractResourceUrlBuilder

public AbstractResourceUrlBuilder(String resourceBaseUrl,
                          String suffix)

AbstractResourceUrlBuilder

public AbstractResourceUrlBuilder(String parentResourceBaseUrl,
                          String parentResourceId,
                          String resourceName)

AbstractResourceUrlBuilder

public AbstractResourceUrlBuilder(String parentResourceBaseUrl,
                          String parentResourceId,
                          String resourceName,
                          String suffix)

Method Detail

init

protected void init()

buildBaseUrl

public static String buildBaseUrl(String parentResourceBaseUrl,
                  String parentResourceId,
                  String resourceName)

getResourceBaseUrl

public String getResourceBaseUrl()

Description copied from interface: ResourceUrlBuilder

Returns the Web service URL corresponding to the given resource.

Specified by:

getResourceBaseUrl in interface ResourceUrlBuilder

Returns:

Resource base URL.

setResourceBaseUrl

public void setResourceBaseUrl(String resourceBaseUrl)

getParentResourceBaseUrl

public String getParentResourceBaseUrl()

setParentResourceBaseUrl

public void setParentResourceBaseUrl(String parentResourceBaseUrl)

getParentResourceId

public String getParentResourceId()

setParentResourceId

public void setParentResourceId(String parentResourceId)

getResourceName

public String getResourceName()

setResourceName

public void setResourceName(String resourceName)

getSuffix

public String getSuffix()

setSuffix

public void setSuffix(String suffix)

getResourceGetUrl

public String getResourceGetUrl(String id)

getResourceGetUrl

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

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.

buildResourceGetUrl

public static String buildResourceGetUrl(String baseUrl,
                         String id,
                         Map<String,Object> params,
                         String sufx)

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.

buildResourcePostUrl

public static String buildResourcePostUrl(String baseUrl,
                          String sufx)

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.

buildResourcePutUrl

public static String buildResourcePutUrl(String baseUrl,
                         String id,
                         String sufx)

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.

buildResourcePatchUrl

public static String buildResourcePatchUrl(String baseUrl,
                           String id,
                           String sufx)

getResourceDeleteUrl

public String getResourceDeleteUrl(String id)

getResourceDeleteUrl

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

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.

buildResourceDeleteUrl

public static String buildResourceDeleteUrl(String baseUrl,
                            String id,
                            Map<String,Object> params,
                            String sufx)

toString

public String toString()

Overrides:

toString in class Object