com.broadleafcommerce.enterprise.workflow.transform

Class SandBoxFieldConfigValidator

java.lang.Object

com.broadleafcommerce.enterprise.workflow.transform.SandBoxFieldConfigValidator

All Implemented Interfaces:

EventListener, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

@Service(value="blSandboxFieldConfigValidator")
public class SandBoxFieldConfigValidator
extends Object
implements org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

Validate a sandboxable field detected on all sandboxable entities.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.persistence.EntityConfiguration	entityConfiguration
protected javax.persistence.EntityManager	entityManager
protected javax.persistence.EntityManagerFactory	entityManagerFactory

Constructor Summary

Constructors

Constructor and Description
SandBoxFieldConfigValidator()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkIgnore(Field field) Check if Field should be ignored or excluded
protected Annotation	getAnnotationForClass(List<Annotation> annotationsToCheck, Class clazz) Returns the Annotation that is of the specified Class.
protected Annotation	getAnnotationWithQuanityRule(List<Annotation> annotationsToCheck) Returns the Annotation that has SupportedFieldType.RULE_WITH_QUANTITY
protected List<Annotation>	getMapAnnotations(List<Annotation> annotationsToCheck) Returns List of Annotation that are of type AdminPresentationMap or AdminPresentationMapFields
protected Class	getTargetedEntity(Annotation[] annotations) Returns the targetEntity of a field.
protected boolean	hasCollectionAnnotation(List<Annotation> annotationsToCheck) Iterates to see if any Annotation indicates that the field is a collection.
protected boolean	isMapAnnotation(Annotation annotation)
void	onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)
protected void	validateField(Field field, Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls) Validate field against their annotations using standard reflection
protected void	validateMapCollectionConfigs(Field field, Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls, List<Annotation> annotations, Class targetedEntity) Validates fields that are annotated with AdminPresentationMapFields or AdminPresentationMap have a specified toOneParentProperty and a toOneTargetPropery.
protected void	validateOneToMany(Field field, Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls, Annotation annotation) Validates that an OneToMany field has properties OneToMany.mappedBy() and OneToMany.targetEntity().
protected void	validateQuantityRule(Field field, Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls, Annotation annotation, Class targetedEntity) Validate that the QuantityBasedRule interface is implemented for quantity rule types
protected void	validateTargetDirectCopyTransformConfig(Field field, Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls, Class targetedEntity) Validate that the target entity for a field is sandboxable

Methods inherited from class java.lang.Object

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

Field Detail

entityManagerFactory

protected javax.persistence.EntityManagerFactory entityManagerFactory

entityConfiguration

protected org.broadleafcommerce.common.persistence.EntityConfiguration entityConfiguration

entityManager

protected javax.persistence.EntityManager entityManager

Constructor Detail

SandBoxFieldConfigValidator

public SandBoxFieldConfigValidator()

Method Detail

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

validateField

protected void validateField(Field field,
                             Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls)
                      throws IllegalArgumentException

Validate field against their annotations using standard reflection

Parameters:

field -

cls -

Throws:

IllegalArgumentException

getAnnotationWithQuanityRule

protected Annotation getAnnotationWithQuanityRule(List<Annotation> annotationsToCheck)

Returns the Annotation that has SupportedFieldType.RULE_WITH_QUANTITY

Parameters:

annotationsToCheck -

Returns:

getAnnotationForClass

protected Annotation getAnnotationForClass(List<Annotation> annotationsToCheck,
                                           Class clazz)

Returns the Annotation that is of the specified Class. Once the annotation is found, it is removed from the list so that algorithmic complexity is reduced for all other functions that use the same list.

Parameters:

annotationsToCheck -

clazz -

Returns:

getMapAnnotations

protected List<Annotation> getMapAnnotations(List<Annotation> annotationsToCheck)

Returns List of Annotation that are of type AdminPresentationMap or AdminPresentationMapFields

Parameters:

annotationsToCheck -

Returns:

isMapAnnotation

protected boolean isMapAnnotation(Annotation annotation)

Parameters:

annotation -

Returns:

hasCollectionAnnotation

protected boolean hasCollectionAnnotation(List<Annotation> annotationsToCheck)

Iterates to see if any Annotation indicates that the field is a collection.

Parameters:

annotationsToCheck -

Returns:

getTargetedEntity

protected Class getTargetedEntity(Annotation[] annotations)

Returns the targetEntity of a field. If none exist, returns null.

Parameters:

annotations -

Returns:

validateMapCollectionConfigs

protected void validateMapCollectionConfigs(Field field,
                                            Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls,
                                            List<Annotation> annotations,
                                            Class targetedEntity)
                                     throws IllegalArgumentException

Validates fields that are annotated with AdminPresentationMapFields or AdminPresentationMap have a specified toOneParentProperty and a toOneTargetPropery. If the properties are stored in an AdminPresentationMapFields annotation, then check that target entity implements SimpleRule

Parameters:

field -

cls -

annotations -

targetedEntity -

Throws:

IllegalArgumentException

validateQuantityRule

protected void validateQuantityRule(Field field,
                                    Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls,
                                    Annotation annotation,
                                    Class targetedEntity)
                             throws IllegalArgumentException

Validate that the QuantityBasedRule interface is implemented for quantity rule types

Parameters:

field -

cls -

annotation -

targetedEntity -

Throws:

IllegalArgumentException

validateTargetDirectCopyTransformConfig

protected void validateTargetDirectCopyTransformConfig(Field field,
                                                       Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls,
                                                       Class targetedEntity)
                                                throws IllegalArgumentException

Validate that the target entity for a field is sandboxable

Parameters:

field -

cls -

targetedEntity -

Throws:

IllegalArgumentException

validateOneToMany

protected void validateOneToMany(Field field,
                                 Class<com.broadleafcommerce.enterprise.common.domain.SandBoxDiscriminator> cls,
                                 Annotation annotation)
                          throws IllegalArgumentException

Validates that an OneToMany field has properties OneToMany.mappedBy() and OneToMany.targetEntity(). Also validates that the targetEntity is annotated with ManyToOne on the corresponding field being mappedBy.

Parameters:

field -

cls -

annotation -

Throws:

IllegalArgumentException

checkIgnore

protected boolean checkIgnore(Field field)

Check if Field should be ignored or excluded

Parameters:

field -

Returns: