HHH-17612 Separate envers entity types for default revision entities from mapped-superclasses

Author: mbellade

hibernate-envers/src/main/java/org/hibernate/envers/configuration/internal/RevisionInfoConfiguration.java

@@ -34,6 +34,10 @@
 import org.hibernate.envers.enhanced.SequenceIdTrackingModifiedEntitiesRevisionEntity;
 import org.hibernate.envers.internal.entities.PropertyData;
 import org.hibernate.envers.internal.entities.RevisionTimestampData;
+import org.hibernate.envers.internal.entities.mappings.DefaultRevisionEntityImpl;
+import org.hibernate.envers.internal.entities.mappings.DefaultTrackingModifiedEntitiesRevisionEntityImpl;
+import org.hibernate.envers.internal.entities.mappings.enhanced.SequenceIdRevisionEntityImpl;
+import org.hibernate.envers.internal.entities.mappings.enhanced.SequenceIdTrackingModifiedEntitiesRevisionEntityImpl;
 import org.hibernate.envers.internal.revisioninfo.DefaultRevisionInfoGenerator;
 import org.hibernate.envers.internal.revisioninfo.DefaultTrackingModifiedEntitiesRevisionInfoGenerator;
 import org.hibernate.envers.internal.revisioninfo.ModifiedEntityNamesReader;
@@ -388,14 +392,14 @@ private void locateRevisionEntityMapping() {
 
 				if ( configuration.isTrackEntitiesChanged() ) {
 					revisionInfoClass = configuration.isNativeIdEnabled()
-							? DefaultTrackingModifiedEntitiesRevisionEntity.class
-							: SequenceIdTrackingModifiedEntitiesRevisionEntity.class;
+							? DefaultTrackingModifiedEntitiesRevisionEntityImpl.class
+							: SequenceIdTrackingModifiedEntitiesRevisionEntityImpl.class;
 					revisionInfoEntityName = revisionInfoClass.getName();
 				}
 				else {
 					revisionInfoClass = configuration.isNativeIdEnabled()
-							? DefaultRevisionEntity.class
-							: SequenceIdRevisionEntity.class;
+							? DefaultRevisionEntityImpl.class
+							: SequenceIdRevisionEntityImpl.class;
 				}
 
 				timestampValueResolver = createRevisionTimestampResolver(

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mappings/DefaultRevisionEntityImpl.java

@@ -0,0 +1,15 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.envers.internal.entities.mappings;
+
+import jakarta.persistence.Entity;
+import org.hibernate.envers.DefaultRevisionEntity;
+
+/**
+ * @author Marco Belladelli
+ */
+@Entity
+public class DefaultRevisionEntityImpl extends DefaultRevisionEntity {
+}

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mappings/DefaultTrackingModifiedEntitiesRevisionEntityImpl.java

@@ -0,0 +1,15 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.envers.internal.entities.mappings;
+
+import jakarta.persistence.Entity;
+import org.hibernate.envers.DefaultTrackingModifiedEntitiesRevisionEntity;
+
+/**
+ * @author Marco Belladelli
+ */
+@Entity
+public class DefaultTrackingModifiedEntitiesRevisionEntityImpl extends DefaultTrackingModifiedEntitiesRevisionEntity {
+}

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mappings/enhanced/SequenceIdRevisionEntityImpl.java

@@ -0,0 +1,15 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.envers.internal.entities.mappings.enhanced;
+
+import jakarta.persistence.Entity;
+import org.hibernate.envers.enhanced.SequenceIdRevisionEntity;
+
+/**
+ * @author Marco Belladelli
+ */
+@Entity
+public class SequenceIdRevisionEntityImpl extends SequenceIdRevisionEntity {
+}

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mappings/enhanced/SequenceIdTrackingModifiedEntitiesRevisionEntityImpl.java

@@ -0,0 +1,15 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.envers.internal.entities.mappings.enhanced;
+
+import jakarta.persistence.Entity;
+import org.hibernate.envers.enhanced.SequenceIdTrackingModifiedEntitiesRevisionEntity;
+
+/**
+ * @author Marco Belladelli
+ */
+@Entity
+public class SequenceIdTrackingModifiedEntitiesRevisionEntityImpl extends SequenceIdTrackingModifiedEntitiesRevisionEntity {
+}

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mappings/package-info.java

@@ -0,0 +1,17 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+
+/**
+ * Contains empty implementations that are the {@link jakarta.persistence.Entity entity}
+ * subtypes, simply inheriting from the default revision entities which are mapped as
+ * {@link jakarta.persistence.MappedSuperclass mapped-superclass}es.
+ * <p>
+ * This is needed to allow for the correct injection of the static-metamodel {@code class_}
+ * meta-type field of both the default revision entities and the mapped-superclass from which
+ * custom ones might extend from.
+ *
+ * @author Marco Belladelli
+ */
+package org.hibernate.envers.internal.entities.mappings;

hibernate-envers/src/test/java/org/hibernate/orm/test/envers/integration/reventity/removal/AbstractRevisionEntityRemovalTest.java

@@ -34,8 +34,7 @@ protected void addConfigOptions(Map options) {
 	@Override
 	protected Class<?>[] getAnnotatedClasses() {
 		return new Class<?>[] {
-				StrTestEntity.class, ListOwnedEntity.class, ListOwningEntity.class,
-				getRevisionEntityClass()
+				StrTestEntity.class, ListOwnedEntity.class, ListOwningEntity.class
 		};
 	}
 

hibernate-envers/src/test/java/org/hibernate/orm/test/envers/integration/reventity/removal/RemoveTrackingRevisionEntity.java

@@ -6,8 +6,8 @@
 
 import java.util.Map;
 
-import org.hibernate.envers.enhanced.SequenceIdTrackingModifiedEntitiesRevisionEntity;
 
+import org.hibernate.envers.internal.entities.mappings.enhanced.SequenceIdTrackingModifiedEntitiesRevisionEntityImpl;
 import org.hibernate.testing.DialectChecks;
 import org.hibernate.testing.RequiresDialectFeature;
 
@@ -24,6 +24,6 @@ public void addConfigOptions(Map configuration) {
 
 	@Override
 	protected Class<?> getRevisionEntityClass() {
-		return SequenceIdTrackingModifiedEntitiesRevisionEntity.class;
+		return SequenceIdTrackingModifiedEntitiesRevisionEntityImpl.class;
 	}
 }