Package com.broadleafcommerce.cartoperation.service.checkout.workflow.activity

Class PaymentTransactionExecutionActivity

  • All Implemented Interfaces:
    CheckoutWorkflowActivity, RequiresSecurePaymentInformationActivity
    public class PaymentTransactionExecutionActivity
extends Object
implements RequiresSecurePaymentInformationActivity
    This CheckoutWorkflowActivity is responsible for executing payment transactions that are required to complete a successful checkout. This is where we strongly suggest that you execute payment transactions due to the amount of control & visibility that it provides. With that being said, if transactions were executed prior to entering the CheckoutWorkflow, then this activity doesn't have any work to do. Alternatively, if you wish to process the payment transactions at a later time, then it can be done by skipping the transaction execution in this activity. We strongly suggest that this is the last activity in your CheckoutWorkflow to eliminate the need to reverse successful authorization transactions for carts with a single payment method. If the cart includes multiple payments that are to be authorized within the checkout workflow, then this activity ordering will not avoid the need to reverse an authorization. In that case, there's a chance that one of the payments will be successfully authorized & then must be reversed if one of the other payments fails authorization.
    Author:
    Chris Kittrell (ckittrell)

    • Constructor Detail

      • PaymentTransactionExecutionActivity

        public PaymentTransactionExecutionActivity​(PaymentTransactionExecutionService transactionExecutionService,
                                           org.springframework.context.MessageSource messageSource)

    • Method Detail

      • execute

        public com.broadleafcommerce.cart.client.domain.Cart execute​(@NonNull
                                                             @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                             @NonNull
                                                             @NonNull String requestId,
                                                             @NonNull
                                                             @NonNull Map<String,​String> paymentLockTokens,
                                                             @NonNull
                                                             @NonNull Map<String,​String> securityCodes,
                                                             @Nullable
                                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Description copied from interface: RequiresSecurePaymentInformationActivity
        Method responsible for executing some work against the cart that requires secure payment information in checkout.
        Specified by:
        execute in interface RequiresSecurePaymentInformationActivity
        Parameters:
        cart - The Cart that we're attempting to checkout with.
        requestId - The id used to identify changes tied to the specific execution request
        paymentLockTokens - Tokens that grant this service access to act upon the payment. The presence of these tokens indicates that this execution flow owns the lock.
        securityCodes - Secure codes that are passed to the gateway for verification during authorization or capture transactions.
        contextInfo - Context information around sandbox and multitenant state.
        Returns:
        The final state of the cart following the execution of the activity.

      • rollback

        public com.broadleafcommerce.cart.client.domain.Cart rollback​(@NonNull
                                                              @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                              @NonNull
                                                              @NonNull String requestId,
                                                              @Nullable
                                                              com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Description copied from interface: CheckoutWorkflowActivity
        Method responsible for rolling back any work that was done during the execution of the #execute(Cart, String) method.
        Specified by:
        rollback in interface CheckoutWorkflowActivity
        Parameters:
        cart - The Cart that we were attempting to checkout with, but ran into an exception/error.
        requestId - The id used to identify changes tied to the specific execution request
        contextInfo - Context information around sandbox and multitenant state.
        Returns:
        The final state of the cart following the rollback of the activity.

      • getMessage

        protected String getMessage​(@NonNull
                            @NonNull String errorMessage,
                            @Nullable
                            Object... args)

      • getMessageSource

        protected org.springframework.context.MessageSource getMessageSource()