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

Class RegexPropertyValidator

java.lang.Object

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

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

All Implemented Interfaces:

PropertyValidator

@Component("blRegexPropertyValidator")
public class RegexPropertyValidator
extends ValidationConfigurationBasedPropertyValidator

Validates a field against a configured 'regularExpression' item

Author:

Phillip Verheyden

Field Summary

Fields

Modifier and Type	Field	Description
protected org.broadleafcommerce.common.security.service.ExploitProtectionService	exploitProtectionService
protected static final org.apache.commons.logging.Log	LOG
protected boolean	succeedForInvalidRegex	Whether or not this validator should succeed (and thus pass validation) even when the configured regular expression pattern is invalid.
protected boolean	succeedForNullValues	Denotes what should occur when this validator encounters a null value to validate against.

Constructor Summary

Constructors

Constructor	Description
RegexPropertyValidator()

Method Summary

Modifier and Type	Method	Description
protected org.broadleafcommerce.common.security.service.ExploitProtectionService	initExploitProtectionService()
boolean	isSucceedForInvalidRegex()
boolean	isSucceedForNullValues()
void	setSucceedForInvalidRegex(boolean succeedForInvalidRegex)
void	setSucceedForNullValues(boolean succeedForNullValues)
PropertyValidationResult	validate(Entity entity, Serializable instance, Map<String,FieldMetadata> entityFieldMetadata, Map<String,String> validationConfiguration, BasicFieldMetadata propertyMetadata, String propertyName, String value)	Validates a property for an entity

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 Details

LOG

protected static final org.apache.commons.logging.Log LOG

succeedForNullValues

protected boolean succeedForNullValues

Denotes what should occur when this validator encounters a null value to validate against. Default behavior is to allow them, which means that this validator will always return true with null values

succeedForInvalidRegex

protected boolean succeedForInvalidRegex

Whether or not this validator should succeed (and thus pass validation) even when the configured regular expression pattern is invalid. While this value defaults to true, it might be beneficial to set this to false in a development environment to debug problems in regular expressions. In either case, this validator will log that there is an invalid regular expression

exploitProtectionService

protected org.broadleafcommerce.common.security.service.ExploitProtectionService exploitProtectionService

Constructor Details

RegexPropertyValidator

public RegexPropertyValidator()

Method Details

validate

public PropertyValidationResult validate(Entity entity,
 Serializable instance,
 Map<String,FieldMetadata> entityFieldMetadata,
 Map<String,String> validationConfiguration,
 BasicFieldMetadata propertyMetadata,
 String propertyName,
 String value)

Description copied from interface: PropertyValidator

Validates a property for an entity

Specified by:

validate in interface PropertyValidator

Overrides:

validate in class ValidationConfigurationBasedPropertyValidator

Parameters:

entity - Entity DTO of the entity attempting to save

instance - actual object representation of entity. This can be cast to entity interfaces (like Sku or Product)

entityFieldMetadata - complete field metadata for all properties in entity

validationConfiguration - the map represented by the set of ConfigurationItem for a ValidationConfiguration on a property. This map could be null if this PropertyValidator is being invoked outside of the context of a particular property (like a global validator)

propertyMetadata - BasicFieldMetadata corresponding to the property that is being valid

propertyName - the property name of the value attempting to be saved (could be a sub-entity obtained via dot notation like 'defaultSku.name')

value - the value attempted to be saved

Returns:

true if this passes validation, false otherwise.

initExploitProtectionService

protected org.broadleafcommerce.common.security.service.ExploitProtectionService initExploitProtectionService()
                                                                                                       throws org.broadleafcommerce.common.exception.ServiceException

Throws:

org.broadleafcommerce.common.exception.ServiceException

isSucceedForNullValues

public boolean isSucceedForNullValues()

setSucceedForNullValues

public void setSucceedForNullValues(boolean succeedForNullValues)

isSucceedForInvalidRegex

public boolean isSucceedForInvalidRegex()

setSucceedForInvalidRegex

public void setSucceedForInvalidRegex(boolean succeedForInvalidRegex)