HSEARCH-4132 Register AdditionalJaxbMappingProducer for synthetic ent…

…ities

mapper/orm/src/main/java/org/hibernate/search/mapper/orm/logging/impl/Log.java

@@ -290,4 +290,8 @@ SearchException foundMultipleEntitiesForDocumentId(String entityName, String doc
 			+ " the selected automatic indexing strategy always processes events asynchronously, through a queue.")
 	SearchException cannotConfigureSynchronizationStrategyWithIndexingEventQueue();
 
+	@LogMessage(level = DEBUG)
+	@Message(id = ID_OFFSET + 43, value = "Outbox-generated entity mapping: %1$s")
+	void outboxGeneratedEntityMapping(String xmlMappingDefinition);
+
 }

mapper/orm/src/main/java/org/hibernate/search/mapper/orm/outbox/impl/OutboxAdditionalJaxbMappingProducer.java

@@ -0,0 +1,92 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * 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.search.mapper.orm.outbox.impl;
+
+import java.io.BufferedInputStream;
+import java.io.ByteArrayInputStream;
+import java.lang.invoke.MethodHandles;
+import java.util.Collection;
+import java.util.Collections;
+
+import org.hibernate.boot.jaxb.Origin;
+import org.hibernate.boot.jaxb.SourceType;
+import org.hibernate.boot.jaxb.hbm.spi.JaxbHbmHibernateMapping;
+import org.hibernate.boot.jaxb.internal.MappingBinder;
+import org.hibernate.boot.jaxb.spi.Binding;
+import org.hibernate.boot.model.source.internal.hbm.MappingDocument;
+import org.hibernate.boot.spi.MetadataBuildingContext;
+import org.hibernate.boot.spi.MetadataImplementor;
+import org.hibernate.engine.config.spi.ConfigurationService;
+import org.hibernate.search.engine.cfg.spi.ConfigurationProperty;
+import org.hibernate.search.engine.cfg.spi.ConfigurationPropertySource;
+import org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings;
+import org.hibernate.search.mapper.orm.logging.impl.Log;
+import org.hibernate.search.util.common.logging.impl.LoggerFactory;
+import org.hibernate.service.ServiceRegistry;
+
+import org.jboss.jandex.IndexView;
+
+@SuppressWarnings("deprecation")
+public class OutboxAdditionalJaxbMappingProducer implements org.hibernate.boot.spi.AdditionalJaxbMappingProducer {
+
+	private static final Log log = LoggerFactory.make( Log.class, MethodHandles.lookup() );
+
+	public static final String OUTBOX_ENTITY_NAME = "HibernateSearchOutboxEntity";
+	public static final String ENTITY_NAME_PROPERTY_NAME = "entityName";
+	public static final String ENTITY_ID_PROPERTY_NAME = "entityId";
+	public static final String ROUTE_PROPERTY_NAME = "route";
+
+	private static final String OUTBOX_TABLE_NAME = "HIBERNATE_SEARCH_OUTBOX_TABLE";
+	private static final String OUTBOX_ENTITY_DEFINITION = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
+			"\n" +
+			"<hibernate-mapping>\n" +
+			"    <class entity-name=\"" + OUTBOX_ENTITY_NAME + "\" table=\"" + OUTBOX_TABLE_NAME + "\">\n" +
+			"        <id name=\"id\" column=\"ID\" type=\"integer\">\n" +
+			"            <generator class=\"org.hibernate.id.enhanced.SequenceStyleGenerator\">\n" +
+			"                <param name=\"sequence_name\">" + OUTBOX_TABLE_NAME + "_GENERATOR</param>\n" +
+			"                <param name=\"table_name\">" + OUTBOX_TABLE_NAME + "_GENERATOR</param>\n" +
+			"                <param name=\"initial_value\">1</param>\n" +
+			"                <param name=\"increment_size\">1</param>\n" +
+			"            </generator>\n\r" +
+			"        </id>\n\r" +
+			"        <property name=\"" + ENTITY_NAME_PROPERTY_NAME + "\" column=\"ENTITY_NAME\" type=\"string\" />\n" +
+			"        <property name=\"" + ENTITY_ID_PROPERTY_NAME + "\" column=\"ENTITY_ID\" type=\"string\" />\n" +
+			"        <property name=\"" + ROUTE_PROPERTY_NAME + "\" column=\"ROUTE\" type=\"binary\" length=\"8192\" />\n" +
+			"    </class>\n" +
+			"</hibernate-mapping>\n";
+
+	private static final ConfigurationProperty<Boolean> FILL_OUTBOX_TABLE =
+			ConfigurationProperty.forKey( HibernateOrmMapperSettings.FILL_OUTBOX_TABLE )
+					.asBoolean()
+					.withDefault( HibernateOrmMapperSettings.Defaults.FILL_OUTBOX_TABLE )
+					.build();
+
+	@Override
+	public Collection<MappingDocument> produceAdditionalMappings(final MetadataImplementor metadata,
+			IndexView jandexIndex, final MappingBinder mappingBinder, final MetadataBuildingContext buildingContext) {
+		ServiceRegistry serviceRegistry = metadata.getMetadataBuildingOptions().getServiceRegistry();
+		ConfigurationService service = serviceRegistry.getService( ConfigurationService.class );
+		Boolean outboxEnabled = FILL_OUTBOX_TABLE.get( ConfigurationPropertySource.fromMap( service.getSettings() ) );
+
+		if ( !outboxEnabled ) {
+			return Collections.emptyList();
+		}
+
+		log.outboxGeneratedEntityMapping( OUTBOX_ENTITY_DEFINITION );
+		Origin origin = new Origin( SourceType.OTHER, "search" );
+
+		ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream( OUTBOX_ENTITY_DEFINITION.getBytes() );
+		BufferedInputStream bufferedInputStream = new BufferedInputStream( byteArrayInputStream );
+		Binding binding = mappingBinder.bind( bufferedInputStream, origin );
+
+		@SuppressWarnings("unchecked")
+		JaxbHbmHibernateMapping root = (JaxbHbmHibernateMapping) binding.getRoot();
+
+		MappingDocument mappingDocument = new MappingDocument( root, origin, buildingContext );
+		return Collections.singletonList( mappingDocument );
+	}
+}

mapper/orm/src/main/resources/META-INF/services/org.hibernate.boot.spi.AdditionalJaxbMappingProducer

@@ -0,0 +1 @@
+org.hibernate.search.mapper.orm.outbox.impl.OutboxAdditionalJaxbMappingProducer

pom.xml

@@ -1399,6 +1399,8 @@
                                         Class allowed to use CompletableFuture#join()
                                      -->
                                     <exclude>**/Futures.class</exclude>
+                                    <!-- The following class needs to use Hibernate ORM internal -->
+                                    <exclude>**/OutboxAdditionalJaxbMappingProducer.class</exclude>
                                 </excludes>
                                 <bundledSignatures>
                                     <!-- These signatures on the top are not specific to any JDK version -->