Package com.broadleafcommerce.orderoperation.service.payment

Class DefaultPaymentAuthReversalService

java.lang.Object

com.broadleafcommerce.orderoperation.service.payment.DefaultPaymentAuthReversalService

All Implemented Interfaces:

PaymentAuthReversalService

public class DefaultPaymentAuthReversalService
extends Object
implements PaymentAuthReversalService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultPaymentAuthReversalService.PaymentReversalPackage	An intermediary data structure used internally by DefaultPaymentAuthReversalService to keep track of a reverse authorize that will be executed.

Constructor Summary

Constructors

Constructor	Description
DefaultPaymentAuthReversalService(OrderProvider<com.broadleafcommerce.order.client.domain.Order> orderProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory, PaymentProvider paymentProvider)

Method Summary

Modifier and Type	Method	Description
protected DefaultPaymentAuthReversalService.PaymentReversalPackage	buildPaymentReversalPackage(PaymentSummary paymentSummary)	Builds a DefaultPaymentAuthReversalService.PaymentReversalPackage for the PaymentSummary that has amount to reverse authorize.
protected List<DefaultPaymentAuthReversalService.PaymentReversalPackage>	buildPaymentReversalPackages(com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds PaymentReversalPackages for all payments which have only been authorized, not captured.
protected OrderProvider<com.broadleafcommerce.order.client.domain.Order>	getOrderProvider()
protected List<String>	getPaymentIds(List<DefaultPaymentAuthReversalService.PaymentReversalPackage> reversalPackages)	Gets a list of payment ids from the given list of PaymentReversalPackages.
protected PaymentPriorityStrategy	getPaymentPriorityStrategy()
protected PaymentProvider	getPaymentProvider()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	processReversalPackage(DefaultPaymentAuthReversalService.PaymentReversalPackage reversePackage, List<TransactionExecutionResponse> reverseResponses, Map<String,String> paymentLockTokens, com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Processes the given DefaultPaymentAuthReversalService.PaymentReversalPackage.
protected TransactionExecutionResponse	reverseAuthorizePayment(DefaultPaymentAuthReversalService.PaymentReversalPackage reversePackage, @NonNull String lockToken, com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes the reverse authorize transaction for the given DefaultPaymentAuthReversalService.PaymentReversalPackage using getPaymentProvider().
protected List<TransactionExecutionResponse>	reverseAuthorizePayments(List<DefaultPaymentAuthReversalService.PaymentReversalPackage> reversePackages, com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Given a list of PaymentReversalPackages, executes the reverse authorize transactions using getPaymentProvider().
List<TransactionExecutionResponse>	reverseRemainingAuthAmounts(com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes reverse authorization(s) for all payments on the Order which are authorized but not captured.
void	setPaymentPriorityStrategy(PaymentPriorityStrategy paymentPriorityStrategy)
protected boolean	shouldSkipReversals(List<DefaultPaymentAuthReversalService.PaymentReversalPackage> reversePackages, com.broadleafcommerce.order.client.domain.Order order)	Determines whether the reverse authorization process should be skipped.
protected List<PaymentSummary>	sortPaymentsByPriority(List<PaymentSummary> paymentSummaries)	Deprecated. since 1.7.2, in favor of sortPaymentsByPriority(List, ContextInfo)
protected List<PaymentSummary>	sortPaymentsByPriority(List<PaymentSummary> paymentSummaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Given a list of PaymentSummaries, sorts them in order of which should be reverse authorized first.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPaymentAuthReversalService

public DefaultPaymentAuthReversalService(OrderProvider<com.broadleafcommerce.order.client.domain.Order> orderProvider,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 PaymentProvider paymentProvider)

Method Details

reverseRemainingAuthAmounts

public List<TransactionExecutionResponse> reverseRemainingAuthAmounts(com.broadleafcommerce.order.client.domain.Order order,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentAuthReversalService

Executes reverse authorization(s) for all payments on the Order which are authorized but not captured.

Specified by:

reverseRemainingAuthAmounts in interface PaymentAuthReversalService

Parameters:

order - the order for which authorized payments should be reversed

contextInfo - context information surrounding multitenant state

Returns:

the TransactionExecutionResponses for all the reverse authorize transactions

buildPaymentReversalPackages

protected List<DefaultPaymentAuthReversalService.PaymentReversalPackage> buildPaymentReversalPackages(com.broadleafcommerce.order.client.domain.Order order,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds PaymentReversalPackages for all payments which have only been authorized, not captured.

Only packages representing positive amounts (> $0.00) are constructed and returned; zero-dollar allocations are skipped.

Parameters:

order - the order containing payments to reverse authorize

Returns:

a list of all PaymentReversalPackages to reverse authorize all order payments which have only been authorized, not captured

sortPaymentsByPriority

protected List<PaymentSummary> sortPaymentsByPriority(List<PaymentSummary> paymentSummaries,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Given a list of PaymentSummaries, sorts them in order of which should be reverse authorized first.

By default, the payments are returned as-is. Reverse authorize transactions are typically executed against an entire order for the remaining authorized amount, so the priorities don't necessarily matter.

Any custom logic for reverse authorize payment priority should be added here.

Parameters:

paymentSummaries - the list of PaymentSummaries to sort based on reverse authorize priority

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

a new list representing the sorted result

sortPaymentsByPriority

@Deprecated
protected List<PaymentSummary> sortPaymentsByPriority(List<PaymentSummary> paymentSummaries)

Deprecated.

since 1.7.2, in favor of sortPaymentsByPriority(List, ContextInfo)

Given a list of PaymentSummaries, sorts them in order of which should be reverse authorized first. By default, the same list is returned.

Any custom logic for reverse authorize payment priority should be added here.

Parameters:

paymentSummaries - the list of PaymentSummaries to sort based on reverse authorize priority

Returns:

a new list representing the sorted result

buildPaymentReversalPackage

protected DefaultPaymentAuthReversalService.PaymentReversalPackage buildPaymentReversalPackage(PaymentSummary paymentSummary)

Builds a DefaultPaymentAuthReversalService.PaymentReversalPackage for the PaymentSummary that has amount to reverse authorize.

Parameters:

paymentSummary - the PaymentSummary to build a DefaultPaymentAuthReversalService.PaymentReversalPackage for

Returns:

a DefaultPaymentAuthReversalService.PaymentReversalPackage for the PaymentSummary that has amount to reverse authorize

reverseAuthorizePayments

protected List<TransactionExecutionResponse> reverseAuthorizePayments(List<DefaultPaymentAuthReversalService.PaymentReversalPackage> reversePackages,
 com.broadleafcommerce.order.client.domain.Order order,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Given a list of PaymentReversalPackages, executes the reverse authorize transactions using getPaymentProvider().

Returns the responses for each reverse authorize transaction.

Parameters:

reversePackages - a list of payment reverse packages whose reversal transactions need to be executed

order - the order to reverse authorize the payments for

contextInfo - context information surrounding multitenant state

Returns:

the reverse authorize execution responses after executing all reverse authorizations

Throws:

PaymentTransactionFailureException - if any of the transactions were not successfully executed

shouldSkipReversals

protected boolean shouldSkipReversals(List<DefaultPaymentAuthReversalService.PaymentReversalPackage> reversePackages,
 com.broadleafcommerce.order.client.domain.Order order)

Determines whether the reverse authorization process should be skipped.

Reversals are skipped if there are no reversal packages to process, or if the total sum of the reversal amounts across all packages is equal to zero. This prevents unnecessary locking of payments and avoids sending invalid zero-dollar reverse authorization transactions to downstream payment gateways.

Parameters:

reversePackages - the list of DefaultPaymentAuthReversalService.PaymentReversalPackages to evaluate

order - the Order for which this reversal operation is being performed

Returns:

true if the reversal process should be skipped, false otherwise

getPaymentIds

protected List<String> getPaymentIds(List<DefaultPaymentAuthReversalService.PaymentReversalPackage> reversalPackages)

Gets a list of payment ids from the given list of PaymentReversalPackages.

Parameters:

reversalPackages - a list of PaymentReversalPackages to get the payment ids from

Returns:

a list of payment ids

processReversalPackage

protected void processReversalPackage(DefaultPaymentAuthReversalService.PaymentReversalPackage reversePackage,
 List<TransactionExecutionResponse> reverseResponses,
 Map<String,String> paymentLockTokens,
 com.broadleafcommerce.order.client.domain.Order order,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Processes the given DefaultPaymentAuthReversalService.PaymentReversalPackage.

Parameters:

reversePackage - the DefaultPaymentAuthReversalService.PaymentReversalPackage to process

reverseResponses - the list of TransactionExecutionResponses containing all the responses

paymentLockTokens - the list of payment lock tokens

order - the Order for this payment reversal

contextInfo - context information surrounding multitenant state

reverseAuthorizePayment

protected TransactionExecutionResponse reverseAuthorizePayment(DefaultPaymentAuthReversalService.PaymentReversalPackage reversePackage,
 @NonNull
 @NonNull String lockToken,
 com.broadleafcommerce.order.client.domain.Order order,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Executes the reverse authorize transaction for the given DefaultPaymentAuthReversalService.PaymentReversalPackage using getPaymentProvider().

Parameters:

reversePackage - the DefaultPaymentAuthReversalService.PaymentReversalPackage to execute the reverse authorize transaction for

lockToken - the token that owns the payment lock

order - the Order that this reverse authorization is for

contextInfo - context information surrounding multitenant state

Returns:

the TransactionExecutionResponse for the reverse authorize transaction.

getOrderProvider

protected OrderProvider<com.broadleafcommerce.order.client.domain.Order> getOrderProvider()

getTypeFactory

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

getPaymentProvider

protected PaymentProvider getPaymentProvider()

getPaymentPriorityStrategy

protected PaymentPriorityStrategy getPaymentPriorityStrategy()

setPaymentPriorityStrategy

@Autowired
public void setPaymentPriorityStrategy(PaymentPriorityStrategy paymentPriorityStrategy)