com.broadleafcommerce.advancedoffer.admin.server.validation

Class OfferCodeGenerationValidator

java.lang.Object

org.broadleafcommerce.openadmin.server.service.persistence.validation.ValidationConfigurationBasedPropertyValidator

com.broadleafcommerce.advancedoffer.admin.server.validation.OfferCodeGenerationValidator

All Implemented Interfaces:

org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidator

@Component(value="blOfferCodeGenerationValidator")
public class OfferCodeGenerationValidator
extends org.broadleafcommerce.openadmin.server.service.persistence.validation.ValidationConfigurationBasedPropertyValidator

Author:

Reginald Cole

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.openadmin.server.service.AdminEntityService	adminEntityService
protected static char	ALPHA_NUMERIC_FORMAT_ELEMENT
protected CodeFormatAvailableCharHelper	availableCharHelper
protected static String	CODE_FORMAT
protected static String	CODE_FORMAT_TOO_SHORT_ERROR
protected static String	CODE_GENERATION_METHOD
protected static String	CODE_LENGTH
protected static int	CODE_MULTIPLIER
protected static String	LENGTH_TOO_SHORT_ERROR
protected static String	MAX_CODE_GENERATE_ERROR
protected Integer	maxCodeGenerationAllowed
protected static String	NO_LENGTH_PROVIDED_ERROR
protected static String	NUM_CODES_TO_GENERATE
protected static String	SPECIFY_FORMAT
protected static String	SPECIFY_LENGTH
protected static String	TOO_EASY_TO_GUESS_ERROR

Constructor Summary

Constructors

Constructor and Description
OfferCodeGenerationValidator()

Method Summary

Modifier and Type	Method and Description
protected int	calculateRequiredCodeLength(Integer numberOfCodes) Returns the size of the code that you must create in order to support the passed in number of Codes.
protected String	generateErrorMessage(Object[] args, String errorMessage)
protected int	getCodeMultiplier() Deprecated. Use CODE_MULTIPLIER
protected long	getPossibleCodes(Integer codeLength)
org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult	validate(org.broadleafcommerce.openadmin.dto.Entity entity, Serializable instance, Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata> entityFieldMetadata, Map<String,String> validationConfiguration, org.broadleafcommerce.openadmin.dto.BasicFieldMetadata propertyMetadata, String propertyName, String value)
protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult	validateCodeFormat(org.broadleafcommerce.openadmin.dto.Entity entity, String value)
protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult	validateCodeGenerationMethod(org.broadleafcommerce.openadmin.dto.Entity entity, String value)
protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult	validateCodeLength(org.broadleafcommerce.openadmin.dto.Entity entity, String value)
protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult	validateNumberOfCodesToGenerate(Integer codesToCreate, String value)
protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult	validateNumberOfCodesToGenerate(String value, CodeGenerationMethodType generationMethod)

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.validation.ValidationConfigurationBasedPropertyValidator

validateInternal

Methods inherited from class java.lang.Object

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

Field Detail

CODE_FORMAT_TOO_SHORT_ERROR

protected static final String CODE_FORMAT_TOO_SHORT_ERROR

See Also:

Constant Field Values

MAX_CODE_GENERATE_ERROR

protected static final String MAX_CODE_GENERATE_ERROR

See Also:

Constant Field Values

NO_LENGTH_PROVIDED_ERROR

protected static final String NO_LENGTH_PROVIDED_ERROR

See Also:

Constant Field Values

TOO_EASY_TO_GUESS_ERROR

protected static final String TOO_EASY_TO_GUESS_ERROR

See Also:

Constant Field Values

LENGTH_TOO_SHORT_ERROR

protected static final String LENGTH_TOO_SHORT_ERROR

See Also:

Constant Field Values

CODE_FORMAT

protected static final String CODE_FORMAT

See Also:

Constant Field Values

CODE_LENGTH

protected static final String CODE_LENGTH

See Also:

Constant Field Values

NUM_CODES_TO_GENERATE

protected static final String NUM_CODES_TO_GENERATE

See Also:

Constant Field Values

CODE_GENERATION_METHOD

protected static final String CODE_GENERATION_METHOD

See Also:

Constant Field Values

SPECIFY_FORMAT

protected static final String SPECIFY_FORMAT

See Also:

Constant Field Values

SPECIFY_LENGTH

protected static final String SPECIFY_LENGTH

See Also:

Constant Field Values

CODE_MULTIPLIER

protected static final int CODE_MULTIPLIER

See Also:

Constant Field Values

ALPHA_NUMERIC_FORMAT_ELEMENT

protected static final char ALPHA_NUMERIC_FORMAT_ELEMENT

See Also:

Constant Field Values

maxCodeGenerationAllowed

@Value(value="${offerCode.maxCodeGeneration:100000}")
protected Integer maxCodeGenerationAllowed

adminEntityService

protected org.broadleafcommerce.openadmin.server.service.AdminEntityService adminEntityService

availableCharHelper

protected CodeFormatAvailableCharHelper availableCharHelper

Constructor Detail

OfferCodeGenerationValidator

public OfferCodeGenerationValidator()

Method Detail

validate

public org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult validate(org.broadleafcommerce.openadmin.dto.Entity entity,
                                                                                                               Serializable instance,
                                                                                                               Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata> entityFieldMetadata,
                                                                                                               Map<String,String> validationConfiguration,
                                                                                                               org.broadleafcommerce.openadmin.dto.BasicFieldMetadata propertyMetadata,
                                                                                                               String propertyName,
                                                                                                               String value)

Specified by:

validate in interface org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidator

Overrides:

validate in class org.broadleafcommerce.openadmin.server.service.persistence.validation.ValidationConfigurationBasedPropertyValidator

validateCodeFormat

protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult validateCodeFormat(org.broadleafcommerce.openadmin.dto.Entity entity,
                                                                                                                            String value)

validateCodeGenerationMethod

protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult validateCodeGenerationMethod(org.broadleafcommerce.openadmin.dto.Entity entity,
                                                                                                                                      String value)

validateNumberOfCodesToGenerate

protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult validateNumberOfCodesToGenerate(Integer codesToCreate,
                                                                                                                                         String value)

generateErrorMessage

protected String generateErrorMessage(Object[] args,
                                      String errorMessage)

validateCodeLength

protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult validateCodeLength(org.broadleafcommerce.openadmin.dto.Entity entity,
                                                                                                                            String value)

getPossibleCodes

protected long getPossibleCodes(Integer codeLength)

calculateRequiredCodeLength

protected int calculateRequiredCodeLength(Integer numberOfCodes)

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

Parameters:

numberOfCodes -

Returns:

minimum length for a code

validateNumberOfCodesToGenerate

protected org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidationResult validateNumberOfCodesToGenerate(String value,
                                                                                                                                         CodeGenerationMethodType generationMethod)

getCodeMultiplier

@Deprecated
protected int getCodeMultiplier()

Deprecated. Use CODE_MULTIPLIER

Affects the "guess-ability" 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:

CODE_MULTIPLIER