Package com.broadleafcommerce.paymenttransaction.service.utils

Class DefaultTransactionExecutionUtil

java.lang.Object

com.broadleafcommerce.paymenttransaction.service.utils.DefaultTransactionExecutionUtil

All Implemented Interfaces:

TransactionExecutionUtil

public class DefaultTransactionExecutionUtil
extends Object
implements TransactionExecutionUtil

Constructor Summary

Constructors

Constructor	Description
DefaultTransactionExecutionUtil(PaymentSummaryService paymentSummaryService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
TransactionExecutionDetail	buildTransactionExecutionDetail(Payment payment, @NonNull PaymentTransaction transaction, com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)	Builds a TransactionExecutionDetail based on the provided TransactionExecutionRequest and PaymentTransaction.
TransactionExecutionResponse	buildTransactionExecutionResponse(@NonNull TransactionExecutionRequest request, @NonNull List<TransactionExecutionDetail> transactionExecutionDetails, Payment payment)	Builds a TransactionExecutionResponse based on the given TransactionExecutionDetails and Payment.
TransactionExecutionResponse	buildTransactionExecutionResponse(Payment payment, @NonNull PaymentTransaction transaction, com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)	Builds a TransactionExecutionResponse based on the provided Payment, and PaymentTransaction.
protected TransactionWithExecutableAmount	buildTransactionWithExecutableAmount(PaymentTransaction parentTransaction, List<PaymentTransaction> transactions)	Builds a TransactionWithExecutableAmount based on the given PaymentTransaction.
List<TransactionWithExecutableAmount>	getParentTransactionWithExecutableAmounts(@NonNull Payment payment, @NonNull TransactionExecutionRequest request)	Gets a list of TransactionWithExecutableAmounts representing the parent transactions of the given TransactionExecutionRequest.
protected PaymentSummaryService	getPaymentSummaryService()
protected javax.money.MonetaryAmount	getTransactionExecutableAmount(@NonNull PaymentTransaction parentTransaction, @NonNull List<PaymentTransaction> transactions)	Gets the executable amount for the given PaymentTransaction, which is the PaymentTransaction.getAmount() - reversed amount from all the child reversing transactions.
protected List<TransactionWithExecutableAmount>	getTransactionWithExecutableAmounts(@NonNull Payment payment, @NonNull TransactionExecutionRequest request)	Gathers a list of TransactionWithExecutableAmount objects based on the provided TransactionExecutionRequest.
protected List<TransactionWithExecutableAmount>	getTransactionWithExecutableAmountsByParentTransactionId(@NonNull Payment payment, @NonNull TransactionExecutionRequest request)	Gathers a single-item list of TransactionWithExecutableAmount objects based on the provided TransactionExecutionRequest.getParentTransactionId().
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected boolean	isReverseTransaction(PaymentTransaction transaction, PaymentTransaction maybeReverseTransaction)	Determines if the second PaymentTransaction is a reverse of the first PaymentTransaction.
protected boolean	isSubsequentTransaction(PaymentTransaction transaction, PaymentTransaction maybeSubsequentTransaction)	Determines if the second PaymentTransaction is a subsequent of the first PaymentTransaction.
protected boolean	isTransactionParentSourceEntity(@NonNull PaymentTransaction transaction, @NonNull TransactionExecutionRequest request)	Deprecated, for removal: This API element is subject to removal in a future version. this method is not used anymore

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.paymenttransaction.service.utils.TransactionExecutionUtil

buildTransactionExecutionResponse, buildTransactionExecutionResponse

Constructor Details

DefaultTransactionExecutionUtil

public DefaultTransactionExecutionUtil(PaymentSummaryService paymentSummaryService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

buildTransactionExecutionResponse

public TransactionExecutionResponse buildTransactionExecutionResponse(@NonNull
 @NonNull TransactionExecutionRequest request,
 @NonNull
 @NonNull List<TransactionExecutionDetail> transactionExecutionDetails,
 @Nullable
 Payment payment)

Description copied from interface: TransactionExecutionUtil

Builds a TransactionExecutionResponse based on the given TransactionExecutionDetails and Payment.

This is used when multiple transactions were executed for a single TransactionExecutionRequest, which can happen when the TransactionExecutionRequest.getTransactionType() requires one or more proceeding parent transactions to act against, such as DefaultTransactionTypes.REFUND.

For example, let's say we have 2 capture transactions, one for $10 and one for $5, and the TransactionExecutionRequest wants to execute a refund for $15. In this case, one refund transaction is needed for each parent capture transaction to cover the whole $15, one refund for $10 and one for $5.

Note that out-of-box, the scenario of having multiple parent transactions is very unlikely and not expected, however it is supported.

Specified by:

buildTransactionExecutionResponse in interface TransactionExecutionUtil

Parameters:

request - the TransactionExecutionRequest describing the desired details of the execution

transactionExecutionDetails - a list of TransactionExecutionDetails that were executed

payment - the related Payment that the transactions acted against

Returns:

a TransactionExecutionResponse based on the given TransactionExecutionDetails and Payment

buildTransactionExecutionDetail

public TransactionExecutionDetail buildTransactionExecutionDetail(@Nullable
 Payment payment,
 @NonNull
 @NonNull PaymentTransaction transaction,
 @Nullable
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)

Description copied from interface: TransactionExecutionUtil

Builds a TransactionExecutionDetail based on the provided TransactionExecutionRequest and PaymentTransaction.

Specified by:

buildTransactionExecutionDetail in interface TransactionExecutionUtil

Parameters:

payment - The related Payment that the transactions acted against.

transaction - The transaction that was executed.

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

Returns:

A TransactionExecutionDetail based on the provided TransactionExecutionRequest and PaymentTransaction

buildTransactionExecutionResponse

public TransactionExecutionResponse buildTransactionExecutionResponse(@Nullable
 Payment payment,
 @NonNull
 @NonNull PaymentTransaction transaction,
 @Nullable
 com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse)

Description copied from interface: TransactionExecutionUtil

Builds a TransactionExecutionResponse based on the provided Payment, and PaymentTransaction.

Specified by:

buildTransactionExecutionResponse in interface TransactionExecutionUtil

Parameters:

payment - The related Payment that the request will act against.

transaction - The transaction that was executed.

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

Returns:

A TransactionExecutionResponse based on the provided Payment, and PaymentTransaction

getParentTransactionWithExecutableAmounts

public List<TransactionWithExecutableAmount> getParentTransactionWithExecutableAmounts(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull TransactionExecutionRequest request)

Description copied from interface: TransactionExecutionUtil

Gets a list of TransactionWithExecutableAmounts representing the parent transactions of the given TransactionExecutionRequest.

This is used when the TransactionExecutionRequest.getTransactionType() requires one or more proceeding parent transactions to act against. For example, if the request is for DefaultTransactionTypes.REFUND, this will retrieve all the non-fully-reversed parent transactions, such as capture, etc.

Note that out-of-box, the scenario of having multiple parent transactions is very unlikely and not expected, however it is supported.

Specified by:

getParentTransactionWithExecutableAmounts in interface TransactionExecutionUtil

Parameters:

payment - the Payment to look for the transaction from.

Returns:

a list of TransactionWithExecutableAmounts representing the parent transactions of the given TransactionExecutionRequest

getTransactionWithExecutableAmountsByParentTransactionId

protected List<TransactionWithExecutableAmount> getTransactionWithExecutableAmountsByParentTransactionId(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull TransactionExecutionRequest request)

Gathers a single-item list of TransactionWithExecutableAmount objects based on the provided TransactionExecutionRequest.getParentTransactionId().

Parameters:

payment - The Payment that owns the parent transaction.

request - A TransactionExecutionRequest describing a transaction that is to be executed.

Returns:

A single-item list of TransactionWithExecutableAmount objects based on the provided TransactionExecutionRequest.getParentTransactionId().

getTransactionWithExecutableAmounts

protected List<TransactionWithExecutableAmount> getTransactionWithExecutableAmounts(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull TransactionExecutionRequest request)

Gathers a list of TransactionWithExecutableAmount objects based on the provided TransactionExecutionRequest. If provided in the request, transactions will be identified by TransactionExecutionRequest.getParentSourceEntityType(), TransactionExecutionRequest.getParentSourceEntityId(), and transaction type. Otherwise, parent transactions will be identified by transaction type based on the provided TransactionExecutionRequest.getTransactionType().

Parameters:

payment - The Payment that owns the parent transactions.

request - A TransactionExecutionRequest describing a transaction that is to be executed.

Returns:

A list of TransactionWithExecutableAmount objects based on the provided TransactionExecutionRequest.

buildTransactionWithExecutableAmount

protected TransactionWithExecutableAmount buildTransactionWithExecutableAmount(PaymentTransaction parentTransaction,
 List<PaymentTransaction> transactions)

Builds a TransactionWithExecutableAmount based on the given PaymentTransaction.

Parameters:

parentTransaction - the PaymentTransaction to build the TransactionWithExecutableAmount for

transactions - a list of transactions that may contain the child reversing transactions of the given transaction

Returns:

a TransactionWithExecutableAmount based on the given PaymentTransaction

isTransactionParentSourceEntity

@Deprecated(since="1.0.6",
            forRemoval=true)
protected boolean isTransactionParentSourceEntity(@NonNull
 @NonNull PaymentTransaction transaction,
 @NonNull
 @NonNull TransactionExecutionRequest request)

Deprecated, for removal: This API element is subject to removal in a future version.

this method is not used anymore

If the given TransactionExecutionRequest.getParentSourceEntityType() and TransactionExecutionRequest.getParentSourceEntityId() are provided, determines if the given PaymentTransaction is a parent transaction matching those properties. Returns true by default if not provided.

Parameters:

transaction - the PaymentTransaction to check against

request - the TransactionExecutionRequest to check with

Returns:

whether the given PaymentTransaction is a parent transaction matching the given request's parentSourceEntityType and parentSourceEntityId if provided. Returns true by default if not provided

getTransactionExecutableAmount

protected javax.money.MonetaryAmount getTransactionExecutableAmount(@NonNull
 @NonNull PaymentTransaction parentTransaction,
 @NonNull
 @NonNull List<PaymentTransaction> transactions)

Gets the executable amount for the given PaymentTransaction, which is the PaymentTransaction.getAmount() - reversed amount from all the child reversing transactions.

For example, if the given transaction is an authorize transaction, it will find existing child reverse authorize transactions and calculates the actual executable amount. Note that any reverse authorize transactions that are not a child of this authorize transaction is not accounted.

Parameters:

parentTransaction - the PaymentTransaction to calculate the executable amount for

transactions - the other transactions that may contain the children transactions

Returns:

the executable amount for the given PaymentTransaction

isReverseTransaction

protected boolean isReverseTransaction(PaymentTransaction transaction,
 PaymentTransaction maybeReverseTransaction)

Determines if the second PaymentTransaction is a reverse of the first PaymentTransaction.

Parameters:

transaction - the transaction to check for

maybeReverseTransaction - the transaction to check if it's a reversing transaction for the first transaction

Returns:

the second PaymentTransaction is a reverse of the first PaymentTransaction, otherwise false

isSubsequentTransaction

protected boolean isSubsequentTransaction(PaymentTransaction transaction,
 PaymentTransaction maybeSubsequentTransaction)

Determines if the second PaymentTransaction is a subsequent of the first PaymentTransaction.

Parameters:

transaction - the transaction to check for

maybeSubsequentTransaction - the transaction to check if it's a subsequent transaction for the first transaction

Returns:

the second PaymentTransaction is a reverse of the first PaymentTransaction, otherwise false

getPaymentSummaryService

protected PaymentSummaryService getPaymentSummaryService()

getTypeFactory

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