Package com.broadleafcommerce.orderoperation.service.messaging.ordercreated

Class VoucherCodeGenerationOrderCreatedListener

java.lang.Object

com.broadleafcommerce.orderoperation.service.messaging.ordercreated.VoucherCodeGenerationOrderCreatedListener

public class VoucherCodeGenerationOrderCreatedListener
extends Object

An event listener that triggers when order is successfully created. Responsible for validating Order.getVouchers(), generating voucher codes, and sending a VoucherGenerationCompletionEvent message.

Author:

Sunny Yu

Constructor Summary

Constructors

Constructor

Description

VoucherCodeGenerationOrderCreatedListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentMessageService, VoucherGenerationCompletionProducer voucherGenerationCompletionProducer, com.broadleafcommerce.common.extension.TypeFactory typeFactory, OfferProvider offerProvider, CampaignProvider campaignProvider, OrderProvider<com.broadleafcommerce.order.client.domain.Order> orderProvider)

Method Summary

Modifier and Type	Method	Description
protected CodeGenerator	buildCodeGeneratorRequest(String campaignId, int numberToGenerate, String emailRegex)	Builds a CodeGenerator based on the given CodeGenerator.getCampaignId(), CodeGenerator.getNumberOfCodesToGenerate(), and CodeGenerator.getEmailRegEx().
protected String	buildEmailRegex(String email)	Builds an email regular expression for CodeGenerator.getEmailRegEx().
protected VoucherCodeGenerationRequest	buildVoucherCodeGenerationRequest(CodeGenerator codeGenerator, String voucherCampaignId)	Builds a VoucherCodeGenerationRequest based on the given CodeGenerator and Voucher.getVoucherCampaignId().
protected void	generateAndSetVoucherCodes(com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Generates and sets Voucher.getGeneratedCampaignCode() using CampaignProvider for valid Vouchers in which Voucher.isValidationSuccessful() is true.
protected CampaignProvider	getCampaignProvider()
protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService	getIdempotentMessageService()
protected OfferProvider	getOfferProvider()
protected OrderProvider<com.broadleafcommerce.order.client.domain.Order>	getOrderProvider()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected VoucherGenerationCompletionProducer	getVoucherGenerationCompletionProducer()
protected void	handleCodeGenerationError(CodeGenerationResult result, String voucherCampaignId, List<com.broadleafcommerce.order.common.domain.Voucher> vouchersForCampaign)	Handles code generation error from the given CodeGenerationResult if CodeGenerationResult.isSuccessful() is false.
protected void	handleVoucherValidationFailures(com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult result)	Handles voucher validation failures for Order.getVouchers() based on the given OfferAndOfferCodeUsageValidationResult.
void	listen(org.springframework.messaging.Message<OrderCreatedEvent> message)	Event listener entry point.
protected void	process(@NonNull OrderCreatedEvent event)	Processes the received message by validating Order.getVouchers(), generating voucher codes, and then sending a VoucherGenerationCompletionEvent message/
protected void	processMessage(org.springframework.messaging.Message<OrderCreatedEvent> message)	Processes the given Message.
protected void	processVoucherCodeGenerationResult(com.broadleafcommerce.order.client.domain.Order order, CodeGenerationResult generationResult, String voucherCampaignId, List<com.broadleafcommerce.order.common.domain.Voucher> vouchersForCampaign)	Processes the given CodeGenerationResult for the given Order and vouchers for the same campaign
protected void	sendVoucherCodeCreatedMessage(com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Sends a VoucherGenerationCompletionEvent message.
protected boolean	shouldProcessEvent(OrderCreatedEvent event)	Determines whether or not the given OrderCreatedEvent should be processed.
protected void	validateVouchers(com.broadleafcommerce.order.client.domain.Order order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates Order.getVouchers() using OfferProvider.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoucherCodeGenerationOrderCreatedListener

public VoucherCodeGenerationOrderCreatedListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentMessageService,
                                                 VoucherGenerationCompletionProducer voucherGenerationCompletionProducer,
                                                 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                                                 OfferProvider offerProvider,
                                                 CampaignProvider campaignProvider,
                                                 OrderProvider<com.broadleafcommerce.order.client.domain.Order> orderProvider)

Method Detail

listen

@StreamListener("orderOperationsOrderCreatedInput")
public void listen(org.springframework.messaging.Message<OrderCreatedEvent> message)

Event listener entry point. Checks if the message has already been received and, if not, begins processing it.

Parameters:

message - the message payload event

shouldProcessEvent

protected boolean shouldProcessEvent(OrderCreatedEvent event)

Determines whether or not the given OrderCreatedEvent should be processed.

Parameters:

event - the OrderCreatedEvent to check against

Returns:

true if the given OrderCreatedEvent should be processed, otherwise false

processMessage

protected void processMessage(org.springframework.messaging.Message<OrderCreatedEvent> message)

Processes the given Message.

Parameters:

message - the Message to process

process

protected void process(@NonNull
                       @NonNull OrderCreatedEvent event)

Processes the received message by validating Order.getVouchers(), generating voucher codes, and then sending a VoucherGenerationCompletionEvent message/

Parameters:

event - the message payload event

validateVouchers

protected void validateVouchers(com.broadleafcommerce.order.client.domain.Order order,
                                @Nullable
                                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validates Order.getVouchers() using OfferProvider.

Parameters:

order - the Order that contains all the Vouchers

contextInfo - context information surrounding sandboxing and multitenant state

handleVoucherValidationFailures

protected void handleVoucherValidationFailures(com.broadleafcommerce.order.client.domain.Order order,
                                               com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult result)

Handles voucher validation failures for Order.getVouchers() based on the given OfferAndOfferCodeUsageValidationResult.

Parameters:

order - the Order that contains all the Vouchers

result - the OfferAndOfferCodeUsageValidationResult from the voucher validation

generateAndSetVoucherCodes

protected void generateAndSetVoucherCodes(com.broadleafcommerce.order.client.domain.Order order,
                                          @Nullable
                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Generates and sets Voucher.getGeneratedCampaignCode() using CampaignProvider for valid Vouchers in which Voucher.isValidationSuccessful() is true.

Parameters:

order - the Order that contains the Vouchers

contextInfo - context information surrounding sandboxing and multitenant state

buildEmailRegex

protected String buildEmailRegex(String email)

Builds an email regular expression for CodeGenerator.getEmailRegEx().

Parameters:

email - the Order.getEmailAddress()

Returns:

an email regular expression for CodeGenerator.getEmailRegEx()

buildVoucherCodeGenerationRequest

protected VoucherCodeGenerationRequest buildVoucherCodeGenerationRequest(CodeGenerator codeGenerator,
                                                                         String voucherCampaignId)

Builds a VoucherCodeGenerationRequest based on the given CodeGenerator and Voucher.getVoucherCampaignId().

Parameters:

codeGenerator - the CodeGenerator to generate the CampaignCodes off of

voucherCampaignId - the Voucher.getVoucherCampaignId()

Returns:

a VoucherCodeGenerationRequest based on the given CodeGenerator and Voucher.getVoucherCampaignId()

buildCodeGeneratorRequest

protected CodeGenerator buildCodeGeneratorRequest(String campaignId,
                                                  int numberToGenerate,
                                                  String emailRegex)

Builds a CodeGenerator based on the given CodeGenerator.getCampaignId(), CodeGenerator.getNumberOfCodesToGenerate(), and CodeGenerator.getEmailRegEx().

Parameters:

campaignId - the CodeGenerator.getCampaignId()

numberToGenerate - the CodeGenerator.getNumberOfCodesToGenerate()

emailRegex - the CodeGenerator.getEmailRegEx().

Returns:

a CodeGenerator based on the given CodeGenerator.getCampaignId(), CodeGenerator.getNumberOfCodesToGenerate(), and CodeGenerator.getEmailRegEx()

processVoucherCodeGenerationResult

protected void processVoucherCodeGenerationResult(com.broadleafcommerce.order.client.domain.Order order,
                                                  CodeGenerationResult generationResult,
                                                  String voucherCampaignId,
                                                  List<com.broadleafcommerce.order.common.domain.Voucher> vouchersForCampaign)

Processes the given CodeGenerationResult for the given Order and vouchers for the same campaign

Parameters:

order - the Order that contains the given Vouchers

generationResult - the CodeGenerationResult to process

voucherCampaignId - the id of the voucher campaign that the given CodeGenerationResult and Vouchers are associated with

vouchersForCampaign - the Vouchers that the CodeGenerationResult was for and associated with the same campaign

Throws:

IllegalStateException - if the CodeGenerationResult is successful but generated voucher codes are not enough for Order.getVouchers()

handleCodeGenerationError

protected void handleCodeGenerationError(CodeGenerationResult result,
                                         String voucherCampaignId,
                                         List<com.broadleafcommerce.order.common.domain.Voucher> vouchersForCampaign)

Handles code generation error from the given CodeGenerationResult if CodeGenerationResult.isSuccessful() is false.

Parameters:

result - the CodeGenerationResult to handle for

voucherCampaignId - the id of the voucher campaign that the given CodeGenerationResult and Vouchers are associated with

vouchersForCampaign - the Vouchers that the CodeGenerationResult was for and associated with the same campaign

sendVoucherCodeCreatedMessage

protected void sendVoucherCodeCreatedMessage(com.broadleafcommerce.order.client.domain.Order order,
                                             @Nullable
                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Sends a VoucherGenerationCompletionEvent message.

Parameters:

order - the Order that the vouchers were created for

contextInfo - context information surrounding sandboxing and multitenant state

getIdempotentMessageService

protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService getIdempotentMessageService()

getVoucherGenerationCompletionProducer

protected VoucherGenerationCompletionProducer getVoucherGenerationCompletionProducer()

getTypeFactory

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

getOfferProvider

protected OfferProvider getOfferProvider()

getCampaignProvider

protected CampaignProvider getCampaignProvider()

getOrderProvider

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