de.hybris.platform.acceleratorwebservicesaddon.controllers.v2

Class ExtendedCartsController

java.lang.Object

de.hybris.platform.acceleratorwebservicesaddon.controllers.v2.ExtendedCartsController

public class ExtendedCartsController
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ExtendedCartsController()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	buildMerchantCallbackUrl(boolean extendedMerchantCallback, java.lang.String baseSiteId, java.lang.String userId, java.lang.String cartId) Method build merchant callback url for given parameters
CartModificationListWsDTO	consolidatePickupLocations(java.lang.String storeName, java.lang.String fields) Web service handler for consolidating pickup locations Request Method = POST
void	deleteSopPaymentResponse(java.lang.String cartId) Method deletes payment provider response related to cart
PointOfServiceListWsDTO	getConsolidatedPickupOptions(java.lang.String fields) Web service handler for getting consolidated pickup options Request Method = GET
protected java.util.Map<java.lang.String,java.lang.String>	getParameterMap(HttpServletRequest request)
PaymentRequestWsDTO	getSopPaymentRequestDetails(java.lang.String responseUrl, boolean extendedMerchantCallback, java.lang.String baseSiteId, java.lang.String userId, java.lang.String cartId) Method returns information needed for create subscription contacting directly with payment provider.
PaymentDetailsWsDTO	getSopPaymentResponse(java.lang.String cartId, java.lang.String fields, HttpServletResponse response) Method for getting information about create subscription request results.
protected CCPaymentInfoData	handlePaymentSubscriptionResultData(PaymentSubscriptionResultData paymentSubscriptionResultData, Errors errors) Method analyze payment subscription result data.
PaymentDetailsWsDTO	handleSopPaymentResponse(HttpServletRequest request, SopPaymentDetailsWsDTO sopPaymentDetails, java.lang.String fields) Method handles response from payment provider and create payment details
protected Errors	validate(java.lang.Object object, java.lang.String objectName, Validator validator)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedCartsController

public ExtendedCartsController()

Method Detail

getConsolidatedPickupOptions

public PointOfServiceListWsDTO getConsolidatedPickupOptions(java.lang.String fields)

Web service handler for getting consolidated pickup options
Request Method = GET

Returns:

PointOfServiceListWsDTO as response body

consolidatePickupLocations

public CartModificationListWsDTO consolidatePickupLocations(java.lang.String storeName,
                                                            java.lang.String fields)
                                                     throws CommerceCartModificationException

Web service handler for consolidating pickup locations
Request Method = POST

Parameters:

storeName - - name of store where items will be picked

Returns:

CartModificationListWsDTO as response body

Throws:

CommerceCartModificationException

getSopPaymentRequestDetails

public PaymentRequestWsDTO getSopPaymentRequestDetails(java.lang.String responseUrl,
                                                       boolean extendedMerchantCallback,
                                                       java.lang.String baseSiteId,
                                                       java.lang.String userId,
                                                       java.lang.String cartId)

Method returns information needed for create subscription contacting directly with payment provider. These information contains payment provider url and list of parameters needed to create subscription. Parameters are partially filled with appropriate values.

Parameters:

responseUrl - Value for orderPage_cancelResponseURL, 'orderPage_declineResponseURL, orderPage_receiptResponseURL

baseSiteId - Base site identifier

Returns:

payment provider url and parameters describing subscription

buildMerchantCallbackUrl

protected java.lang.String buildMerchantCallbackUrl(boolean extendedMerchantCallback,
                                                    java.lang.String baseSiteId,
                                                    java.lang.String userId,
                                                    java.lang.String cartId)

Method build merchant callback url for given parameters

Parameters:

extendedMerchantCallback - Define which url should be returned

baseSiteId - Base site identifier

userId - User identifier

cartId - Cart identifier

Returns:

merchant callback url

handleSopPaymentResponse

public PaymentDetailsWsDTO handleSopPaymentResponse(HttpServletRequest request,
                                                    SopPaymentDetailsWsDTO sopPaymentDetails,
                                                    java.lang.String fields)

Method handles response from payment provider and create payment details

Parameters:

request - Http request

sopPaymentDetails - Information returned by payment provider in create subscription process

fields - Response configuration (list of fields, which should be returned in response)

Returns:

created payment details

handlePaymentSubscriptionResultData

protected CCPaymentInfoData handlePaymentSubscriptionResultData(PaymentSubscriptionResultData paymentSubscriptionResultData,
                                                                Errors errors)

Method analyze payment subscription result data. If create subscription result is success it returns created payment info. Otherwise appropriate exception is thrown.

Parameters:

paymentSubscriptionResultData - Data to analyze

errors - Object storing validation errors. Can be null - then empty error object will be created

Returns:

payment info

getSopPaymentResponse

public PaymentDetailsWsDTO getSopPaymentResponse(java.lang.String cartId,
                                                 java.lang.String fields,
                                                 HttpServletResponse response)

Method for getting information about create subscription request results. If there is no response from payment provider - method will return 202-Accepted status. If subscription was created successfully payment details is returned. Otherwise error response will be returned.

Parameters:

cartId - Cart identifier

fields - Response configuration (list of fields, which should be returned in response)

response - Http response

Returns:

payment details related with subscription

deleteSopPaymentResponse

public void deleteSopPaymentResponse(java.lang.String cartId)

Method deletes payment provider response related to cart

Parameters:

cartId - Cart identifier

getParameterMap

protected java.util.Map<java.lang.String,java.lang.String> getParameterMap(HttpServletRequest request)

validate

protected Errors validate(java.lang.Object object,
                          java.lang.String objectName,
                          Validator validator)