de.hybris.platform.webservices.objectgraphtransformer

Class YContextResourceResolver

java.lang.Object

de.hybris.platform.webservices.objectgraphtransformer.YContextResourceResolver

public class YContextResourceResolver
extends java.lang.Object

This class delivers two main functions (that refer to the context aware resources):

1) creating URL's for specified model instance

2) retrieving specified model from information contained in the URL

Field Summary

Fields

Modifier and Type	Field and Description
static int	FROM_TYPE_OR_VALUE
static java.lang.String	QUERY_PARAMETERS_KEY_SEPARATOR
static java.lang.String	QUERY_PARAMETERS_PAIRSEPARATOR
static java.lang.String	QUERY_PARAMETERS_PREFIX
static java.lang.String	QUERY_PARAMETERS_VALUE_SEPARATOR
static int	TO_TYPE_OR_VALUE

Constructor Summary

Constructors

Constructor and Description
YContextResourceResolver(ServiceLocator serviceLocator)

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildUri(java.lang.Object modelValue, java.lang.Object propValue) Method creates appropriate URL for the given model.
java.lang.String	getBaseUrl()
ServiceLocator	getServiceLocator()
java.lang.String	getUniquePropertyName(ComposedTypeModel composedTypeModel) Method returns unique primitive attribute name of the given composedTypeModel.
ItemModel	readResourceInternal(ItemModel modelToSet, java.lang.String composedType, UriInfo uriInfo, ItemModel uniqueMember) Method obtains existing(saved) model from empty(not saved) model which is bulit from information that are pull out from URL path(uniqueMember attribute) and query parameter.
void	setBaseUrl(java.lang.String baseUrl)

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_PARAMETERS_PREFIX

public static final java.lang.String QUERY_PARAMETERS_PREFIX

QUERY_PARAMETERS_PAIRSEPARATOR

public static final java.lang.String QUERY_PARAMETERS_PAIRSEPARATOR

QUERY_PARAMETERS_KEY_SEPARATOR

public static final java.lang.String QUERY_PARAMETERS_KEY_SEPARATOR

QUERY_PARAMETERS_VALUE_SEPARATOR

public static final java.lang.String QUERY_PARAMETERS_VALUE_SEPARATOR

TO_TYPE_OR_VALUE

public static final int TO_TYPE_OR_VALUE

See Also:

Constant Field Values

FROM_TYPE_OR_VALUE

public static final int FROM_TYPE_OR_VALUE

See Also:

Constant Field Values

Constructor Detail

YContextResourceResolver

public YContextResourceResolver(ServiceLocator serviceLocator)

Method Detail

getServiceLocator

public ServiceLocator getServiceLocator()

getBaseUrl

public java.lang.String getBaseUrl()

setBaseUrl

public void setBaseUrl(java.lang.String baseUrl)

buildUri

public java.lang.String buildUri(java.lang.Object modelValue,
                                 java.lang.Object propValue)

Method creates appropriate URL for the given model. Some models include unique attributes(which are also models) and this information about them will be contained within URL. The URL may consist of nested URL path segments and query parameter. The unique attribute of the give model which will have the largest number of nested unique attributes will be placed in URL. The rest of them will be in query parameter.

Example:

 1) given model - CarModel(unique primitive attribute: c1)
 2) its three non-primitive unique attributes:
        2a) ManufacturerModel(m1)
        2b) UserModel(u1)
        2c) ProductModel(p1) and its unique:
                3) CatalogVersionModel(Online) and its unique:
                        4) CatalogModel(hwcatalog)
 

Result url:

 http://{host_port_webroot}/catalogs/hwcatalog/catalogversions/Online/products/p1/cars/c1?um__car;manufacturer__car;user=c1;m1,c1:u1
 

Parameters:

modelValue - model Value

propValue - value of the non-primitive unique attribute of the modelValue

Returns:

the URL for given model

readResourceInternal

public ItemModel readResourceInternal(ItemModel modelToSet,
                                      java.lang.String composedType,
                                      UriInfo uriInfo,
                                      ItemModel uniqueMember)
                               throws BadRequestException

Method obtains existing(saved) model from empty(not saved) model which is bulit from information that are pull out from URL path(uniqueMember attribute) and query parameter.

Parameters:

modelToSet - empty(not saved) model(template)

composedType - the code of the composedType of the modelToSet

uriInfo - uri information and by the way the special query parameter with information about unique members of modelToSet.

uniqueMember - the unique member(of modelToSet) which is passed from resource to resource(via URL path)

Returns:

existing(saved) model

Throws:

BadRequestException

getUniquePropertyName

public java.lang.String getUniquePropertyName(ComposedTypeModel composedTypeModel)

Method returns unique primitive attribute name of the given composedTypeModel.

Parameters:

composedTypeModel - the given model

Returns:

unique primitive attribute name of the given composedTypeModel