HHH-13361 Allow auditing entities with nested identifiers

Author: Naros

hibernate-envers/src/main/java/org/hibernate/envers/configuration/internal/metadata/IdMetadataGenerator.java

@@ -24,6 +24,7 @@
 import org.hibernate.envers.internal.entities.mapper.id.EmbeddedIdMapper;
 import org.hibernate.envers.internal.entities.mapper.id.IdMapper;
 import org.hibernate.envers.internal.entities.mapper.id.MultipleIdMapper;
+import org.hibernate.envers.internal.entities.mapper.id.NestedEmbeddedIdMapper;
 import org.hibernate.envers.internal.entities.mapper.id.SimpleIdMapperBuilder;
 import org.hibernate.envers.internal.entities.mapper.id.SingleIdMapper;
 import org.hibernate.loader.PropertyPath;
@@ -32,6 +33,7 @@
 import org.hibernate.mapping.Property;
 import org.hibernate.mapping.ToOne;
 import org.hibernate.mapping.Value;
+import org.hibernate.type.ComponentType;
 import org.hibernate.type.ManyToOneType;
 import org.hibernate.type.Type;
 
@@ -63,7 +65,8 @@ private boolean addIdProperty(
 			boolean key,
 			SimpleIdMapperBuilder mapper,
 			Property mappedProperty,
-			Property virtualProperty) {
+			Property virtualProperty,
+			boolean audited) {
 
 		if ( PropertyPath.IDENTIFIER_MAPPER_PROPERTY.equals( mappedProperty.getName() ) ) {
 			return false;
@@ -93,6 +96,19 @@ private boolean addIdProperty(
 
 			return added;
 		}
+		else if ( ComponentType.class.isInstance( mappedProperty.getType() ) ) {
+			final Component component = (Component) mappedProperty.getValue();
+			final NestedEmbeddedIdMapper nestedMapper;
+			if ( mapper != null ) {
+				final PropertyData propertyData = propertyAuditingData.resolvePropertyData();
+				nestedMapper = new NestedEmbeddedIdMapper( propertyData, component );
+				mapper.add( propertyData, nestedMapper );
+			}
+			else {
+				nestedMapper = null;
+			}
+			return addIdProperties( attributeContainer, component, null, nestedMapper, key, audited );
+		}
 
 		return addBasic( attributeContainer, propertyAuditingData, mappedProperty.getValue(), mapper, key );
 	}
@@ -116,7 +132,7 @@ private boolean addIdProperties(
 				virtualProperty = null;
 			}
 
-			if ( !addIdProperty( attributeContainer, key, mapper, property, virtualProperty ) ) {
+			if ( !addIdProperty( attributeContainer, key, mapper, property, virtualProperty, audited ) ) {
 				// If the entity is audited, and a non-supported id component is used, throw exception.
 				if ( audited ) {
 					throw new EnversMappingException(
@@ -196,7 +212,7 @@ public IdMappingData addIdAndGetMappingData(PersistentClass persistentClass, boo
 		if ( idMapper != null ) {
 			// Multiple id
 			final Component virtualComponent = (Component) persistentClass.getIdentifier();
-			mapper = new MultipleIdMapper( loadClass( virtualComponent ), persistentClass.getServiceRegistry() );
+			mapper = new MultipleIdMapper( virtualComponent );
 
 			if ( !addIdProperties( relation, idMapper, virtualComponent, mapper, false, audited ) ) {
 				return null;
@@ -210,8 +226,7 @@ public IdMappingData addIdAndGetMappingData(PersistentClass persistentClass, boo
 		else if ( idProp.isComposite() ) {
 			// Embedded id
 			final Component idComponent = (Component) idProp.getValue();
-			final Class<?> embeddableClass = loadClass( idComponent );
-			mapper = new EmbeddedIdMapper( getIdPropertyData( idProp ), embeddableClass, persistentClass.getServiceRegistry() );
+			mapper = new EmbeddedIdMapper( getIdPropertyData( idProp ), idComponent );
 
 			if ( !addIdProperties( relation, idComponent, null, mapper, false, audited ) ) {
 				return null;

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/AbstractCompositeIdMapper.java

@@ -17,23 +17,31 @@
 import org.hibernate.service.ServiceRegistry;
 
 /**
+ * An abstract identifier mapper implementation specific for composite identifiers.
+ *
  * @author Adam Warski (adam at warski dot org)
  * @author Lukasz Antoniak (lukasz dot antoniak at gmail dot com)
+ * @author Chris Cranford
  */
 public abstract class AbstractCompositeIdMapper extends AbstractIdMapper implements SimpleIdMapperBuilder {
-	protected final Class compositeIdClass;
+	protected final Class<?> compositeIdClass;
 
-	protected Map<PropertyData, SingleIdMapper> ids;
+	protected Map<PropertyData, AbstractIdMapper> ids;
 
-	protected AbstractCompositeIdMapper(Class compositeIdClass, ServiceRegistry serviceRegistry) {
+	protected AbstractCompositeIdMapper(Class<?> compositeIdClass, ServiceRegistry serviceRegistry) {
 		super( serviceRegistry );
 		this.compositeIdClass = compositeIdClass;
 		ids = Tools.newLinkedHashMap();
 	}
 
 	@Override
 	public void add(PropertyData propertyData) {
-		ids.put( propertyData, new SingleIdMapper( getServiceRegistry(), propertyData ) );
+		add( propertyData, new SingleIdMapper( getServiceRegistry(), propertyData ) );
+	}
+
+	@Override
+	public void add(PropertyData propertyData, AbstractIdMapper idMapper) {
+		ids.put( propertyData, idMapper );
 	}
 
 	@Override
@@ -43,7 +51,7 @@ public Object mapToIdFromMap(Map data) {
 		}
 
 		final Object compositeId = instantiateCompositeId();
-		for ( SingleIdMapper mapper : ids.values() ) {
+		for ( AbstractIdMapper mapper : ids.values() ) {
 			if ( !mapper.mapToEntityFromMap( compositeId, data ) ) {
 				return null;
 			}
@@ -52,6 +60,11 @@ public Object mapToIdFromMap(Map data) {
 		return compositeId;
 	}
 
+	@Override
+	public void mapToEntityFromEntity(Object objectTo, Object objectFrom) {
+		// no-op; does nothing
+	}
+
 	protected Object instantiateCompositeId() {
 		return AccessController.doPrivileged(
 				new PrivilegedAction<Object>() {

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/AbstractIdMapper.java

@@ -13,6 +13,8 @@
 import org.hibernate.service.ServiceRegistry;
 
 /**
+ * The base abstract class implementation for identifier mappers.
+ *
  * @author Adam Warski (adam at warski dot org)
  * @author Chris Cranford
  */
@@ -139,6 +141,8 @@ public void addNamedIdEqualsToQuery(Parameters parameters, String prefix1, IdMap
 		}
 	}
 
+	public abstract void mapToEntityFromEntity(Object objectTo, Object objectFrom);
+
 	private void handleNullValue(Parameters parameters, String alias, String propertyName, boolean equals) {
 		if ( equals ) {
 			parameters.addNullRestriction( alias, propertyName );

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/EmbeddedIdMapper.java

@@ -16,19 +16,27 @@
 import org.hibernate.envers.exception.AuditException;
 import org.hibernate.envers.internal.entities.PropertyData;
 import org.hibernate.envers.internal.tools.ReflectionTools;
+import org.hibernate.mapping.Component;
 import org.hibernate.property.access.spi.Getter;
 import org.hibernate.property.access.spi.Setter;
 import org.hibernate.service.ServiceRegistry;
 
 /**
+ * An identifier mapper implementation for {@link jakarta.persistence.EmbeddedId} mappings.
+ *
  * @author Adam Warski (adam at warski dot org)
+ * @author Chris Cranford
  */
 public class EmbeddedIdMapper extends AbstractCompositeIdMapper implements SimpleIdMapperBuilder {
 	private PropertyData idPropertyData;
 
-	public EmbeddedIdMapper(PropertyData idPropertyData, Class compositeIdClass, ServiceRegistry serviceRegistry) {
-		super( compositeIdClass, serviceRegistry );
+	public EmbeddedIdMapper(PropertyData propertyData, Component component) {
+		super( component.getComponentClass(), component.getServiceRegistry() );
+		this.idPropertyData = propertyData;
+	}
 
+	private EmbeddedIdMapper(PropertyData idPropertyData, Class<?> compositeIdClass, ServiceRegistry serviceRegistry) {
+		super( compositeIdClass, serviceRegistry );
 		this.idPropertyData = idPropertyData;
 	}
 

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/IdMapper.java

@@ -14,6 +14,8 @@
 import org.hibernate.service.ServiceRegistry;
 
 /**
+ * Base contract for all identifier mappers.
+ *
  * @author Adam Warski (adam at warski dot org)
  * @author Chris Cranford
  */

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/MultipleIdMapper.java

@@ -13,14 +13,23 @@
 
 import org.hibernate.Session;
 import org.hibernate.envers.internal.entities.PropertyData;
+import org.hibernate.mapping.Component;
 import org.hibernate.service.ServiceRegistry;
 
 /**
+ * An implementation of an identifier mapper for {@link jakarta.persistence.IdClass} or multiple
+ * {@link jakarta.persistence.Id} identifier mappings.
+ *
  * @author Adam Warski (adam at warski dot org)
  * @author Chris Cranford
  */
 public class MultipleIdMapper extends AbstractCompositeIdMapper implements SimpleIdMapperBuilder {
-	public MultipleIdMapper(Class compositeIdClass, ServiceRegistry serviceRegistry) {
+
+	public MultipleIdMapper(Component component) {
+		super( component.getComponentClass(), component.getServiceRegistry() );
+	}
+
+	private MultipleIdMapper(Class<?> compositeIdClass, ServiceRegistry serviceRegistry) {
 		super( compositeIdClass, serviceRegistry );
 	}
 
@@ -32,9 +41,9 @@ public void add(PropertyData propertyData) {
 	@Override
 	public void mapToMapFromId(Session session, Map<String, Object> data, Object obj) {
 		if ( compositeIdClass.isInstance( obj ) ) {
-			for ( Map.Entry<PropertyData, SingleIdMapper> entry : ids.entrySet() ) {
+			for ( Map.Entry<PropertyData, AbstractIdMapper> entry : ids.entrySet() ) {
 				final PropertyData propertyData = entry.getKey();
-				final SingleIdMapper idMapper = entry.getValue();
+				final AbstractIdMapper idMapper = entry.getValue();
 
 				if ( propertyData.getVirtualReturnClass() == null ) {
 					idMapper.mapToMapFromEntity( data, obj );
@@ -92,7 +101,7 @@ public Object mapToIdFromEntity(Object data) {
 		}
 
 		final Object compositeId = instantiateCompositeId();
-		for ( SingleIdMapper mapper : ids.values() ) {
+		for ( AbstractIdMapper mapper : ids.values() ) {
 			mapper.mapToEntityFromEntity( compositeId, data );
 		}
 

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/NestedEmbeddedIdMapper.java

@@ -0,0 +1,22 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.envers.internal.entities.mapper.id;
+
+import org.hibernate.envers.internal.entities.PropertyData;
+import org.hibernate.mapping.Component;
+
+/**
+ * An identifier mapper that is meant to support nested {@link jakarta.persistence.Embeddable} instances
+ * inside an existing {@link jakarta.persistence.EmbeddedId} identifier hierarchy.
+ *
+ * @author Chris Cranford
+ */
+public class NestedEmbeddedIdMapper extends EmbeddedIdMapper {
+	public NestedEmbeddedIdMapper(PropertyData propertyData, Component component) {
+		super( propertyData, component );
+	}
+}

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/SimpleIdMapperBuilder.java

@@ -6,10 +6,21 @@
  */
 package org.hibernate.envers.internal.entities.mapper.id;
 
+import org.hibernate.envers.internal.entities.PropertyData;
 import org.hibernate.envers.internal.entities.mapper.SimpleMapperBuilder;
 
 /**
+ * A simple identifier builder contract.
+ *
  * @author Adam Warski (adam at warski dot org)
+ * @author Chris Cranford
  */
 public interface SimpleIdMapperBuilder extends IdMapper, SimpleMapperBuilder {
+	/**
+	 * Add a custom identifier mapper to the builder.
+	 *
+	 * @param propertyData the property data
+	 * @param idMapper the mapper
+	 */
+	void add(PropertyData propertyData, AbstractIdMapper idMapper);
 }

hibernate-envers/src/main/java/org/hibernate/envers/internal/entities/mapper/id/SingleIdMapper.java

@@ -21,7 +21,10 @@
 import org.hibernate.service.ServiceRegistry;
 
 /**
+ * An implementation of an identifier mapper for a single basic attribute property.
+ *
  * @author Adam Warski (adam at warski dot org)
+ * @author Chris Cranford
  */
 public class SingleIdMapper extends AbstractIdMapper implements SimpleIdMapperBuilder {
 	private PropertyData propertyData;
@@ -44,6 +47,11 @@ public void add(PropertyData propertyData) {
 		this.propertyData = propertyData;
 	}
 
+	@Override
+	public void add(PropertyData propertyData, AbstractIdMapper idMapper) {
+		throw new AuditException( "This method is not allowed for a single identifier mapper" );
+	}
+
 	@Override
 	public boolean mapToEntityFromMap(final Object obj, Map data) {
 		if ( data == null || obj == null ) {
@@ -143,6 +151,7 @@ public Object run() {
 		}
 	}
 
+	@Override
 	public void mapToEntityFromEntity(final Object objTo, final Object objFrom) {
 		if ( objTo == null || objFrom == null ) {
 			return;

hibernate-envers/src/test/java/org/hibernate/orm/test/envers/integration/ids/embeddedid/CompositeEntity.java

@@ -0,0 +1,71 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.orm.test.envers.integration.ids.embeddedid;
+
+import java.util.Set;
+
+import jakarta.persistence.Access;
+import jakarta.persistence.AccessType;
+import jakarta.persistence.EmbeddedId;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.OneToMany;
+import jakarta.persistence.Table;
+
+import org.hibernate.envers.Audited;
+
+@Entity
+@Audited
+@Table(name = "compositeentity")
+@Access(value = AccessType.FIELD)
+public class CompositeEntity {
+
+	@EmbeddedId
+	private CompositeEntityId codeObject = new CompositeEntityId();
+
+	@OneToMany(targetEntity = OwnerOfRelationCode.class, fetch = FetchType.LAZY, mappedBy = "compositeEntity")
+	private Set<OwnerOfRelationCode> ownerOfRelationCodes = new java.util.HashSet<>();
+
+	public CompositeEntityId getCodeObject() {
+		return codeObject;
+	}
+
+	public void setCodeObject(CompositeEntityId codeObject) {
+		this.codeObject = codeObject;
+	}
+
+	public Set<OwnerOfRelationCode> getOwnerOfRelationCodes() {
+		return ownerOfRelationCodes;
+	}
+
+	public void setOwnerOfRelationCodes(Set<OwnerOfRelationCode> ownerOfRelationCodes) {
+		this.ownerOfRelationCodes = ownerOfRelationCodes;
+	}
+
+	public String getFirstCode() {
+		return codeObject == null ? null : codeObject.getFirstCode();
+	}
+
+	public void setFirstCode(String firstCode) {
+		if ( codeObject == null ) {
+			codeObject = new CompositeEntityId();
+		}
+		codeObject.setFirstCode( firstCode );
+	}
+
+	public String getSecondCode() {
+		return codeObject == null ? null : codeObject.getSecondCode();
+	}
+
+	public void setSecondCode(String secondCode) {
+		if ( codeObject == null ) {
+			codeObject = new CompositeEntityId();
+		}
+		codeObject.setSecondCode( secondCode );
+	}
+
+}