Package org.broadleafcommerce.core.order.service

Class ProductOptionValidationServiceImpl

java.lang.Object

org.broadleafcommerce.core.order.service.ProductOptionValidationServiceImpl

All Implemented Interfaces:

ProductOptionValidationService

@Service("blProductOptionValidationService")
public class ProductOptionValidationServiceImpl
extends Object
implements ProductOptionValidationService

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Integer	ADD_TYPE_RANK
protected org.springframework.core.env.Environment	environment
protected static final Set<String>	NON_ENUMERATED_OPTION_TYPES	Option types whose value is entered freely rather than chosen from an enumerated list, so there is no allowed value list to check the submitted value against.
protected ProductOptionDao	productOptionDao
protected boolean	siteXssWrapperEnabled
protected static final Integer	SUBMIT_TYPE_RANK
protected boolean	xssExploitProtectionEnabled

Constructor Summary

Constructors

Constructor	Description
ProductOptionValidationServiceImpl()

Method Summary

Modifier and Type	Method	Description
List<Long>	findSkuIdsForProductOptionValues(Long productId, String attributeName, String attributeValue, List<Long> possibleSkuIds)
boolean	hasProductOptionValidationStrategy(ProductOption productOption)
boolean	isAddOrNoneType(ProductOption productOption)
protected boolean	isNonEnumeratedOptionType(ProductOption productOption)
protected boolean	isRequiredAttributeNotProvided(ProductOption productOption, String attributeValue)
boolean	isSubmitType(ProductOption productOption)
protected boolean	requiresValidation(ProductOption productOption, String value)
Boolean	validate(ProductOption productOption, String value)
protected void	validateOptionValueIsAllowed(ProductOption productOption, String attributeValue)	Rejects a value that is not one of the option's allowed values.
void	validateProductOptionAttributes(Product product, Map<String,String> attributeValues)	For each submitted attribute that corresponds to a product option on the product, validates that the submitted value is one the option allows.
protected Boolean	validateRegex(String regex, String value)
void	validateWithoutException(ProductOption productOption, String attributeValue, ActivityMessages messages)

Methods inherited from class java.lang.Object

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

Field Details

ADD_TYPE_RANK

protected static final Integer ADD_TYPE_RANK

SUBMIT_TYPE_RANK

protected static final Integer SUBMIT_TYPE_RANK

NON_ENUMERATED_OPTION_TYPES

protected static final Set<String> NON_ENUMERATED_OPTION_TYPES

Option types whose value is entered freely rather than chosen from an enumerated list, so there is no allowed value list to check the submitted value against.

productOptionDao

protected ProductOptionDao productOptionDao

environment

@Autowired
protected org.springframework.core.env.Environment environment

xssExploitProtectionEnabled

@Value("${exploitProtection.xssEnabled:false}")
protected boolean xssExploitProtectionEnabled

siteXssWrapperEnabled

@Value("${blc.site.enable.xssWrapper:false}")
protected boolean siteXssWrapperEnabled

Constructor Details

ProductOptionValidationServiceImpl

public ProductOptionValidationServiceImpl()

Method Details

validate

public Boolean validate(ProductOption productOption,
 String value)

Specified by:

validate in interface ProductOptionValidationService

validateProductOptionAttributes

public void validateProductOptionAttributes(Product product,
 Map<String,String> attributeValues)

Description copied from interface: ProductOptionValidationService

For each submitted attribute that corresponds to a product option on the product, validates that the submitted value is one the option allows. A value that is not one of an enumerated option's allowed values is rejected. Non-enumerated option types (free entry, e.g. text or date) are excluded, since their value is not chosen from a list. An attribute that does not match a product option is left alone, since order item attributes are a generic key-value store also used for custom, non-option attributes.

Specified by:

validateProductOptionAttributes in interface ProductOptionValidationService

Parameters:

product - the product the attributes are being validated against

attributeValues - the submitted item attribute name/value pairs

validateOptionValueIsAllowed

protected void validateOptionValueIsAllowed(ProductOption productOption,
 String attributeValue)

Rejects a value that is not one of the option's allowed values. Only applies to enumerated options, i.e. those with a non-empty ProductOption.getAllowedValues(). Non-enumerated option types (NON_ENUMERATED_OPTION_TYPES, e.g. a text or date input) are excluded, since their value is entered freely rather than chosen from a list. A missing value is allowed here, since the required check is handled by validate(ProductOption, String).

isNonEnumeratedOptionType

protected boolean isNonEnumeratedOptionType(ProductOption productOption)

isRequiredAttributeNotProvided

protected boolean isRequiredAttributeNotProvided(ProductOption productOption,
 String attributeValue)

requiresValidation

protected boolean requiresValidation(ProductOption productOption,
 String value)

validateRegex

protected Boolean validateRegex(String regex,
 String value)

hasProductOptionValidationStrategy

public boolean hasProductOptionValidationStrategy(ProductOption productOption)

Specified by:

hasProductOptionValidationStrategy in interface ProductOptionValidationService

isSubmitType

public boolean isSubmitType(ProductOption productOption)

Specified by:

isSubmitType in interface ProductOptionValidationService

isAddOrNoneType

public boolean isAddOrNoneType(ProductOption productOption)

Specified by:

isAddOrNoneType in interface ProductOptionValidationService

validateWithoutException

public void validateWithoutException(ProductOption productOption,
 String attributeValue,
 ActivityMessages messages)

Specified by:

validateWithoutException in interface ProductOptionValidationService

findSkuIdsForProductOptionValues

public List<Long> findSkuIdsForProductOptionValues(Long productId,
 String attributeName,
 String attributeValue,
 List<Long> possibleSkuIds)

Specified by:

findSkuIdsForProductOptionValues in interface ProductOptionValidationService