Package com.broadleafcommerce.promotion.campaign.service

Class DefaultCodeGenerationService

java.lang.Object

com.broadleafcommerce.promotion.campaign.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 CodeFormatAvailableCharHelper	availableCharHelper
protected com.broadleafcommerce.common.extension.TypeFactory	campaignFactory
protected CampaignService<Campaign>	campaignService
protected CampaignCodeGenerationProperties	codeGenerationProperties
protected CampaignCodeService<CampaignCode>	codeService
protected CodeGeneratorService<CodeGenerator>	service

Constructor Summary

Constructors

Constructor	Description
DefaultCodeGenerationService(com.broadleafcommerce.common.extension.TypeFactory campaignFactory, CodeFormatAvailableCharHelper availableCharHelper, CodeGeneratorService<CodeGenerator> service, CampaignCodeService<CampaignCode> codeService, CampaignService<Campaign> campaignService)

Method Summary

Modifier and Type	Method	Description
protected int	calculateRequiredCodeLength(int numberOfCodes, int charSetSize)	Returns the size of the code that you must create in order to support the passed in number of Codes.
protected int	createBatchOfCodes(String originalCodeFormat, CodeGeneratorBucket bucket, int numberToCreate, Set<String> currentCodeSet)
protected String	createCode(String codeFormat, Random r)	Uses the code format (e.g.
protected CodeGenerationResult	generateCodes(CodeGenerator generator, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)	Generates and returns a list of CampaignCodes 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 CampaignCodes 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 CampaignCodes 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	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 CampaignCodeService<CampaignCode>	getCodeService()
protected CodeGeneratorService<CodeGenerator>	getService()
void	initializeCodePrefixAndGenerateCodes(CodeGenerator info, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)	Deprecated.
protected String	initializeCodePrefixAndGetCodeFormat(CodeGenerator info, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)	If null, initializes the code prefix to the associated campaign's code prefix.
void	initializeCodePrefixAndValidateGenerator(CodeGenerator info, com.broadleafcommerce.data.tracking.core.context.ContextRequest context)	Deprecated.
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)
CodeGenerator	saveCampaignCodeGenerationInfo(CodeGenerator info)
protected void	setBatchSize(int batchSize)	Deprecated. Since 1.6, use CampaignCodeGenerationProperties.getBatchSize() instead.
void	setCodeGenerationProperties(CampaignCodeGenerationProperties codeGenerationProperties)
void	startCodeGeneration(CodeGenerator codeGenerationInfo, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)	Deprecated.
protected CodeGenerator	updateCodesGenerated(CodeGenerator info, int codesCreated, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected CodeGenerator	updateCodesGenerated(CodeGenerator info, int codesCreated, com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)	Deprecated. Since 1.6, in favor of updateCodesGenerated(CodeGenerator, int, ContextInfo).

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.campaign.service.CodeGenerationService

markInProgressAndGenerateCodes

Field Detail

campaignFactory

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

availableCharHelper

protected final CodeFormatAvailableCharHelper availableCharHelper

service

protected final CodeGeneratorService<CodeGenerator> service

codeService

protected final CampaignCodeService<CampaignCode> codeService

campaignService

protected final CampaignService<Campaign> campaignService

codeGenerationProperties

protected CampaignCodeGenerationProperties codeGenerationProperties

Constructor Detail

DefaultCodeGenerationService

public DefaultCodeGenerationService(com.broadleafcommerce.common.extension.TypeFactory campaignFactory,
                                    CodeFormatAvailableCharHelper availableCharHelper,
                                    CodeGeneratorService<CodeGenerator> service,
                                    CampaignCodeService<CampaignCode> codeService,
                                    CampaignService<Campaign> campaignService)

Method Detail

initializeCodePrefixAndValidateGenerator

@Deprecated
public void initializeCodePrefixAndValidateGenerator(CodeGenerator info,
                                                     com.broadleafcommerce.data.tracking.core.context.ContextRequest context)

Deprecated.

Description copied from interface: CodeGenerationService

Sets the CodeGenerator's CodeGenerator.codePrefix to be its campaign's code prefix if not present. After this, validates that the codeFormat for the CodeGenerator is large enough to hold the number of codes desired, ensuring that the codes are not easily guessable.

Specified by:

initializeCodePrefixAndValidateGenerator in interface CodeGenerationService

Parameters:

info - The CodeGenerator that contains the number of codes to generate and the potential code format.

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

initializeCodePrefixAndGenerateCodes

@Deprecated
public void initializeCodePrefixAndGenerateCodes(CodeGenerator info,
                                                 com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

Deprecated.

Description copied from interface: CodeGenerationService

Sets the CodeGenerator's CodeGenerator.codePrefix to be its campaign's code prefix if not present. After this, generates the codes for the provided CodeGenerator.

Specified by:

initializeCodePrefixAndGenerateCodes in interface CodeGenerationService

Parameters:

info - The CodeGenerator that holds the information needed in order to generate the expected number of codes with the expected format, if desired.

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

startCodeGeneration

@Deprecated
public void startCodeGeneration(CodeGenerator codeGenerationInfo,
                                com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

Deprecated.

Description copied from interface: CodeGenerationService

Prepares the CodeGenerator for processing, then triggers the code generation.

Specified by:

startCodeGeneration 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, if desired.

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

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 CampaignCodes and error message based on the given CodeGenerator

generateCodesForVouchers

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

Description copied from interface: CodeGenerationService

Returns the CodeGenerationResult containing generated and/or existing CampaignCodes 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 CampaignCodes 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 CampaignCodes with

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

Returns:

the CodeGenerationResult containing generated and/or existing CampaignCodes 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 CampaignCodes based on the given CodeGenerator.

The CampaignCodes are generated in batches based on CampaignCodeGenerationProperties.

Parameters:

generator - the CodeGenerator to generate the CampaignCodes with

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

Returns:

a list of CampaignCodes generated from the given CodeGenerator

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,
                                                    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 CampaignCodes from

contextInfo - context surrounding sandboxing and multitenant state

Returns:

a CodeGenerationResult containing a list of generated CampaignCodes 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 CampaignCodes based on the given VoucherCodeGenerationRequest.

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

If there's sufficient amount of existing CampaignCodes 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 CampaignCodes based on the given VoucherCodeGenerationRequest

updateCodesGenerated

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

Deprecated.

Since 1.6, in favor of updateCodesGenerated(CodeGenerator, int, ContextInfo).

updateCodesGenerated

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

createBatchOfCodes

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

Parameters:

originalCodeFormat -

bucket -

numberToCreate -

currentCodeSet -

Returns:

calculateRequiredCodeLength

protected int calculateRequiredCodeLength(int numberOfCodes,
                                          int charSetSize)

Returns the size of the code that you must create in order to support the passed in number of Codes.

Parameters:

numberOfCodes -

Returns:

initializeCodePrefixAndGetCodeFormat

protected String initializeCodePrefixAndGetCodeFormat(CodeGenerator info,
                                                      com.broadleafcommerce.data.tracking.core.context.ContextRequest contextRequest)

If null, initializes the code prefix to the associated campaign's code prefix. Then, if the code format was not specified, creates one using the code prefix and alphanumeric characters for the specified length.

Parameters:

info - the CodeGenerator to use to determine format against

contextRequest - the context for the request

Returns:

the specified or newly created code format for the given CodeGenerator

Throws:

IllegalArgumentException - if the CodeGenerator.codeLength is less than the required code length

createCode

protected String createCode(String codeFormat,
                            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:

saveCampaignCodeGenerationInfo

public CodeGenerator saveCampaignCodeGenerationInfo(CodeGenerator info)

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()

getCodeService

protected CampaignCodeService<CampaignCode> getCodeService()

getCampaignService

protected CampaignService<Campaign> getCampaignService()

getCodeGenerationProperties

protected CampaignCodeGenerationProperties getCodeGenerationProperties()

setCodeGenerationProperties

@Autowired
public void setCodeGenerationProperties(CampaignCodeGenerationProperties codeGenerationProperties)