org.broadleafcommerce.common.web.payment.controller

Class CustomerPaymentGatewayAbstractController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.common.web.payment.controller.CustomerPaymentGatewayAbstractController

public abstract class CustomerPaymentGatewayAbstractController
extends BroadleafAbstractController

Abstract controller that provides convenience methods and resource declarations to facilitate payment gateway communication between the implementing module and the Spring injected customer profile engine. This class provides flows to enable Credit Card tokenization in a PCI-Compliant manner (e.g. through a mechanism like Transparent Redirect) with the ability to save it to a customer's profile.

If used in conjunction with the core framework, Broadleaf provides all the necessary spring resources, such as "blCustomerPaymentGatewayService" that are needed for this class. If you are using the common jars without the framework dependency, you will either have to implement the blCustomerPaymentGatewayService yourself in order to save the token to your implementing customer profile system.

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field and Description
protected CustomerPaymentGatewayService	customerPaymentGatewayService
protected static org.apache.commons.logging.Log	LOG
protected PaymentGatewayWebResponsePrintService	webResponsePrintService

Constructor Summary

Constructors

Constructor and Description
CustomerPaymentGatewayAbstractController()

Method Summary

Modifier and Type	Method and Description
Long	applyCustomerTokenToProfile(PaymentResponseDTO responseDTO)
String	createCustomerPayment(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes) This method is intended to initiate the creation of a saved payment token.
abstract PaymentGatewayConfiguration	getConfiguration()
abstract String	getCustomerPaymentErrorRedirect()
abstract String	getCustomerPaymentViewRedirect(String customerPaymentId)
abstract PaymentGatewayWebResponseService	getWebResponseService()
abstract void	handleProcessingException(Exception e, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)

Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

addDeepLink, getContextPath, isAjaxRequest, jsonResponse

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

webResponsePrintService

protected PaymentGatewayWebResponsePrintService webResponsePrintService

customerPaymentGatewayService

@Autowired(required=false)
 @Qualifier(value="blCustomerPaymentGatewayService")
protected CustomerPaymentGatewayService customerPaymentGatewayService

Constructor Detail

CustomerPaymentGatewayAbstractController

public CustomerPaymentGatewayAbstractController()

Method Detail

applyCustomerTokenToProfile

public Long applyCustomerTokenToProfile(PaymentResponseDTO responseDTO)
                                 throws IllegalArgumentException

Throws:

IllegalArgumentException

createCustomerPayment

public String createCustomerPayment(org.springframework.ui.Model model,
                                    javax.servlet.http.HttpServletRequest request,
                                    org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
                             throws PaymentException

This method is intended to initiate the creation of a saved payment token.

This assumes that the implementing gateway's PaymentGatewayWebResponseService knows how to parse an incoming HttpServletRequest into a PaymentResponseDTO which will then be used by the customer profile engine to save a token to the user's account (e.g. wallet).

Parameters:

model - - Spring MVC model

request - - the HTTPServletRequest (originating either from a Payment Gateway or from the implementing checkout engine)

redirectAttributes - - Spring MVC redirect attributes

Returns:

the resulting view

Throws:

PaymentException

getWebResponseService

public abstract PaymentGatewayWebResponseService getWebResponseService()

getConfiguration

public abstract PaymentGatewayConfiguration getConfiguration()

getCustomerPaymentViewRedirect

public abstract String getCustomerPaymentViewRedirect(String customerPaymentId)

getCustomerPaymentErrorRedirect

public abstract String getCustomerPaymentErrorRedirect()

handleProcessingException

public abstract void handleProcessingException(Exception e,
                                               org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
                                        throws PaymentException

Throws:

PaymentException