Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2.7] Close #1806 - Have to the ability to dynamically set the Validation Group during a transaction #2010

Draft
wants to merge 1 commit into
base: 2.7
Choose a base branch
from
Draft

[2.7] Close #1806 - Have to the ability to dynamically set the Validation Group during a transaction #2010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions ....eclipse.persistence.core/src/org/eclipse/persistence/config/EntityManagerProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,21 @@ public class EntityManagerProperties {
* )
*/
public static final String COMPOSITE_UNIT_PROPERTIES = PersistenceUnitProperties.COMPOSITE_UNIT_PROPERTIES;

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are properties bellow limited to EntityManager only or should be defined in PersistenceUnit scope?
I think, that PersistenceUnit scope should be used. Please check e.g. how PU property is stored and handled
#1790 (foundation/org.eclipse.persistence.core/src/org/eclipse/persistence/sessions/Project.java, jpa/org.eclipse.persistence.jpa/src/org/eclipse/persistence/internal/jpa/EntityManagerSetupImpl.java, foundation/org.eclipse.persistence.core/src/org/eclipse/persistence/config/PersistenceUnitProperties.java)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I intended them to be Entity Manager Properties, since we could allow them to be changed in a transaction. I believe the PersistenceUnit already has support for this feature, but it can't be changed dynamically, hence the reason for this enhancement. I hope that makes sense! Please let me know if it doesn't or if my reasoning is not correct.

/**
* Overrides the Bean Validation Group(s) that will execute during a prePersist event. This should be a class or class[].
*/
public static final String VALIDATION_GROUP_PRE_PERSIST = "eclipselink.validation.group.prePersist";

/**
* Overrides the Bean Validation Group(s) that will execute during a preUpdate event. This should be a class or class[].
*/
public static final String VALIDATION_GROUP_PRE_UPDATE = "eclipselink.validation.group.preUpdate";

/**
* Overrides the Bean Validation Group(s) that will execute during a preRemove event. This should be a class or class[].
*/
public static final String VALIDATION_GROUP_PRE_REMOVE = "eclipselink.validation.group.preRemove";

private static final Set<String> supportedProperties = new HashSet<String>() {

Expand All @@ -344,6 +359,9 @@ public class EntityManagerProperties {
add(PERSISTENCE_CONTEXT_COMMIT_ORDER);
add(FLUSH_CLEAR_CACHE);
add(COMPOSITE_UNIT_PROPERTIES);
add(VALIDATION_GROUP_PRE_PERSIST);
add(VALIDATION_GROUP_PRE_UPDATE);
add(VALIDATION_GROUP_PRE_REMOVE);
}
};

Expand Down
48 changes: 39 additions & 9 deletions ...a/src/org/eclipse/persistence/internal/jpa/metadata/listeners/BeanValidationListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,20 @@
import javax.validation.ValidatorFactory;
import javax.validation.groups.Default;

import org.eclipse.persistence.config.EntityManagerProperties;
import org.eclipse.persistence.config.PersistenceUnitProperties;
import org.eclipse.persistence.descriptors.ClassDescriptor;
import org.eclipse.persistence.descriptors.DescriptorEvent;
import org.eclipse.persistence.descriptors.DescriptorEventAdapter;
import org.eclipse.persistence.descriptors.FetchGroupManager;
import org.eclipse.persistence.exceptions.BeanValidationException;
import org.eclipse.persistence.internal.localization.ExceptionLocalization;
import org.eclipse.persistence.internal.security.PrivilegedAccessHelper;
import org.eclipse.persistence.internal.sessions.UnitOfWorkImpl;
import org.eclipse.persistence.mappings.DatabaseMapping;
import org.eclipse.persistence.mappings.ForeignReferenceMapping;


/**
* Responsible for performing automatic bean validation on call back events.
* @author Mitesh Meswani
Expand All @@ -72,7 +75,7 @@ public BeanValidationListener(ValidatorFactory validatorFactory, Class[] groupPr

@Override
public void prePersist (DescriptorEvent event) {
// since we are using prePersist to perform validation, invlid data may get inserted into database as shown by
// since we are using prePersist to perform validation, invalid data may get inserted into database as shown by
// following example
// tx.begin()
// e = new MyEntity(...);
Expand All @@ -81,19 +84,38 @@ public void prePersist (DescriptorEvent event) {
// tx.commit();
// "invalid data" would get inserted into database.
//
// preInsert can be used to work around above issue. Howerver, the JPA spec does not itent it.
// preInsert can be used to work around above issue. However, the JPA spec does not itent it.
// This might be corrected in next iteration of spec
validateOnCallbackEvent(event, "prePersist", groupPrePersit);
Object overrideGroups = event.getSession().getParent().getProperties().get(EntityManagerProperties.VALIDATION_GROUP_PRE_PERSIST);
if (overrideGroups != null) {
if (overrideGroups instanceof Class) {
overrideGroups = new Class[] { (Class) overrideGroups };
} else if (!(overrideGroups instanceof Class[])) {
throw new BeanValidationException("prePersist validation group must be a Class or Class Array:" + overrideGroups);
}
validateOnCallbackEvent(event, "prePersist", (Class[]) overrideGroups);
} else {
validateOnCallbackEvent(event, "prePersist", groupPrePersit);
}
}

@Override
public void aboutToUpdate(DescriptorEvent event) {
Object source = event.getSource();
UnitOfWorkImpl unitOfWork = (UnitOfWorkImpl )event.getSession();
// preUpdate is also generated for deleted objects that were modified in this UOW.
// Do not perform preUpdate validation for such objects as preRemove would have already been called.
if(!unitOfWork.isObjectDeleted(source)) {
validateOnCallbackEvent(event, "preUpdate", groupPreUpdate);
if (!unitOfWork.isObjectDeleted(source)) {
Object overrideGroups = event.getSession().getParent().getProperties().get(EntityManagerProperties.VALIDATION_GROUP_PRE_UPDATE);
if (overrideGroups != null) {
if (overrideGroups instanceof Class) {
overrideGroups = new Class[] { (Class) overrideGroups };
} else if (!(overrideGroups instanceof Class[])) {
throw new BeanValidationException("preUpdate validation group must be a Class or Class Array:" + overrideGroups);
}
validateOnCallbackEvent(event, "preUpdate", (Class[]) overrideGroups);
} else {
validateOnCallbackEvent(event, "preUpdate", groupPreUpdate);
}
}
}

Expand All @@ -104,9 +126,17 @@ public void preUpdateWithChanges(DescriptorEvent event) {

@Override
public void preRemove (DescriptorEvent event) {
if(groupPreRemove != null) { //No validation performed on preRemove if user has not explicitly specified a validation group
validateOnCallbackEvent(event, "preRemove", groupPreRemove);
}
Object overrideGroups = event.getSession().getParent().getProperties().get(EntityManagerProperties.VALIDATION_GROUP_PRE_REMOVE);
if (overrideGroups != null) {
if (overrideGroups instanceof Class) {
overrideGroups = new Class[] { (Class) overrideGroups };
} else if (!(overrideGroups instanceof Class[])) {
throw new BeanValidationException("preRemove validation group must be a Class or Class Array:" + overrideGroups);
}
validateOnCallbackEvent(event, "preRemove", (Class[]) overrideGroups);
} else if (groupPreRemove != null) { // No validation performed on preRemove if user has not explicitly specified a validation group
validateOnCallbackEvent(event, "preRemove", groupPreRemove);
}
}

private void validateOnCallbackEvent(DescriptorEvent event, String callbackEventName, Class[] validationGroup) {
Expand Down