Package com.broadleafcommerce.billing.job.module

Class BillingProcessingRequestInitializer<P extends InitializeBillingProcessingRequests>

java.lang.Object

com.broadleafcommerce.billing.job.module.BillingProcessingRequestInitializer<P>

public class BillingProcessingRequestInitializer<P extends InitializeBillingProcessingRequests>
extends Object

Receives the newly generated billing processing requests and adds the required payment information for each request.

Field Summary

Fields

Modifier and Type	Field	Description
protected BillingEventAddressService<BillingEventAddress>	billingEventAddressService
protected BillingEventItemService<BillingEventItem,BillingEventItemWithTaxDetails>	billingEventItemService
protected BillingEventPaymentFinder<BillingEventPaymentWithEvent>	billingEventPaymentFinder
protected BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction>	billingEventPaymentService
protected BillingEventPricingService<BillingEventDTO,BillingEvent,BillingEventAdjustment,BillingEventItemWithTaxDetails,BillingEventPaymentWithTransaction>	billingEventPricingService
protected BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest>	billingEventService
protected BillingJobProperties	billingJobProperties
protected BillingProcessingRequestGenerator<BillingProcessingRequest>	billingProcessingRequestGenerator
protected BillingProcessRequestService<BillingProcessingRequest,BillingProcessingRequestWithFullDetails>	billingProcessRequestService
protected BillingRetryScheduleService<BillingRetrySchedule>	billingRetryScheduleService
protected RefundEventDetailService<RefundEventDetail,RefundDetailsWithRefundAndBillingEvent>	refundEventDetailService
protected BillingJobMessageSender	sender
protected com.broadleafcommerce.common.extension.TypeFactory	typeFactory
protected WalletService<WalletWithPaymentAccounts,BillingProcessingRequestWithFullDetails>	walletService

Constructor Summary

Constructors

Constructor	Description
BillingProcessingRequestInitializer()

Method Summary

