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

Class DefaultPaymentProcessingService<P extends BillingProcessingRequest>

java.lang.Object

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

All Implemented Interfaces:

PaymentProcessingService<P>

public class DefaultPaymentProcessingService<P extends BillingProcessingRequest>
extends Object
implements PaymentProcessingService<P>

Field Summary

Fields

Modifier and Type	Field	Description
protected BillingJobProperties	billingJobProperties
protected BillingProcessRequestService<P,BillingProcessingRequestWithFullDetails>	bprService
protected DeadLetterMessageSender	deadLetterMessageSender
protected PaymentProcessingResultHandlerService<P,PaymentTransactionDetail>	handlerService
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected PaymentTransactionDetailService<PaymentTransactionDetail>	paymentTransactionDetailService
protected Map<PaymentAccountProcessingResultEnum,ProcessingResultEnum>	resultConversionMap
protected PaymentTransactionExecutionService<P>	transactionExecutionService
protected com.broadleafcommerce.common.extension.TypeFactory	typeFactory

Constructor Summary

Constructors

Constructor	Description
DefaultPaymentProcessingService()

Method Summary

Modifier and Type	Method	Description
protected P	callProcessorAndSaveResult(P request, PaymentTransactionDetail transactionDetail, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	createFailurePaymentAccountProcessingRequest(P billingProcessingRequest, String failureReason)
protected void	ensureNoActiveTransaction()
protected String	getBillingEventPaymentId(P processingRequest, PaymentAccountProcessingRequest accountRequest)
protected PaymentAccountProcessingResultEnum	getProcessingResult(TransactionExecutionResponse response)
protected void	handleAlreadyProcessed(P request, List<P> sendToResultHandler, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	handleExistingTransactionDetail(P request, List<P> sendToResultHandler, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected boolean	isEligibleForGatewayErrorRetries(P request)	Hook point used to declare if gateway errors are eligible for automatic retries.
protected String	nullablePaymentAccountId(P request)
protected void	populateAccountWithException(PaymentAccountProcessingRequest account, Exception e)
protected void	processPayment(P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	This method calls the payment processor implementation to process the request.
List<P>	processPayments(String paymentGatewayType, List<P> requests, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	For each request in the list, verifies that this is the first attempt to process the transaction by persisting a new PaymentTransactionDetail.
protected P	processTransactionResults(P processingRequest, @NonNull PaymentAccountProcessingRequest paymentAccountProcessingRequest, @NonNull String transactionId, @NonNull PaymentTransactionDetail paymentTransactionDetail, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<P>	resolveUnknownPaymentGatewayResponses(List<P> requests, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Resolves unknown gateway responses by looking up the results from the processor.
protected Optional<PaymentTransactionDetail>	saveNewPaymentTransactionDetailBeforeSendingToProcessor(P processingRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	sendBPRToDeadLetterQueue(P bpr, String errorMessage, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected String	serializeObject(PaymentTransactionDetail transactionDetail)
protected String	serializeObject(BillingProcessingRequest request)
protected boolean	shouldCallProcessorIfTransactionNotFound(P request)
protected boolean	transactionResultsNotFound(PaymentAccountProcessingRequest accountProcessingRequest)
protected void	updateTransactionDetailWithProcessingResult(P request, PaymentTransactionDetail detail, ProcessingResultEnum result)

Methods inherited from class java.lang.Object

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

Field Details

resultConversionMap

protected Map<PaymentAccountProcessingResultEnum,ProcessingResultEnum> resultConversionMap

bprService

@Autowired
protected BillingProcessRequestService<P extends BillingProcessingRequest,BillingProcessingRequestWithFullDetails> bprService

paymentTransactionDetailService

@Autowired
protected PaymentTransactionDetailService<PaymentTransactionDetail> paymentTransactionDetailService

transactionExecutionService

@Autowired
protected PaymentTransactionExecutionService<P extends BillingProcessingRequest> transactionExecutionService

handlerService

@Autowired
protected PaymentProcessingResultHandlerService<P extends BillingProcessingRequest,PaymentTransactionDetail> handlerService

billingJobProperties

@Autowired
protected BillingJobProperties billingJobProperties

deadLetterMessageSender

@Autowired(required=false)
protected DeadLetterMessageSender deadLetterMessageSender

objectMapper

@Autowired
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

typeFactory

@Autowired
protected com.broadleafcommerce.common.extension.TypeFactory typeFactory

Constructor Details

DefaultPaymentProcessingService

public DefaultPaymentProcessingService()

Method Details

processPayments

public List<P> processPayments(String paymentGatewayType,
 List<P> requests,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentProcessingService

For each request in the list, verifies that this is the first attempt to process the transaction by persisting a new PaymentTransactionDetail. If a transaction has not been attempted before, calls the PaymentTransactionExecutionService and saves the result on the request.

If this transaction has been attempted before, in certain circumstances resends the request to the next stage.

Specified by:

processPayments in interface PaymentProcessingService<P extends BillingProcessingRequest>

Parameters:

paymentGatewayType - type of gateway to execute the payment

requests - the list of billing processing requests describing the payment methods & amounts to be charged

contextInfo - context information around multi-tenant state

Returns:

The list of billing processing requests that should be sent to PaymentProcessingResultHandlerService

resolveUnknownPaymentGatewayResponses

public List<P> resolveUnknownPaymentGatewayResponses(List<P> requests,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: PaymentProcessingService

Resolves unknown gateway responses by looking up the results from the processor. If the processor is not aware of the transaction, uses BillingJobProperties.paymentGatewayConfig configuration to decide whether to attempt retrying the transaction.

Specified by:

resolveUnknownPaymentGatewayResponses in interface PaymentProcessingService<P extends BillingProcessingRequest>

Parameters:

requests - the list of billing processing requests describing the payment methods & billing attempts that are missing gateway responses

contextInfo - context information around multi-tenant state

Returns:

The list of updated billing processing requests that should be sent to PaymentProcessingResultHandlerService

ensureNoActiveTransaction

protected void ensureNoActiveTransaction()

callProcessorAndSaveResult

protected P callProcessorAndSaveResult(P request,
 PaymentTransactionDetail transactionDetail,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

processPayment

protected void processPayment(P request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

This method calls the payment processor implementation to process the request. It then reacts to its return value, as well as any exceptions that it may throw, to fill out the PaymentAccountProcessingRequest.

isEligibleForGatewayErrorRetries

protected boolean isEligibleForGatewayErrorRetries(P request)

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

Parameters:

request - The BillingProcessingRequest

createFailurePaymentAccountProcessingRequest

protected void createFailurePaymentAccountProcessingRequest(P billingProcessingRequest,
 String failureReason)

nullablePaymentAccountId

@Nullable
protected String nullablePaymentAccountId(P request)

populateAccountWithException

protected void populateAccountWithException(PaymentAccountProcessingRequest account,
 Exception e)

handleExistingTransactionDetail

protected void handleExistingTransactionDetail(P request,
 List<P> sendToResultHandler,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

sendBPRToDeadLetterQueue

protected void sendBPRToDeadLetterQueue(P bpr,
 String errorMessage,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

handleAlreadyProcessed

protected void handleAlreadyProcessed(P request,
 List<P> sendToResultHandler,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

saveNewPaymentTransactionDetailBeforeSendingToProcessor

protected Optional<PaymentTransactionDetail> saveNewPaymentTransactionDetailBeforeSendingToProcessor(P processingRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getBillingEventPaymentId

protected String getBillingEventPaymentId(P processingRequest,
 PaymentAccountProcessingRequest accountRequest)

updateTransactionDetailWithProcessingResult

protected void updateTransactionDetailWithProcessingResult(P request,
 PaymentTransactionDetail detail,
 ProcessingResultEnum result)

processTransactionResults

@Nullable
protected P processTransactionResults(@NonNull
 P processingRequest,
 @NonNull
 @NonNull PaymentAccountProcessingRequest paymentAccountProcessingRequest,
 @NonNull
 @NonNull String transactionId,
 @NonNull
 @NonNull PaymentTransactionDetail paymentTransactionDetail,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

transactionResultsNotFound

protected boolean transactionResultsNotFound(PaymentAccountProcessingRequest accountProcessingRequest)

shouldCallProcessorIfTransactionNotFound

protected boolean shouldCallProcessorIfTransactionNotFound(P request)

getProcessingResult

protected PaymentAccountProcessingResultEnum getProcessingResult(TransactionExecutionResponse response)

serializeObject

protected String serializeObject(BillingProcessingRequest request)

serializeObject

protected String serializeObject(PaymentTransactionDetail transactionDetail)