HHH-7860 : Log a warning when embed-xml attribute is used in mappings

gbadner · gbadner · commit 2883cb85c37f · 2012-12-12T16:06:03.000-08:00
diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/HbmBinder.java b/hibernate-core/src/main/java/org/hibernate/cfg/HbmBinder.java
@@ -1404,6 +1404,12 @@ public static void bindCollection(Element node, Collection collection, String cl
 		if ( nodeName == null ) nodeName = node.attributeValue( "name" );
 		collection.setNodeName( nodeName );
 		String embed = node.attributeValue( "embed-xml" );
+		// sometimes embed is set to the default value when not specified in the mapping,
+		// so can't seem to determine if an attribute was explicitly set;
+		// log a warning if embed has a value different from the default.
+		if ( !StringHelper.isEmpty( embed ) &&  !"true".equals( embed ) ) {
+			LOG.embedXmlAttributesNoLongerSupported();
+		}
 		collection.setEmbedded( embed==null || "true".equals(embed) );
 
 
@@ -1627,6 +1633,12 @@ public static void bindManyToOne(Element node, ManyToOne manyToOne, String path,
 		manyToOne.setReferencedEntityName( getEntityName( node, mappings ) );
 
 		String embed = node.attributeValue( "embed-xml" );
+		// sometimes embed is set to the default value when not specified in the mapping,
+		// so can't seem to determine if an attribute was explicitly set;
+		// log a warning if embed has a value different from the default.
+		if ( !StringHelper.isEmpty( embed ) &&  !"true".equals( embed ) ) {
+			LOG.embedXmlAttributesNoLongerSupported();
+		}
 		manyToOne.setEmbedded( embed == null || "true".equals( embed ) );
 
 		String notFound = node.attributeValue( "not-found" );
@@ -1702,7 +1714,14 @@ public static void bindOneToOne(Element node, OneToOne oneToOne, String path, bo
 		initOuterJoinFetchSetting( node, oneToOne );
 		initLaziness( node, oneToOne, mappings, true );
 
-		oneToOne.setEmbedded( "true".equals( node.attributeValue( "embed-xml" ) ) );
+		String embed = node.attributeValue( "embed-xml" );
+		// sometimes embed is set to the default value when not specified in the mapping,
+		// so can't seem to determine if an attribute was explicitly set;
+		// log a warning if embed has a value different from the default.
+		if ( !StringHelper.isEmpty( embed ) &&  !"true".equals( embed ) ) {
+			LOG.embedXmlAttributesNoLongerSupported();
+		}
+		oneToOne.setEmbedded( "true".equals( embed ) );
 
 		Attribute fkNode = node.attribute( "foreign-key" );
 		if ( fkNode != null ) oneToOne.setForeignKeyName( fkNode.getValue() );
@@ -1730,6 +1749,12 @@ public static void bindOneToMany(Element node, OneToMany oneToMany, Mappings map
 		oneToMany.setReferencedEntityName( getEntityName( node, mappings ) );
 
 		String embed = node.attributeValue( "embed-xml" );
+		// sometimes embed is set to the default value when not specified in the mapping,
+		// so can't seem to determine if an attribute was explicitly set;
+		// log a warning if embed has a value different from the default.
+		if ( !StringHelper.isEmpty( embed ) &&  !"true".equals( embed ) ) {
+			LOG.embedXmlAttributesNoLongerSupported();
+		}
 		oneToMany.setEmbedded( embed == null || "true".equals( embed ) );
 
 		String notFound = node.attributeValue( "not-found" );
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/CoreMessageLogger.java b/hibernate-core/src/main/java/org/hibernate/internal/CoreMessageLogger.java
@@ -1601,4 +1601,12 @@ void cannotResolveNonNullableTransientDependencies(String transientEntityString,
 	)
 	void aliasSpecificLockingWithFollowOnLocking(LockMode lockMode);
 
+	@LogMessage(level = WARN)
+	@Message(
+			value = "embed-xml attributes were intended to be used for DOM4J entity mode. Since that entity mode has been " +
+					"removed, embed-xml attributes are no longer supported and should be removed from mappings.",
+			id = 446
+	)
+	void embedXmlAttributesNoLongerSupported();
+
 }

Original file line number	Diff line number	Diff line change
`@@ -1601,4 +1601,12 @@ void cannotResolveNonNullableTransientDependencies(String transientEntityString,`
`1601`	`1601`	`)`
`1602`	`1602`	`void aliasSpecificLockingWithFollowOnLocking(LockMode lockMode);`
`1603`	`1603`
	`1604`	`+ @LogMessage(level = WARN)`
	`1605`	`+ @Message(`
	`1606`	`+ value = "embed-xml attributes were intended to be used for DOM4J entity mode. Since that entity mode has been " +`
	`1607`	`+ "removed, embed-xml attributes are no longer supported and should be removed from mappings.",`
	`1608`	`+ id = 446`
	`1609`	`+ )`
	`1610`	`+ void embedXmlAttributesNoLongerSupported();`
	`1611`	`+`
`1604`	`1612`	`}`