Modifier and Type	Method	Description
protected BillingProcessingRequestWithBillingEventDTO	buildRequestWithBillingEventDTO(BillingProcessingRequest request, BillingProcessingRequestWithFullDetails requestWithFullDetails)	Builds a composite object from the BillingProcessingRequest and the related BillingEventDTO
protected PaymentAccountProcessingRequest	createPaymentAccountProcessingRequestForCharge(BillingProcessingRequestWithFullDetails billingProcessingRequestDetails, PaymentAccount paymentAccount)
protected PaymentAccountProcessingRequest	createPaymentAccountProcessingRequestForRefund(BillingProcessingRequestWithFullDetails billingProcessingRequestDetails)
protected List<BillingProcessingRequestWithFullDetails>	filterOutWrongStatuses(List<BillingProcessingRequestWithFullDetails> billingProcessingRequestWithFullDetails)
protected BillingEventAddress	getBillingEventAddress(PaymentAccount paymentAccount)
protected void	handleNoPaymentAccountsOnCharge(BillingProcessingRequest request, List<String> idsToSendToFinalizer)	Handles changes to the BillingProcessingRequest for CHARGE-type requests with no payment accounts
protected void	handleRequestForPaymentProcessor(BillingProcessingRequest request, List<BillingProcessingRequest> sendToPaymentProcessor)	Handles changes to a request to prepare for it being sent to a payment processor
protected String	hashTransactionReferenceID(String transactionReferenceId)	Some gateways only allow transaction reference ids shorter than 50 characters.
protected void	initializeRequests(List<BillingProcessingRequestWithFullDetails> requestsWithFullDetails, Map<String,WalletWithPaymentAccounts> walletsWithPaymentAccounts, List<BillingProcessingRequest> allInitializedRequests, List<String> idsToSendToFinalizer, List<BillingProcessingRequest> sendToPaymentProcessor, List<BillingProcessingRequestWithBillingEventDTO> sendToTaxHandler)	Handles initializing given requests and sorting them to their next destinations depending on their state and external configuration properties
protected boolean	isBillingAddressPresent(BillingEventDTO billingEventDTO)
protected boolean	isPaymentAborted(BillingProcessingRequestWithFullDetails requestDetails)
protected boolean	isTaxCalculated(BillingProcessingRequest billingProcessingRequest)
protected void	populateAccounts(BillingProcessingRequestWithFullDetails billingProcessingRequestDetails, List<PaymentAccount> paymentAccounts)
protected void	populateTransactionReferenceIds(BillingProcessingRequestWithFullDetails requestDetails)
protected void	prepareValidRequestsForNextSteps(BillingProcessingRequest request, BillingProcessingRequestWithFullDetails requestWithFullDetails, BillingProcessingRequestWithBillingEventDTO requestWithBillingEventDTO, List<PaymentAccount> activePaymentAccounts, List<BillingProcessingRequestWithBillingEventDTO> sendToTaxHandler, List<BillingProcessingRequest> sendToPaymentProcessor)	Handles preparing valid requests for their next step, either to be sent to a payment processor or a tax handler.
void	process(P request)	Deprecated. Use process(InitializeBillingProcessingRequests, ContextInfo) instead
void	process(P requestsToInitialize, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected List<BillingProcessingRequestWithFullDetails>	readRequestsWithFullDetailsInCorrectStatuses(P request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads requests with details for given ids and filters out those already processed or not in NEW status
protected Map<String,WalletWithPaymentAccounts>	readWalletsWithPaymentAccounts(List<BillingProcessingRequestWithFullDetails> requestsWithFullDetails, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads wallets for the provided requests.
protected boolean	requestShouldHaveAccountsButHasNone(BillingProcessingTransactionTypeEnum transactionType, List<PaymentAccount> activePaymentAccounts)	Checks whether a given request should have active payment accounts to effectively proceed, but has none instead.
protected List<PaymentAccount>	retrieveActiveAccounts(BillingProcessingRequest request, Map<String,WalletWithPaymentAccounts> walletsWithPaymentAccounts)	Retrieves active payment accounts for the given request
protected void	setAddressForTaxCalculationIfMissing(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO, List<PaymentAccount> activePaymentAccounts)	This method sets the billing address from a payment account onto the request for tax calculation if the request does not previously contain a billing address
protected void	setPaymentProcessingRequest(BillingProcessingRequestWithFullDetails requestWithFullDetails)	Build and set a PaymentAccountProcessingRequest in the BillingProcessingRequestWithFullDetails

Methods inherited from class java.lang.Object

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

Field Details

sender

@Autowired
protected BillingJobMessageSender sender

billingProcessRequestService

@Autowired
protected BillingProcessRequestService<BillingProcessingRequest,BillingProcessingRequestWithFullDetails> billingProcessRequestService

billingEventService

@Autowired
protected BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest> billingEventService

refundEventDetailService

@Autowired
protected RefundEventDetailService<RefundEventDetail,RefundDetailsWithRefundAndBillingEvent> refundEventDetailService

billingEventPaymentService

@Autowired
protected BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction> billingEventPaymentService

billingRetryScheduleService

@Autowired
protected BillingRetryScheduleService<BillingRetrySchedule> billingRetryScheduleService

billingJobProperties

@Autowired
protected BillingJobProperties billingJobProperties

billingEventPricingService

@Autowired
protected BillingEventPricingService<BillingEventDTO,BillingEvent,BillingEventAdjustment,BillingEventItemWithTaxDetails,BillingEventPaymentWithTransaction> billingEventPricingService

billingEventItemService

@Autowired
protected BillingEventItemService<BillingEventItem,BillingEventItemWithTaxDetails> billingEventItemService

walletService

@Autowired
protected WalletService<WalletWithPaymentAccounts,BillingProcessingRequestWithFullDetails> walletService

billingEventPaymentFinder

@Autowired
protected BillingEventPaymentFinder<BillingEventPaymentWithEvent> billingEventPaymentFinder

billingProcessingRequestGenerator

@Autowired
protected BillingProcessingRequestGenerator<BillingProcessingRequest> billingProcessingRequestGenerator

billingEventAddressService

@Autowired
protected BillingEventAddressService<BillingEventAddress> billingEventAddressService

typeFactory

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

Constructor Details

BillingProcessingRequestInitializer

public BillingProcessingRequestInitializer()

Method Details

process

@Deprecated(since="1.0.0")
public void process(P request)

Deprecated.

Use process(InitializeBillingProcessingRequests, ContextInfo) instead

process

public void process(P requestsToInitialize,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readWalletsWithPaymentAccounts

@Nullable
protected Map<String,WalletWithPaymentAccounts> readWalletsWithPaymentAccounts(List<BillingProcessingRequestWithFullDetails> requestsWithFullDetails,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Reads wallets for the provided requests. This is a hook point to override for situations where no payment accounts are necessary for billing, such as using an external invoicing system.

initializeRequests

protected void initializeRequests(List<BillingProcessingRequestWithFullDetails> requestsWithFullDetails,
 @Nullable
 Map<String,WalletWithPaymentAccounts> walletsWithPaymentAccounts,
 List<BillingProcessingRequest> allInitializedRequests,
 List<String> idsToSendToFinalizer,
 List<BillingProcessingRequest> sendToPaymentProcessor,
 List<BillingProcessingRequestWithBillingEventDTO> sendToTaxHandler)

Handles initializing given requests and sorting them to their next destinations depending on their state and external configuration properties

Parameters:

requestsWithFullDetails - requests with full details

walletsWithPaymentAccounts - map of wallets gathered for these requests

allInitializedRequests - list that will contain all initialized requests regardless of next destination

idsToSendToFinalizer - list that will contain ids of requests to be sent to the finalizer

sendToPaymentProcessor - list that will contain requests to be sent to the payment processor

sendToTaxHandler - list that will contain requests to be sent to the payment handler

buildRequestWithBillingEventDTO

protected BillingProcessingRequestWithBillingEventDTO buildRequestWithBillingEventDTO(BillingProcessingRequest request,
 BillingProcessingRequestWithFullDetails requestWithFullDetails)

Builds a composite object from the BillingProcessingRequest and the related BillingEventDTO

setPaymentProcessingRequest

protected void setPaymentProcessingRequest(BillingProcessingRequestWithFullDetails requestWithFullDetails)

Build and set a PaymentAccountProcessingRequest in the BillingProcessingRequestWithFullDetails

retrieveActiveAccounts

protected List<PaymentAccount> retrieveActiveAccounts(BillingProcessingRequest request,
 @Nullable
 Map<String,WalletWithPaymentAccounts> walletsWithPaymentAccounts)

Retrieves active payment accounts for the given request

Parameters:

request - the given request

walletsWithPaymentAccounts - map of wallets for all request

Returns:

retrieved active accounts

requestShouldHaveAccountsButHasNone

protected boolean requestShouldHaveAccountsButHasNone(BillingProcessingTransactionTypeEnum transactionType,
 @Nullable
 List<PaymentAccount> activePaymentAccounts)

Checks whether a given request should have active payment accounts to effectively proceed, but has none instead.

readRequestsWithFullDetailsInCorrectStatuses

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

Reads requests with details for given ids and filters out those already processed or not in NEW status

handleNoPaymentAccountsOnCharge

protected void handleNoPaymentAccountsOnCharge(BillingProcessingRequest request,
 List<String> idsToSendToFinalizer)

Handles changes to the BillingProcessingRequest for CHARGE-type requests with no payment accounts

prepareValidRequestsForNextSteps

protected void prepareValidRequestsForNextSteps(BillingProcessingRequest request,
 BillingProcessingRequestWithFullDetails requestWithFullDetails,
 BillingProcessingRequestWithBillingEventDTO requestWithBillingEventDTO,
 @Nullable
 List<PaymentAccount> activePaymentAccounts,
 List<BillingProcessingRequestWithBillingEventDTO> sendToTaxHandler,
 List<BillingProcessingRequest> sendToPaymentProcessor)

Handles preparing valid requests for their next step, either to be sent to a payment processor or a tax handler.

handleRequestForPaymentProcessor

protected void handleRequestForPaymentProcessor(BillingProcessingRequest request,
 List<BillingProcessingRequest> sendToPaymentProcessor)

Handles changes to a request to prepare for it being sent to a payment processor

isPaymentAborted

protected boolean isPaymentAborted(BillingProcessingRequestWithFullDetails requestDetails)

filterOutWrongStatuses

protected List<BillingProcessingRequestWithFullDetails> filterOutWrongStatuses(List<BillingProcessingRequestWithFullDetails> billingProcessingRequestWithFullDetails)

populateTransactionReferenceIds

protected void populateTransactionReferenceIds(BillingProcessingRequestWithFullDetails requestDetails)

createPaymentAccountProcessingRequestForRefund

protected PaymentAccountProcessingRequest createPaymentAccountProcessingRequestForRefund(BillingProcessingRequestWithFullDetails billingProcessingRequestDetails)

createPaymentAccountProcessingRequestForCharge

protected PaymentAccountProcessingRequest createPaymentAccountProcessingRequestForCharge(BillingProcessingRequestWithFullDetails billingProcessingRequestDetails,
 PaymentAccount paymentAccount)

populateAccounts

protected void populateAccounts(BillingProcessingRequestWithFullDetails billingProcessingRequestDetails,
 List<PaymentAccount> paymentAccounts)

isTaxCalculated

protected boolean isTaxCalculated(BillingProcessingRequest billingProcessingRequest)

isBillingAddressPresent

protected boolean isBillingAddressPresent(BillingEventDTO billingEventDTO)

getBillingEventAddress

@Nullable
protected BillingEventAddress getBillingEventAddress(PaymentAccount paymentAccount)

setAddressForTaxCalculationIfMissing

protected void setAddressForTaxCalculationIfMissing(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO,
 List<PaymentAccount> activePaymentAccounts)

This method sets the billing address from a payment account onto the request for tax calculation if the request does not previously contain a billing address

Parameters:

billingProcessingRequestWithBillingEventDTO - composite object containing the request

activePaymentAccounts - the billing address of the first account from this list will be used for tax calculation

hashTransactionReferenceID

protected String hashTransactionReferenceID(String transactionReferenceId)

Some gateways only allow transaction reference ids shorter than 50 characters. We hash the given value to the MD5 digest.