Package com.broadleafcommerce.orderoperation.service.payment

Class DefaultPaymentCaptureService

java.lang.Object

com.broadleafcommerce.orderoperation.service.payment.DefaultPaymentCaptureService

All Implemented Interfaces:

PaymentCaptureService

public class DefaultPaymentCaptureService
extends Object
implements PaymentCaptureService

Constructor Summary

Constructors

Constructor	Description
DefaultPaymentCaptureService(PaymentProvider paymentProvider)

Method Summary

Modifier and Type	Method	Description
protected TransactionExecutionResponse	captureAmount(@NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment, @NonNull PaymentSummary paymentSummary, @NonNull String lockToken, @NonNull javax.money.MonetaryAmount amountToCapture, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Captures the amount specified against the provided payment.
List<TransactionExecutionResponse>	captureFulfillment(@NonNull javax.money.MonetaryAmount totalToCapture, @NonNull com.broadleafcommerce.order.client.domain.Order order, @NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Responsible for capturing an amount from the Order's payments
protected javax.money.MonetaryAmount	getAmountAvailableForCapture(@NonNull PaymentSummary payment)	Determines the amount that can be captured for this payment
protected javax.money.MonetaryAmount	getAmountToCapture(@NonNull PaymentSummary payment, @NonNull javax.money.MonetaryAmount remainingToCapture)	Based on the payment & the remaining to capture, return the amount that should be captured for this payment
protected List<String>	getPaymentIds(List<org.springframework.data.util.Pair<PaymentSummary,javax.money.MonetaryAmount>> amountToCapturePerPayment)	Gets a list of payment ids from the given list of amounts to capture per payment.
protected PaymentPriorityStrategy	getPaymentPriorityStrategy()
protected PaymentProvider	getPaymentProvider()
protected List<PaymentSummary>	getPaymentsWithAmountAvailableForCapture(@NonNull com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Identifies the order's payments that have some amount that is available to be captured.
protected List<org.springframework.data.util.Pair<PaymentSummary,javax.money.MonetaryAmount>>	identifyAmountToCapturePerPayment(@NonNull com.broadleafcommerce.order.client.domain.Order order, @NonNull javax.money.MonetaryAmount totalToCapture, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determine how the total to capture should be distributed among the order's payments.
void	setPaymentPriorityStrategy(PaymentPriorityStrategy paymentPriorityStrategy)
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 captured first.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.orderoperation.service.payment.PaymentCaptureService

captureFulfillmentTotal

Constructor Detail

DefaultPaymentCaptureService

public DefaultPaymentCaptureService(PaymentProvider paymentProvider)

Method Detail

captureFulfillment

public List<TransactionExecutionResponse> captureFulfillment(@NonNull
                                                             @NonNull javax.money.MonetaryAmount totalToCapture,
                                                             @NonNull
                                                             @NonNull com.broadleafcommerce.order.client.domain.Order order,
                                                             @NonNull
                                                             @NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment,
                                                             @Nullable
                                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentCaptureService

Responsible for capturing an amount from the Order's payments

Specified by:

captureFulfillment in interface PaymentCaptureService

Parameters:

totalToCapture - The amount to capture for the OrderFulfillment

order - The order whose payments should be used to captured the specified amount

fulfillment - The fulfillment to capture payment for

contextInfo - Context information around sandbox and multitenant state.

Returns:

the TransactionExecutionResponses for all the capture transactions

identifyAmountToCapturePerPayment

protected List<org.springframework.data.util.Pair<PaymentSummary,javax.money.MonetaryAmount>> identifyAmountToCapturePerPayment(@NonNull
                                                                                                                                      @NonNull com.broadleafcommerce.order.client.domain.Order order,
                                                                                                                                      @NonNull
                                                                                                                                      @NonNull javax.money.MonetaryAmount totalToCapture,
                                                                                                                                      @Nullable
                                                                                                                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determine how the total to capture should be distributed among the order's payments.

Parameters:

order - The order whose payments should be captured

totalToCapture - The total that should be captured for the order

contextInfo - Context information around sandbox and multitenant state.

Returns:

a list of Pair containers holding an authorized payment and the amount that should be captured against that payment

Throws:

PaymentCaptureException - if the order's payments can't cover the requested total to capture

getPaymentsWithAmountAvailableForCapture

protected List<PaymentSummary> getPaymentsWithAmountAvailableForCapture(@NonNull
                                                                        @NonNull com.broadleafcommerce.order.client.domain.Order order,
                                                                        @Nullable
                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Identifies the order's payments that have some amount that is available to be captured.

Parameters:

order - The order whose payments should be captured

contextInfo - Context information around sandbox and multitenant state.

Returns:

The payment summaries that have some amount that is available to be 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 captured first.

Any custom logic for capture payment priority should be added here.

Parameters:

paymentSummaries - the list of PaymentSummaries to sort based on capture 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 captured first. By default, the same list is returned.

Any custom logic for capture payment priority should be added here.

Parameters:

paymentSummaries - the list of PaymentSummaries to sort based on capture priority

Returns:

a new list representing the sorted result

getAmountToCapture

protected javax.money.MonetaryAmount getAmountToCapture(@NonNull
                                                        @NonNull PaymentSummary payment,
                                                        @NonNull
                                                        @NonNull javax.money.MonetaryAmount remainingToCapture)

Based on the payment & the remaining to capture, return the amount that should be captured for this payment

Parameters:

payment - The authorized payment that we're considering for capture

remainingToCapture - The remaining total for the order that should be captured

Returns:

The amount that should be captured for this payment

getAmountAvailableForCapture

protected javax.money.MonetaryAmount getAmountAvailableForCapture(@NonNull
                                                                  @NonNull PaymentSummary payment)

Determines the amount that can be captured for this payment

Parameters:

payment - The authorized payment that is a candidate for capture

Returns:

The payment's amount that is available for capture

getPaymentIds

protected List<String> getPaymentIds(List<org.springframework.data.util.Pair<PaymentSummary,javax.money.MonetaryAmount>> amountToCapturePerPayment)

Gets a list of payment ids from the given list of amounts to capture per payment.

Parameters:

amountToCapturePerPayment - a list of Pair containers holding an authorized payment and the amount that should be captured against that payment

Returns:

a list of payment ids

captureAmount

protected TransactionExecutionResponse captureAmount(@NonNull
                                                     @NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment,
                                                     @NonNull
                                                     @NonNull PaymentSummary paymentSummary,
                                                     @NonNull
                                                     @NonNull String lockToken,
                                                     @NonNull
                                                     @NonNull javax.money.MonetaryAmount amountToCapture,
                                                     @Nullable
                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Captures the amount specified against the provided payment.

If one of the TransactionExecutionDetails in the TransactionExecutionResponse failed, a PaymentTransactionFailureException is thrown.

Parameters:

fulfillment - The fulfillment to capture payment for

paymentSummary - The payment that is being captured

lockToken - the token that owns the payment lock

amountToCapture - The amount that should be captured against the provided authorize transaction

contextInfo - Context information around sandbox and multitenant state.

Returns:

The TransactionExecutionResponse of the capture transaction

Throws:

PaymentTransactionFailureException - if one of the capture transactions fails

getPaymentProvider

protected PaymentProvider getPaymentProvider()

getPaymentPriorityStrategy

protected PaymentPriorityStrategy getPaymentPriorityStrategy()

setPaymentPriorityStrategy

@Autowired
public void setPaymentPriorityStrategy(PaymentPriorityStrategy paymentPriorityStrategy)