Package com.broadleafcommerce.billing.job.service.impl

Class DefaultPaymentTransactionExecutionService<P extends BillingProcessingRequest>

java.lang.Object

com.broadleafcommerce.billing.job.service.impl.DefaultPaymentTransactionExecutionService<P>

All Implemented Interfaces:

PaymentTransactionExecutionService<P>

public class DefaultPaymentTransactionExecutionService<P extends BillingProcessingRequest>
extends Object
implements PaymentTransactionExecutionService<P>

Default implementation of the PaymentTransactionExecutionService that's used to communicate with Broadleaf's PaymentTransactionServices to execute AuthorizeAndCapture and/or Refund transactions.

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_BILLING_ATTEMPT_NUMBER

Constructor Summary

Constructors

Constructor	Description
DefaultPaymentTransactionExecutionService(PaymentTransactionExecutionProvider transactionExecutionProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected void	addNullableTransactionAdditionalField(@NonNull PaymentAccountProcessingRequest accountProcessingRequest, @NonNull String key, String value, boolean transactionWasSuccessful)	Add a transactionAdditionalField while handling null safety.
P	authorizeAndCapture(P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes an AuthorizeAndCapture (aka Charge) transaction based on the provided BillingProcessingRequest
protected SavedPaymentMethodTransactionExecutionRequest	buildAuthorizeAndCaptureRequest(P request)
protected TransactionExecutionRequest	buildRefundRequest(P request)
protected PaymentFailureTypeEnum	getFailureType(@NonNull TransactionExecutionResponse response)
protected String	getPaymentId(P request)
protected String	getPaymentVersion(P request)
protected PaymentAccountProcessingResultEnum	getProcessingResult(TransactionExecutionResponse response)
protected PaymentTransactionExecutionProvider	getTransactionExecutionProvider()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected boolean	isEligibleForGatewayErrorRetries(P request, TransactionExecutionResponse response)	Hook point used to declare if gateway errors are eligible for automatic retries.
P	lookupAndRecordTransactionResults(@NonNull PaymentTransactionDetail paymentTransactionDetail, P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Looks up transaction results for the provided PaymentTransactionDetail, & if present, stores the transaction results on the BillingProcessingRequest.currentAccountProcessingRequest()
protected Optional<TransactionExecutionResponse>	lookupTransactionResults(@NonNull PaymentTransactionDetail paymentTransactionDetail, P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected P	recordResultOnRequest(P request, @NonNull TransactionExecutionResponse response)
P	refund(P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Executes a Refund transaction based on the provided BillingProcessingRequest
protected void	updateAccountProcessingRequestWithResults(@NonNull PaymentAccountProcessingRequest accountProcessingRequest, P request, @NonNull TransactionExecutionResponse response)
protected P	updateBillingProcessingRequestWithTransactionResults(P request, @NonNull TransactionExecutionResponse response)

Methods inherited from class java.lang.Object

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

Field Details

CURRENT_BILLING_ATTEMPT_NUMBER

public static final String CURRENT_BILLING_ATTEMPT_NUMBER

See Also:

• Constant Field Values

Constructor Details

DefaultPaymentTransactionExecutionService

public DefaultPaymentTransactionExecutionService(PaymentTransactionExecutionProvider transactionExecutionProvider,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

authorizeAndCapture

public P authorizeAndCapture(@NonNull
 P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionExecutionService

Executes an AuthorizeAndCapture (aka Charge) transaction based on the provided BillingProcessingRequest

Specified by:

authorizeAndCapture in interface PaymentTransactionExecutionService<P extends BillingProcessingRequest>

Parameters:

request - the BillingProcessingRequest describing the payment method & amount to be charged

contextInfo - context information around multi-tenant state

Returns:

The BillingProcessingRequest that includes details about the transaction result populated in the fields of BillingProcessingRequest.currentAccountProcessingRequest()

refund

public P refund(@NonNull
 P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionExecutionService

Executes a Refund transaction based on the provided BillingProcessingRequest

Specified by:

refund in interface PaymentTransactionExecutionService<P extends BillingProcessingRequest>

Parameters:

request - the BillingProcessingRequest describing the payment method & amount to be refunded

contextInfo - context information around multi-tenant state

Returns:

The BillingProcessingRequest that includes details about the transaction result populated in the fields of BillingProcessingRequest.currentAccountProcessingRequest()

lookupAndRecordTransactionResults

public P lookupAndRecordTransactionResults(@NonNull
 @NonNull PaymentTransactionDetail paymentTransactionDetail,
 @NonNull
 P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentTransactionExecutionService

Looks up transaction results for the provided PaymentTransactionDetail, & if present, stores the transaction results on the BillingProcessingRequest.currentAccountProcessingRequest()

Specified by:

lookupAndRecordTransactionResults in interface PaymentTransactionExecutionService<P extends BillingProcessingRequest>

Parameters:

paymentTransactionDetail - The transaction whose result is unknown, & therefore needs to be looked up

request - the BillingProcessingRequest describing the payment method & amount that was expected to be charged or refunded

contextInfo - context information around multi-tenant state

Returns:

The BillingProcessingRequest that includes details about the transaction result populated in the fields of BillingProcessingRequest.currentAccountProcessingRequest(), if the transaction results are found

lookupTransactionResults

protected Optional<TransactionExecutionResponse> lookupTransactionResults(@NonNull
 @NonNull PaymentTransactionDetail paymentTransactionDetail,
 @NonNull
 P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

updateBillingProcessingRequestWithTransactionResults

protected P updateBillingProcessingRequestWithTransactionResults(@NonNull
 P request,
 @NonNull
 @NonNull TransactionExecutionResponse response)

buildAuthorizeAndCaptureRequest

protected SavedPaymentMethodTransactionExecutionRequest buildAuthorizeAndCaptureRequest(@NonNull
 P request)

getPaymentId

protected String getPaymentId(@NonNull
 P request)

getPaymentVersion

protected String getPaymentVersion(@NonNull
 P request)

buildRefundRequest

protected TransactionExecutionRequest buildRefundRequest(@NonNull
 P request)

recordResultOnRequest

protected P recordResultOnRequest(@NonNull
 P request,
 @NonNull
 @NonNull TransactionExecutionResponse response)

getFailureType

@Nullable
protected PaymentFailureTypeEnum getFailureType(@NonNull
 @NonNull TransactionExecutionResponse response)

addNullableTransactionAdditionalField

protected void addNullableTransactionAdditionalField(@NonNull
 @NonNull PaymentAccountProcessingRequest accountProcessingRequest,
 @NonNull
 @NonNull String key,
 @Nullable
 String value,
 boolean transactionWasSuccessful)

Add a transactionAdditionalField while handling null safety. If the `transactionWasSuccessful` boolean is set to `true`, an error will be logged since a successful transaction should not have required fields as `null`. If on the other hand a field that is not required needs to be inserted safely with this method, a `false` value should be passed in instead.

updateAccountProcessingRequestWithResults

protected void updateAccountProcessingRequestWithResults(@NonNull
 @NonNull PaymentAccountProcessingRequest accountProcessingRequest,
 @NonNull
 P request,
 @NonNull
 @NonNull TransactionExecutionResponse response)

isEligibleForGatewayErrorRetries

protected boolean isEligibleForGatewayErrorRetries(P request,
 TransactionExecutionResponse response)

Hook point used to declare if gateway errors are eligible for automatic retries.

Parameters:

request - The BillingProcessingRequest

response - The TransactionExecutionResponse describing the transaction result.

Returns:

If gateway errors are eligible for automatic retries.

getProcessingResult

protected PaymentAccountProcessingResultEnum getProcessingResult(TransactionExecutionResponse response)

getTransactionExecutionProvider

protected PaymentTransactionExecutionProvider getTransactionExecutionProvider()

getTypeFactory

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