com.broadleafcommerce.cartoperation.service.payment

Class DefaultPaymentTransactionService

java.lang.Object

com.broadleafcommerce.cartoperation.service.payment.DefaultPaymentTransactionService

All Implemented Interfaces:

PaymentTransactionService

public class DefaultPaymentTransactionService
extends Object
implements PaymentTransactionService

Author:

Chris Kittrell (ckittrell)

Constructor Summary

Constructors

Constructor and Description
DefaultPaymentTransactionService(CartProvider cartProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method and Description
org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction>	createPaymentTransaction(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType, @NonNull javax.money.MonetaryAmount amount, @NonNull String requestId, com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Creates a pending PaymentTransaction & saves it to the provided cart payment.
protected String	determineTransactionStatus(@NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response) Determines the new status of the PaymentTransaction based on the contents of the PaymentResponse
protected CartProvider	getCartProvider()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected boolean	isIndeterminateResult(@NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response) Determines whether or not the payment response represents an indeterminate result.
com.broadleafcommerce.cart.client.domain.Cart	recordTransactionResponse(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull com.broadleafcommerce.order.common.domain.PaymentTransaction transaction, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Interprets the payment gateway's PaymentResponse & records the results on the given Payment & PaymentTransaction.
protected boolean	shouldArchivePaymentDueToFailedTransaction(@NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response) Determines whether or not the Payment should be archived due to the failed transaction that is described by the provided PaymentResponse.
protected com.broadleafcommerce.order.common.domain.Payment	updatePaymentForAuthAndCaptureTransaction(@NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response, @NonNull String requestId) Based on the results of the payment gateway authorize and capture transaction, update the payment.
protected com.broadleafcommerce.order.common.domain.Payment	updatePaymentForAuthTransaction(@NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response, @NonNull String requestId) Based on the results of the payment gateway authorize transaction, update the payment.
protected void	validateTransactionAmount(@NonNull com.broadleafcommerce.order.common.domain.Payment payment, @NonNull javax.money.MonetaryAmount transactionAmount) Validate that the transaction amount is not greater than the payment amount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.cartoperation.service.payment.PaymentTransactionService

createPaymentTransaction, createPaymentTransaction

Constructor Detail

DefaultPaymentTransactionService

public DefaultPaymentTransactionService(CartProvider cartProvider,
                                        com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

createPaymentTransaction

public org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction> createPaymentTransaction(@NonNull
                                                                                                                                                                                                                                    @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                                                                                                                                                                    @NonNull
                                                                                                                                                                                                                                    @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                                                                                                                                                                    @NonNull
                                                                                                                                                                                                                                    @NonNull com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType,
                                                                                                                                                                                                                                    @NonNull
                                                                                                                                                                                                                                    @NonNull javax.money.MonetaryAmount amount,
                                                                                                                                                                                                                                    @NonNull
                                                                                                                                                                                                                                    @NonNull String requestId,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionService

Creates a pending PaymentTransaction & saves it to the provided cart payment. This transaction is meant to record our intention to send a request to the payment gateway & it creates a PaymentTransaction.getTransactionReferenceId() which would also be passed to the gateway so that they two can be linked.

Specified by:

createPaymentTransaction in interface PaymentTransactionService

Parameters:

cart - the owning cart

payment - The payment that should own this transaction

transactionType - The type of transaction that should be created

amount - The monetary amount related to this transaction

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

parentTransaction - A related transaction that this created transaction should link to

contextInfo - Context information around sandbox and multitenant state.

Returns:

The updated/created cart, payment, & paymentTransaction

recordTransactionResponse

public com.broadleafcommerce.cart.client.domain.Cart recordTransactionResponse(@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 transaction,
                                                                               @NonNull
                                                                               @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response,
                                                                               @Nullable
                                                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionService

Interprets the payment gateway's PaymentResponse & records the results on the given Payment & PaymentTransaction. Note: if the transaction failed, then the payment should also be archived so that it can no longer contribute to a successful checkout

Specified by:

recordTransactionResponse in interface PaymentTransactionService

Parameters:

cart - the owning cart

payment - the payment that we intended to authorize

transaction - the transaction that is to hold the results of the transaction

response - the payment gateway's response to our authorization attempt

contextInfo - Context information around sandbox and multitenant state.

Returns:

the updated cart, including the authorization results

validateTransactionAmount

protected void validateTransactionAmount(@NonNull
                                         @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                         @NonNull
                                         @NonNull javax.money.MonetaryAmount transactionAmount)

Validate that the transaction amount is not greater than the payment amount

Parameters:

payment - The transaction's related payment

transactionAmount - The transaction amount

determineTransactionStatus

protected String determineTransactionStatus(@NonNull
                                            @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response)

Determines the new status of the PaymentTransaction based on the contents of the PaymentResponse

Parameters:

response - the payment gateway's response to the executed transaction

Returns:

the new status of the PaymentTransaction based on the contents of the PaymentResponse

updatePaymentForAuthTransaction

protected com.broadleafcommerce.order.common.domain.Payment updatePaymentForAuthTransaction(@NonNull
                                                                                            @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                            @NonNull
                                                                                            @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response,
                                                                                            @NonNull
                                                                                            @NonNull String requestId)

Based on the results of the payment gateway authorize transaction, update the payment.

Parameters:

payment - the payment that is to be updated based on the authorize

response - the payment gateway's response to the authorize transaction

requestId - the id used to identify changes tied to the specific execution request

Returns:

the updated payment

updatePaymentForAuthAndCaptureTransaction

protected com.broadleafcommerce.order.common.domain.Payment updatePaymentForAuthAndCaptureTransaction(@NonNull
                                                                                                      @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                                      @NonNull
                                                                                                      @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response,
                                                                                                      @NonNull
                                                                                                      @NonNull String requestId)

Based on the results of the payment gateway authorize and capture transaction, update the payment.

Parameters:

payment - the payment that is to be updated based on the authorize

response - the payment gateway's response to the authorize transaction

requestId - the id used to identify changes tied to the specific execution request

Returns:

the updated payment

shouldArchivePaymentDueToFailedTransaction

protected boolean shouldArchivePaymentDueToFailedTransaction(@NonNull
                                                             @NonNull com.broadleafcommerce.order.common.domain.Payment payment,
                                                             @NonNull
                                                             @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response)

Determines whether or not the Payment should be archived due to the failed transaction that is described by the provided PaymentResponse. Note: Archiving the payment declares that it can no longer contribute to a successful checkout.

Parameters:

payment - the payment that may be archived based on the results of this method

response - the result of the executed transaction

Returns:

whether or not the payment should be archived due to the failed transaction

isIndeterminateResult

protected boolean isIndeterminateResult(@NonNull
                                        @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentResponse response)

Determines whether or not the payment response represents an indeterminate result.

For example, if a network error occurred, it we won't know if the transaction was completed or not on the gateway side of things.

Parameters:

response - the payment gateway's response to the executed transaction

Returns:

whether the response yielded an indeterminate payment response or not

getCartProvider

protected CartProvider getCartProvider()

getTypeFactory

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