Package org.broadleafcommerce.vendor.paypal.web.controller

Class BroadleafPayPalCheckoutController

java.lang.Object
org.broadleafcommerce.common.web.controller.BroadleafAbstractController
org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController
org.broadleafcommerce.vendor.paypal.web.controller.BroadleafPayPalCheckoutController
@Controller("blPayPalCheckoutController") @RequestMapping("/paypal-checkout") public class BroadleafPayPalCheckoutController extends org.broadleafcommerce.common.web.payment.controller.PaymentGatewayAbstractController
Author:
Elbert Bautista (elbertbautista)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    GATEWAY_CONTEXT_KEY
     
    protected org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration
    paymentGatewayConfiguration
     
    protected org.broadleafcommerce.common.payment.service.PaymentGatewayHostedService
    paymentGatewayHostedService
     
    protected org.broadleafcommerce.common.payment.service.PaymentGatewayWebResponseService
    paymentGatewayWebResponseService
     
    protected PayPalPaymentService
    paymentService
     

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    BroadleafPayPalCheckoutController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    cancelEndpoint(org.springframework.ui.Model model, jakarta.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, Map<String,String> pathVars)
     
    String
    completeCheckout()
    Completes checkout for a PayPal Order.
    Map<String,String>
    createOrder(Boolean performCheckout)
     
    String
    createOrderHostedJson(jakarta.servlet.http.HttpServletRequest request, Boolean performCheckout)
     
    String
    errorEndpoint(org.springframework.ui.Model model, jakarta.servlet.http.HttpServletRequest request, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectAttributes, Map<String,String> pathVars)
     
    protected String
    getApprovalLink(com.paypal.orders.Order order)
     
    org.broadleafcommerce.common.payment.service.PaymentGatewayConfiguration
    getConfiguration()
     
    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
    returnEndpoint(org.springframework.ui.Model model, jakarta.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, getCartReqAttributeNotProvidedMessage, 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 Details

    • GATEWAY_CONTEXT_KEY

      protected static final String GATEWAY_CONTEXT_KEY
      See Also:

    • paymentGatewayWebResponseService

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

    • paymentGatewayHostedService

      protected org.broadleafcommerce.common.payment.service.PaymentGatewayHostedService paymentGatewayHostedService

    • paymentGatewayConfiguration

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

    • paymentService

      protected PayPalPaymentService paymentService

  • Constructor Details

    • BroadleafPayPalCheckoutController

      public BroadleafPayPalCheckoutController()

  • Method Details

    • 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, jakarta.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, jakarta.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, jakarta.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

    • completeCheckout

      @RequestMapping(value="/checkout/complete", method=POST) public String completeCheckout() throws org.broadleafcommerce.common.vendor.service.exception.PaymentException
      Completes checkout for a PayPal Order. If there's already a PayPal Order we go ahead and make sure the details of the Order are updated to all of the forms filled out by the customer since they could've updated shipping information, added a promotion, or other various things to the order.
      Returns:
      Redirect URL to either add the order and checkout or just checkout
      Throws:
      org.broadleafcommerce.common.vendor.service.exception.PaymentException

    • createOrder

      @RequestMapping(value="/create-order", method=POST) @ResponseBody public Map<String,String> createOrder(@RequestParam("performCheckout") Boolean performCheckout) throws org.broadleafcommerce.common.vendor.service.exception.PaymentException
      Throws:
      org.broadleafcommerce.common.vendor.service.exception.PaymentException

    • createOrderHostedJson

      @RequestMapping(value="/hosted/create-order", method=POST) public String createOrderHostedJson(jakarta.servlet.http.HttpServletRequest request, @RequestParam("performCheckout") Boolean performCheckout) throws org.broadleafcommerce.common.vendor.service.exception.PaymentException
      Throws:
      org.broadleafcommerce.common.vendor.service.exception.PaymentException

    • getApprovalLink

      protected String getApprovalLink(com.paypal.orders.Order order)