org.broadleafcommerce.vendor.paypal.web.controller

Class BroadleafPayPalExpressController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

org.broadleafcommerce.vendor.paypal.web.controller.BroadleafPayPalExpressController

@Controller(value="blPayPalExpressController")
@RequestMapping(value="/paypal-express")
public class BroadleafPayPalExpressController
extends org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	GATEWAY_CONTEXT_KEY
protected static org.apache.commons.logging.Log	LOG
protected org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration	paymentGatewayConfiguration
protected org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService	paymentGatewayWebResponseService

Fields inherited from class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

baseCartRedirect, baseConfirmationRedirect, baseErrorView, baseOrderReviewRedirect, baseRedirect, PAYMENT_PROCESSING_ERROR, paymentGatewayCheckoutService, processingErrorMessage, webResponsePrintService

Constructor Summary

Constructors

Constructor and Description
BroadleafPayPalExpressController()

Method Summary

Methods

Modifier and Type	Method and Description
String	cancelEndpoint(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, Map<String,String> pathVars)
String	errorEndpoint(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, Map<String,String> pathVars)
org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration	getConfiguration()
org.broadleafcommerce.common.payment.dto.PaymentRequestDTO	getDTOFromCartState() Stub implementation that is meant to be overriden by a custom controller.
String	getGatewayContextKey()
org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService	getWebResponseService()
void	handleProcessingException(Exception e, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
void	handleUnsuccessfulTransaction(org.springframework.ui.Model model, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, org.broadleafcommerce.common.payment.dto.PaymentResponseDTO responseDTO)
String	redirectEndpoint(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request) Stub endpoint that can be used as an alternative to PayPalExpressCheckoutLinkProcessor Because these modules have no dependency on framework-web, custom implementations that wish to use this have to provide their own implementation to get the Order from the CartState.
String	returnEndpoint(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, Map<String,String> pathVars)

Methods inherited from class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

applyPaymentToOrder, getBaseConfirmationRedirect, getCartViewRedirect, getConfirmationViewRedirect, getErrorViewRedirect, getOrderReviewRedirect, getProcessingErrorMessage, initiateCheckout, lookupOrderNumberFromOrderId, process

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

GATEWAY_CONTEXT_KEY

protected static final String GATEWAY_CONTEXT_KEY

See Also:

Constant Field Values

paymentGatewayWebResponseService

protected org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService paymentGatewayWebResponseService

paymentGatewayConfiguration

protected org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration paymentGatewayConfiguration

Constructor Detail

BroadleafPayPalExpressController

public BroadleafPayPalExpressController()

Method Detail

handleProcessingException

public void handleProcessingException(Exception e,
                             org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes)
                               throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

handleProcessingException in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

handleUnsuccessfulTransaction

public void handleUnsuccessfulTransaction(org.springframework.ui.Model model,
                                 org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                 org.broadleafcommerce.common.payment.dto.PaymentResponseDTO responseDTO)
                                   throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

handleUnsuccessfulTransaction in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

getGatewayContextKey

public String getGatewayContextKey()

Specified by:

getGatewayContextKey in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

getWebResponseService

public org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService getWebResponseService()

Specified by:

getWebResponseService in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

getConfiguration

public org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration getConfiguration()

Specified by:

getConfiguration in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

returnEndpoint

@RequestMapping(value="/return",
                method=GET)
public String returnEndpoint(org.springframework.ui.Model model,
                                   javax.servlet.http.HttpServletRequest request,
                                   org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                   @PathVariable
                                   Map<String,String> pathVars)
                      throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

returnEndpoint in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

errorEndpoint

@RequestMapping(value="/error",
                method=GET)
public String errorEndpoint(org.springframework.ui.Model model,
                                  javax.servlet.http.HttpServletRequest request,
                                  org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                  @PathVariable
                                  Map<String,String> pathVars)
                     throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Specified by:

errorEndpoint in class org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

cancelEndpoint

@RequestMapping(value="/cancel",
                method=GET)
public String cancelEndpoint(org.springframework.ui.Model model,
                                   javax.servlet.http.HttpServletRequest request,
                                   org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes,
                                   @PathVariable
                                   Map<String,String> pathVars)
                      throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

redirectEndpoint

public String redirectEndpoint(org.springframework.ui.Model model,
                      javax.servlet.http.HttpServletRequest request)
                        throws org.broadleafcommerce.common.vendor.service.exception.PaymentException

Stub endpoint that can be used as an alternative to PayPalExpressCheckoutLinkProcessor Because these modules have no dependency on framework-web, custom implementations that wish to use this have to provide their own implementation to get the Order from the CartState. To use: extend, provide a request mapping, and implement the getDTOFromCartState() method.

Parameters:

model -

request -

Returns:

Throws:

org.broadleafcommerce.common.vendor.service.exception.PaymentException

getDTOFromCartState

public org.broadleafcommerce.common.payment.dto.PaymentRequestDTO getDTOFromCartState()

Stub implementation that is meant to be overriden by a custom controller. The modules have no dependency on Order or Cart, so this must be implemented if you wish to use the redirect mechanism in this controller instead of the Thymeleaf Processor.

Returns:

PaymentRequestDTO of the cart.