Package com.broadleafcommerce.promotion.offer.service

Class DefaultCodeGenerationService

java.lang.Object

com.broadleafcommerce.promotion.offer.service.DefaultCodeGenerationService

All Implemented Interfaces:

CodeGenerationService

public class DefaultCodeGenerationService
extends Object
implements CodeGenerationService

Author:

Chad Harchar (charchar)

Field Summary

Fields

Modifier and Type	Field	Description
protected final CodeFormatAvailableCharHelper	availableCharHelper
protected final com.broadleafcommerce.common.extension.TypeFactory	campaignFactory
protected final CampaignService<Campaign>	campaignService
protected CampaignCodeGenerationProperties	codeGenerationProperties
protected final OfferCodeService<OfferCode>	offerCodeService
protected final CodeGeneratorService<CodeGenerator>	service

Constructor Summary

Constructors

Constructor	Description
DefaultCodeGenerationService(com.broadleafcommerce.common.extension.TypeFactory campaignFactory, CodeFormatAvailableCharHelper availableCharHelper, CodeGeneratorService<CodeGenerator> service, OfferCodeService<OfferCode> offerCodeService, CampaignService<Campaign> campaignService)

Method Summary

Modifier and Type	Method	Description
protected int	createBatchOfCodes(String originalCodeFormat, CodeGeneratorBucket bucket, int numberToCreate, Set<String> currentCodeSet)
protected String	createCode(String codeFormat, CodeGeneratorBucket bucket, Random r)	Uses the code format (e.g.
protected CodeGeneratorBucket	createCodeGeneratorBucket(CodeGenerator generator, int batchSize)	Provide ability to override CodeGeneratorBucket
protected CodeGenerationResult	generateCodes(CodeGenerator generator, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)	Generates and returns a list of offer codes based on the given CodeGenerator.
CodeGenerationResult	generateCodesForVouchers(VoucherCodeGenerationRequest voucherCodeGenerationReq, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Returns the CodeGenerationResult containing generated and/or existing OfferCodes for voucher offers based on the given VoucherCodeGenerationRequest.
protected CodeGenerationResult	generateOrUseAvailableCodes(VoucherCodeGenerationRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Returns a CodeGenerationResult containing a list of generated and/or existing offer codes based on the given VoucherCodeGenerationRequest.
protected CodeGenerationResult	generateVoucherCodes(VoucherCodeGenerationRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Delegates to generateOrUseAvailableCodes(VoucherCodeGenerationRequest, ContextInfo) to get a CodeGenerationResult, then updates CodeGenerationResult.getGeneratedCodes() based on VoucherCodeGenerationRequest.getCodeGenerator().
protected CodeFormatAvailableCharHelper	getAvailableCharHelper()
protected int	getBatchSize()	Returns the batch size for generating new offer codes.
protected int	getBatchSize(CodeGenerator generator)
protected int	getBatchSizeForVouchers()	Returns the batch size for generating new offer codes for voucher offers.
protected com.broadleafcommerce.common.extension.TypeFactory	getCampaignFactory()
protected CampaignService<Campaign>	getCampaignService()
protected CampaignCodeGenerationProperties	getCodeGenerationProperties()
protected int	getCodeMultiplier()	Affects the "guessability" of codes when a code format has not been provided.
protected OfferCodeService<OfferCode>	getOfferCodeService()
protected CodeGeneratorService<CodeGenerator>	getService()
CodeGenerationResult	markInProgressAndGenerateAndGetCodes(CodeGenerator codeGenerationInfo, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)	Updates the CodeGenerator to have a status of CodeGenerationStatusType.IN_PROCESS, then performs the code generation.
protected void	processCodeGeneratorError(CodeGenerationResult generationResult, CodeGenerator codeGenerator, int codesCreated, String errorMessage, Exception exception, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)
protected void	setBatchSize(int batchSize)	Deprecated. Since 1.6, use CampaignCodeGenerationProperties.getBatchSize() instead.
void	setCodeGenerationProperties(CampaignCodeGenerationProperties codeGenerationProperties)
protected CodeGenerator	updateCodesGenerated(CodeGenerator info, int codesCreated, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.promotion.offer.service.CodeGenerationService

markInProgressAndGenerateCodes

Field Details

campaignFactory

protected final com.broadleafcommerce.common.extension.TypeFactory campaignFactory

availableCharHelper

protected final CodeFormatAvailableCharHelper availableCharHelper

service

protected final CodeGeneratorService<CodeGenerator> service

offerCodeService

protected final OfferCodeService<OfferCode> offerCodeService

campaignService

protected final CampaignService<Campaign> campaignService

codeGenerationProperties

protected CampaignCodeGenerationProperties codeGenerationProperties

Constructor Details

DefaultCodeGenerationService

public DefaultCodeGenerationService(com.broadleafcommerce.common.extension.TypeFactory campaignFactory,
 CodeFormatAvailableCharHelper availableCharHelper,
 CodeGeneratorService<CodeGenerator> service,
 OfferCodeService<OfferCode> offerCodeService,
 CampaignService<Campaign> campaignService)

Method Details

markInProgressAndGenerateAndGetCodes

public CodeGenerationResult markInProgressAndGenerateAndGetCodes(CodeGenerator codeGenerationInfo,
 com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

Description copied from interface: CodeGenerationService

Updates the CodeGenerator to have a status of CodeGenerationStatusType.IN_PROCESS, then performs the code generation.

Specified by:

markInProgressAndGenerateAndGetCodes in interface CodeGenerationService

Parameters:

codeGenerationInfo - The CodeGenerator that holds the information needed in order to generate the expected number of codes with the expected format

contextRequest - The context of the request with which to generate codes

Returns:

the CodeGenerationResult containing the generated OfferCodes and error message based on the given CodeGenerator

generateCodesForVouchers

public CodeGenerationResult generateCodesForVouchers(VoucherCodeGenerationRequest voucherCodeGenerationReq,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CodeGenerationService

Returns the CodeGenerationResult containing generated and/or existing OfferCodes for voucher offers based on the given VoucherCodeGenerationRequest.

This will use the existing CodeGenerator for the voucher campaign if exists, otherwise it will create a new one.

This method will generate the OfferCodes and waits for its completion in the same request, therefore it's meant for small batch of code generation only.

Specified by:

generateCodesForVouchers in interface CodeGenerationService

Parameters:

voucherCodeGenerationReq - the VoucherCodeGenerationRequest to generate the voucher OfferCodes with

contextInfo - The context of the request with which to generate codes

Returns:

the CodeGenerationResult containing generated and/or existing OfferCodes for voucher offers based on the given VoucherCodeGenerationRequest.

generateCodes

protected CodeGenerationResult generateCodes(CodeGenerator generator,
 com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

Generates and returns a list of offer codes based on the given CodeGenerator.

The offer codes are generated in batches based on CampaignCodeGenerationProperties.

Parameters:

generator - the CodeGenerator to generate the offer codes with

contextRequest - the context of the request with which to generate codes

Returns:

a list of offer codes generated from the given CodeGenerator

getBatchSize

protected int getBatchSize(CodeGenerator generator)

createCodeGeneratorBucket

protected CodeGeneratorBucket createCodeGeneratorBucket(CodeGenerator generator,
 int batchSize)

Provide ability to override CodeGeneratorBucket

Parameters:

generator - the CodeGenerator to generate the offer codes with

batchSize - the number of records to process within an iteration

Returns:

the new CodeGeneratorBucket configuration

processCodeGeneratorError

protected void processCodeGeneratorError(CodeGenerationResult generationResult,
 CodeGenerator codeGenerator,
 int codesCreated,
 String errorMessage,
 @Nullable
 Exception exception,
 com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

generateVoucherCodes

protected CodeGenerationResult generateVoucherCodes(VoucherCodeGenerationRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Delegates to generateOrUseAvailableCodes(VoucherCodeGenerationRequest, ContextInfo) to get a CodeGenerationResult, then updates CodeGenerationResult.getGeneratedCodes() based on VoucherCodeGenerationRequest.getCodeGenerator().

Parameters:

request - the VoucherCodeGenerationRequest to generate the offer codes from

contextInfo - context surrounding sandboxing and multitenant state

Returns:

a CodeGenerationResult containing a list of generated offer codes based on the given VoucherCodeGenerationRequest

generateOrUseAvailableCodes

protected CodeGenerationResult generateOrUseAvailableCodes(VoucherCodeGenerationRequest request,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Returns a CodeGenerationResult containing a list of generated and/or existing offer codes based on the given VoucherCodeGenerationRequest.

If there's an existing CodeGenerator with VoucherCodeGenerationRequest.getVoucherCampaignId(), then it will be used to retrieve the available offer codes. Otherwise, a new CodeGenerator will be created based on the given VoucherCodeGenerationRequest.getCodeGenerator().

If there's sufficient amount of existing offer codes for CodeGenerator.getNumberOfCodesToGenerate(), then they will be used. Otherwise, more will be generated until CodeGenerator.getNumberOfCodesToGenerate() is met.

Parameters:

request - the VoucherCodeGenerationRequest to get the CodeGenerator from

contextInfo - context surrounding sandboxing and multitenant state

Returns:

a CodeGenerationResult containing a list of generated or existing offer codes based on the given VoucherCodeGenerationRequest

updateCodesGenerated

protected CodeGenerator updateCodesGenerated(CodeGenerator info,
 int codesCreated,
 com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

createBatchOfCodes

protected int createBatchOfCodes(String originalCodeFormat,
 CodeGeneratorBucket bucket,
 int numberToCreate,
 Set<String> currentCodeSet)

Parameters:

originalCodeFormat -

bucket -

numberToCreate -

currentCodeSet -

Returns:

createCode

protected String createCode(String codeFormat,
 CodeGeneratorBucket bucket,
 Random r)

Uses the code format (e.g. ###-@@@@-###) to randomly create the code. The fixedChars parameter represents the part of the code that has been locked in for example to representing the "bucket" characters currently being generated.

Parameters:

codeFormat -

r -

Returns:

getBatchSize

protected int getBatchSize()

Returns the batch size for generating new offer codes. A separate transaction will be created for each batch of codes.

Returns:

the batch size for generating new offer codes

getBatchSizeForVouchers

protected int getBatchSizeForVouchers()

Returns the batch size for generating new offer codes for voucher offers. A separate transaction will be created for each batch of codes.

Returns:

the batch size for generating new offer codes for voucher offers

setBatchSize

@Deprecated
protected void setBatchSize(int batchSize)

Deprecated.

Since 1.6, use CampaignCodeGenerationProperties.getBatchSize() instead.

Returns the batch size for generating new offer codes. A separate transaction will be created for each batch of codes.

getCodeMultiplier

protected int getCodeMultiplier()

Affects the "guessability" of codes when a code format has not been provided. For example, if 100 codes are being generated, the default will insure that the codes are generated at least from a pool of 100000 possible codes.

Returns:

getCampaignFactory

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

getAvailableCharHelper

protected CodeFormatAvailableCharHelper getAvailableCharHelper()

getService

protected CodeGeneratorService<CodeGenerator> getService()

getOfferCodeService

protected OfferCodeService<OfferCode> getOfferCodeService()

getCampaignService

protected CampaignService<Campaign> getCampaignService()

getCodeGenerationProperties

protected CampaignCodeGenerationProperties getCodeGenerationProperties()

setCodeGenerationProperties

@Autowired
public void setCodeGenerationProperties(CampaignCodeGenerationProperties codeGenerationProperties)