com.broadleafcommerce.cartoperation.service.payment

Class DefaultPaymentConfirmationService

java.lang.Object

com.broadleafcommerce.cartoperation.service.payment.DefaultPaymentConfirmationService

All Implemented Interfaces:

PaymentConfirmationService

public class DefaultPaymentConfirmationService
extends Object
implements PaymentConfirmationService

This service is meant to coordinate the confirmation (and possible rollback) of a cart's payments in the context of a checkout submission.

Author:

Chris Kittrell (ckittrell)

Constructor Summary

Constructors

Constructor and Description

DefaultPaymentConfirmationService(com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayTransactionServiceProvider transactionServiceProvider, com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayConfigurationProvider configurationProvider, com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayRollbackServiceProvider rollbackServiceProvider, PaymentTransactionService paymentTransactionService, PaymentRequestService paymentRequestService, CartPaymentStatusService paymentStatusService, PaymentSummaryService paymentSummaryService, CartProvider cartProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method and Description
protected com.broadleafcommerce.cart.client.domain.Cart	authorizeAndCapturePayment(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction
protected com.broadleafcommerce.cart.client.domain.Cart	authorizeAndCapturePayment(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull String requestId, String securityCode, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction
protected com.broadleafcommerce.cart.client.domain.Cart	authorizePayment(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction
protected com.broadleafcommerce.cart.client.domain.Cart	authorizePayment(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull String requestId, String securityCode, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction
com.broadleafcommerce.cart.client.domain.Cart	confirmCartPayments(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Intended to confirm all unconfirmed, active payments related to the provided Cart.
com.broadleafcommerce.cart.client.domain.Cart	confirmCartPayments(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, @NonNull Map<String,String> securityCodes, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Intended to confirm all unconfirmed, active payments related to the provided Cart.
protected CartProvider	getCartProvider()
protected String	getCheckoutTransactionType(@NonNull String gatewayType) Based on the provided PaymentGatewayType, determine which TransactionType should be used to execute the payment stage of the checkout.
protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayConfigurationProvider	getConfigurationProvider()
protected List<com.broadleafcommerce.order.common.domain.Payment>	getConfirmedPayments(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart) Identifies all of the cart's authorized payments that could potentially be rolled back
List<com.broadleafcommerce.order.common.domain.Payment>	getConfirmedPaymentsToRollback(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId) Gather confirmed payments that have a successful transactions tied to the provided requestId
protected PaymentRequestService	getPaymentRequestService()
protected CartPaymentStatusService	getPaymentStatusService()
protected PaymentSummaryService	getPaymentSummaryService()
protected PaymentTransactionService	getPaymentTransactionService()
protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayRollbackServiceProvider	getRollbackServiceProvider()
protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayTransactionServiceProvider	getTransactionServiceProvider()
protected List<com.broadleafcommerce.order.common.domain.PaymentTransaction>	getTransactionsToRollback(@NonNull com.broadleafcommerce.order.common.domain.Payment confirmedPayment, @NonNull String requestId) Gathers the successful authorization transactions that are related to the provided requestId.
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected com.broadleafcommerce.paymentgateway.service.PaymentGatewayRollbackService	identifyRollbackService(@NonNull com.broadleafcommerce.order.common.domain.Payment payment) Identifies the relevant PaymentGatewayRollbackService based on the payment's Payment.getGatewayType()
protected com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService	identifyTransactionService(@NonNull com.broadleafcommerce.order.common.domain.Payment payment) Identifies the relevant PaymentGatewayTransactionService based on the payment's Payment.getGatewayType()
com.broadleafcommerce.cart.client.domain.Cart	rollbackConfirmedPayments(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Intended to roll back all authorized, active payments related to the provided Cart.
protected com.broadleafcommerce.cart.client.domain.Cart	rollbackSuccessfulAuthTransaction(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction, @NonNull String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Rolls back any successful authorization transactions by interacting with the relevant payment gateway to void/cancel the authorization and records the result of the reverse-auth transaction on the cart as a PaymentTransaction.
protected boolean	shouldConfirmPayment(com.broadleafcommerce.order.common.domain.Payment payment) Determine whether to confirm this payment.
protected List<com.broadleafcommerce.order.common.domain.Payment>	sortPayments(List<com.broadleafcommerce.order.common.domain.Payment> payments) Hook used to order the cart's payments to produce the most favorable conditions when executing transactions against the payment.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPaymentConfirmationService

public DefaultPaymentConfirmationService(com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayTransactionServiceProvider transactionServiceProvider,
                                         com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayConfigurationProvider configurationProvider,
                                         com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayRollbackServiceProvider rollbackServiceProvider,
                                         PaymentTransactionService paymentTransactionService,
                                         PaymentRequestService paymentRequestService,
                                         CartPaymentStatusService paymentStatusService,
                                         PaymentSummaryService paymentSummaryService,
                                         CartProvider cartProvider,
                                         com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

confirmCartPayments

public com.broadleafcommerce.cart.client.domain.Cart confirmCartPayments(@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: PaymentConfirmationService

Intended to confirm all unconfirmed, active payments related to the provided Cart. Ultimately the confirmation of each unconfirmed payment should lead to a payment gateway transaction (usually an DefaultTransactionTypes.AUTHORIZE transaction) & the recording of a PaymentTransaction on the cart.

Specified by:

confirmCartPayments in interface PaymentConfirmationService

Parameters:

cart - the cart that owns the list of payments

requestId - the id representing the customer's request to confirm their payments

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart with confirmed payments

confirmCartPayments

public com.broadleafcommerce.cart.client.domain.Cart confirmCartPayments(@NonNull
                                                                         @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                         @NonNull
                                                                         @NonNull String requestId,
                                                                         @NonNull
                                                                         @NonNull Map<String,String> securityCodes,
                                                                         @Nullable
                                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentConfirmationService

Intended to confirm all unconfirmed, active payments related to the provided Cart. Ultimately the confirmation of each unconfirmed payment should lead to a payment gateway transaction (usually an DefaultTransactionTypes.AUTHORIZE transaction) & the recording of a PaymentTransaction on the cart.

Specified by:

confirmCartPayments in interface PaymentConfirmationService

Parameters:

cart - the cart that owns the list of payments

requestId - the id representing the customer's request to confirm their payments

securityCodes - The map of card security codes keyed by payment id for processing saved payments

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart with confirmed payments

getConfirmedPaymentsToRollback

public List<com.broadleafcommerce.order.common.domain.Payment> getConfirmedPaymentsToRollback(@NonNull
                                                                                              @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                              @NonNull
                                                                                              @NonNull String requestId)

Description copied from interface: PaymentConfirmationService

Gather confirmed payments that have a successful transactions tied to the provided requestId

Specified by:

getConfirmedPaymentsToRollback in interface PaymentConfirmationService

Parameters:

cart - The cart whose checkout submission is being processed

requestId - the unique identifier of this checkout attempt

Returns:

the list of confirmed payments that have a successful transactions tied to the provided requestId

rollbackConfirmedPayments

public com.broadleafcommerce.cart.client.domain.Cart rollbackConfirmedPayments(@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: PaymentConfirmationService

Intended to roll back all authorized, active payments related to the provided Cart. The rollback of each authorized payment should lead to a DefaultTransactionTypes.REVERSE_AUTH payment gateway transaction & an updating of the relevant PaymentTransaction to have a unconfirmed status.

Specified by:

rollbackConfirmedPayments in interface PaymentConfirmationService

Parameters:

cart - the cart that owns the list of payments that are to be rolled back

requestId - the id representing the customer's request to confirm their payments

contextInfo - Context information around sandbox and multitenant state.

Returns:

The cart with rolled back payments

sortPayments

protected List<com.broadleafcommerce.order.common.domain.Payment> sortPayments(List<com.broadleafcommerce.order.common.domain.Payment> payments)

Hook used to order the cart's payments to produce the most favorable conditions when executing transactions against the payment. This is primarily meant to help mitigate the challenges of multi-payment scenarios. For example, if you have a payment method whose transactions are very challenging to roll back (in the case of a checkout failure), then it's best to order that payment last. If the PaymentConfirmationActivity is the last activity in the workflow and the payment with the challenging rollback is processed last, then the rollback will actually never occur. Instead, either this payment's transaction will pass and the checkout completes, or the transaction fails and only previously completed work may need to be rolled back.

Parameters:

payments - The un-ordered list of cart payments

Returns:

The sorted list of cart payments

getCheckoutTransactionType

protected String getCheckoutTransactionType(@NonNull
                                            @NonNull String gatewayType)

Based on the provided PaymentGatewayType, determine which TransactionType should be used to execute the payment stage of the checkout.

Parameters:

gatewayType - The payment gateway's unique identifier that should be used to lookup the desired transaction type

Returns:

The desired transaction type for the gateway

See Also:

PaymentGatewayConfiguration.getCheckoutTransactionType()

authorizeAndCapturePayment

protected com.broadleafcommerce.cart.client.domain.Cart authorizeAndCapturePayment(@NonNull
                                                                                   @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                   @NonNull
                                                                                   @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                   @NonNull
                                                                                   @NonNull String requestId,
                                                                                   @Nullable
                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction

Parameters:

cart - the payment's owning cart

payment - the payment to be authorized

requestId - the id representing the customer's request to confirm their payments

Returns:

the updated cart which includes a Payment & PaymentTransaction which represent the transaction results

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if an error is encountered while executing the authorization

authorizeAndCapturePayment

protected com.broadleafcommerce.cart.client.domain.Cart authorizeAndCapturePayment(@NonNull
                                                                                   @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                   @NonNull
                                                                                   @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                   @NonNull
                                                                                   @NonNull String requestId,
                                                                                   @Nullable
                                                                                   String securityCode,
                                                                                   @Nullable
                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction

Parameters:

cart - the payment's owning cart

payment - the payment to be authorized

requestId - the id representing the customer's request to confirm their payments

securityCode - payment method security code that may be required to execute the transaction

Returns:

the updated cart which includes a Payment & PaymentTransaction which represent the transaction results

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if an error is encountered while executing the authorization

shouldConfirmPayment

protected boolean shouldConfirmPayment(com.broadleafcommerce.order.common.domain.Payment payment)

Determine whether to confirm this payment.

Parameters:

payment - the payment to confirm

Returns:

true if this payment should be confirmed, false otherwise

authorizePayment

protected com.broadleafcommerce.cart.client.domain.Cart authorizePayment(@NonNull
                                                                         @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                         @NonNull
                                                                         @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                         @NonNull
                                                                         @NonNull String requestId,
                                                                         @Nullable
                                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction

Parameters:

cart - the payment's owning cart

payment - the payment to be authorized

requestId - the id representing the customer's request to confirm their payments

Returns:

the updated cart which includes a Payment & PaymentTransaction which represent the transaction results

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if an error is encountered while executing the authorization

authorizePayment

protected com.broadleafcommerce.cart.client.domain.Cart authorizePayment(@NonNull
                                                                         @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                         @NonNull
                                                                         @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                         @NonNull
                                                                         @NonNull String requestId,
                                                                         @Nullable
                                                                         String securityCode,
                                                                         @Nullable
                                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Communicates with the relevant payment gateway, executing an authorization transaction for the provided payment & records the results on the cart in the form of a PaymentTransaction

Parameters:

cart - the payment's owning cart

payment - the payment to be authorized

requestId - the id representing the customer's request to confirm their payments

securityCode - payment method security code that may be required to execute the transaction

Returns:

the updated cart which includes a Payment & PaymentTransaction which represent the transaction results

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if an error is encountered while executing the authorization

identifyTransactionService

protected com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService identifyTransactionService(@NonNull
                                                                                                                   @NonNull com.broadleafcommerce.order.common.domain.Payment payment)

Identifies the relevant PaymentGatewayTransactionService based on the payment's Payment.getGatewayType()

Parameters:

payment - the payment object that contains a reference to the required transaction service

Returns:

the identified PaymentGatewayTransactionService

getConfirmedPayments

protected List<com.broadleafcommerce.order.common.domain.Payment> getConfirmedPayments(@NonNull
                                                                                       @NonNull com.broadleafcommerce.cart.client.domain.Cart cart)

Identifies all of the cart's authorized payments that could potentially be rolled back

Parameters:

cart - The cart whose checkout submission is being processed

Returns:

the cart's authorized payments

getTransactionsToRollback

protected List<com.broadleafcommerce.order.common.domain.PaymentTransaction> getTransactionsToRollback(@NonNull
                                                                                                       @NonNull com.broadleafcommerce.order.common.domain.Payment confirmedPayment,
                                                                                                       @NonNull
                                                                                                       @NonNull String requestId)

Gathers the successful authorization transactions that are related to the provided requestId. This should represent the full set of payment transactions that were successfully completed during this attempt to checkout.

Parameters:

confirmedPayment - a confirmed payment that likely owns a transaction tied to this checkout request

requestId - the unique identifier of this checkout attempt

Returns:

The list of successful authorization transactions that are related to the provided requestId.

rollbackSuccessfulAuthTransaction

protected com.broadleafcommerce.cart.client.domain.Cart rollbackSuccessfulAuthTransaction(@NonNull
                                                                                          @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                          @NonNull
                                                                                          @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                          @NonNull
                                                                                          @NonNull com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction,
                                                                                          @NonNull
                                                                                          @NonNull String requestId,
                                                                                          @Nullable
                                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Rolls back any successful authorization transactions by interacting with the relevant payment gateway to void/cancel the authorization and records the result of the reverse-auth transaction on the cart as a PaymentTransaction.

Parameters:

cart - The cart whose checkout submission is being processed

payment - The payment that was previously authorized as a part of this checkout submission

parentTransaction - The transaction that is being rolled back

requestId - the unique identifier of this checkout attempt

Returns:

The updated cart which includes a DefaultTransactionTypes.REVERSE_AUTH PaymentTransaction

identifyRollbackService

protected com.broadleafcommerce.paymentgateway.service.PaymentGatewayRollbackService identifyRollbackService(@NonNull
                                                                                                             @NonNull com.broadleafcommerce.order.common.domain.Payment payment)

Identifies the relevant PaymentGatewayRollbackService based on the payment's Payment.getGatewayType()

Parameters:

payment - the payment object that contains a reference to the required transaction rollback service

Returns:

the identified PaymentGatewayRollbackService

getTransactionServiceProvider

protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayTransactionServiceProvider getTransactionServiceProvider()

getConfigurationProvider

protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayConfigurationProvider getConfigurationProvider()

getRollbackServiceProvider

protected com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayRollbackServiceProvider getRollbackServiceProvider()

getPaymentTransactionService

protected PaymentTransactionService getPaymentTransactionService()

getPaymentRequestService

protected PaymentRequestService getPaymentRequestService()

getPaymentStatusService

protected CartPaymentStatusService getPaymentStatusService()

getPaymentSummaryService

protected PaymentSummaryService getPaymentSummaryService()

getCartProvider

protected CartProvider getCartProvider()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()