HHH-19247 Add ordinal() also to Type contributions to be able to influence the order in which serviceloaded custom types are registered

Author: kad-barens

hibernate-core/src/main/java/org/hibernate/boot/model/FunctionContributor.java

@@ -31,16 +31,34 @@
  *     or even {@link org.hibernate.boot.MetadataBuilder#applyFunctions(FunctionContributor)}.
  * </ul>
  *
- * @author Karel Maesen
  * @see org.hibernate.query.sqm.function.SqmFunctionRegistry
+ *
+ * @author Karel Maesen
  */
 @JavaServiceLoadable
-public interface FunctionContributor extends Ordinated {
+public interface FunctionContributor {
 
 	/**
 	 * Contribute functions
 	 *
 	 * @param functionContributions The target for the contributions
 	 */
 	void contributeFunctions(FunctionContributions functionContributions);
+
+	/**
+	 * Determines order in which the contributions will be applied
+	 * (lowest ordinal first).
+	 * <p>
+	 * The range 0-500 is reserved for Hibernate, range 500-1000 for libraries and
+	 * 1000-Integer.MAX_VALUE for user-defined FunctionContributors.
+	 * <p>
+	 * Contributions from higher precedence contributors (higher numbers) effectively override
+	 * contributions from lower precedence.  E.g. if a contributor with precedence 1000 contributes a
+	 * function named {@code "max"}, that will override Hibernate's standard function of that name.
+	 *
+	 * @return the ordinal for this FunctionContributor
+	 */
+	default int ordinal(){
+		return 1000;
+	}
 }

hibernate-core/src/main/java/org/hibernate/boot/model/Ordinated.java

@@ -23,21 +23,39 @@
  *     or even {@link org.hibernate.boot.MetadataBuilder#applyTypes(TypeContributor)}.
  * <li>
  *     When bootstrapping Hibernate via JPA or {@link org.hibernate.cfg.Configuration},
- * <p>
+ *
  *     Finally, in the JPA boostrap process, {@code TypeContributor}s may be
  *     listed via {@link org.hibernate.jpa.boot.spi.JpaSettings#TYPE_CONTRIBUTORS}.
  * </ul>
  *
  * @author Steve Ebersole
+ *
  * @see org.hibernate.type.spi.TypeConfiguration
  */
 @JavaServiceLoadable
-public interface TypeContributor extends Ordinated {
+public interface TypeContributor {
 	/**
 	 * Contribute types
 	 *
 	 * @param typeContributions The callback for adding contributed types
 	 * @param serviceRegistry The service registry
 	 */
 	void contribute(TypeContributions typeContributions, ServiceRegistry serviceRegistry);
+
+	/**
+	 * Determines order in which the contributions will be applied
+	 * (lowest ordinal first).
+	 * <p>
+	 * The range 0-500 is reserved for Hibernate, range 500-1000 for libraries and
+	 * 1000-Integer.MAX_VALUE for user-defined TypeContributors.
+	 * <p>
+	 * Contributions from higher precedence contributors (higher numbers) effectively override
+	 * contributions from lower precedence.  E.g. if a contributor with precedence 2000 contributes
+	 * some type, that will override Hibernate's standard type of that name.
+	 *
+	 * @return the ordinal for this TypenContributor
+	 */
+	default int ordinal(){
+		return 1000;
+	}
 }

hibernate-core/src/main/java/org/hibernate/boot/model/TypeContributor.java

@@ -96,18 +96,18 @@
 /**
  * Represents the process of transforming a {@link MetadataSources}
  * reference into a {@link org.hibernate.boot.Metadata} reference.  Allows for 2 different process paradigms:<ul>
- * <li>
- * Single step : as defined by the {@link #build} method; internally leverages the 2-step paradigm
- * </li>
- * <li>
- * Two step : a first step coordinates resource scanning and some other preparation work; a second step
- * builds the {@link org.hibernate.boot.Metadata}.  A hugely important distinction in the need for the
- * steps is that the first phase should strive to not load user entity/component classes so that we can still
- * perform enhancement on them later.  This approach caters to the 2-phase bootstrap we use in regards
- * to WildFly Hibernate-JPA integration.  The first step is defined by {@link #prepare} which returns
- * a {@link ManagedResources} instance.  The second step is defined by calling
- * {@link #complete}
- * </li>
+ *     <li>
+ *         Single step : as defined by the {@link #build} method; internally leverages the 2-step paradigm
+ *     </li>
+ *     <li>
+ *         Two step : a first step coordinates resource scanning and some other preparation work; a second step
+ *         builds the {@link org.hibernate.boot.Metadata}.  A hugely important distinction in the need for the
+ *         steps is that the first phase should strive to not load user entity/component classes so that we can still
+ *         perform enhancement on them later.  This approach caters to the 2-phase bootstrap we use in regards
+ *         to WildFly Hibernate-JPA integration.  The first step is defined by {@link #prepare} which returns
+ *         a {@link ManagedResources} instance.  The second step is defined by calling
+ *         {@link #complete}
+ *     </li>
  * </ul>
  *
  * @author Steve Ebersole
@@ -200,7 +200,7 @@ public static MetadataImplementor complete(
 
 		final MetadataSourceProcessor processor = new MetadataSourceProcessor() {
 			private final MetadataSourceProcessor hbmProcessor =
-					options.isXmlMappingEnabled()
+						options.isXmlMappingEnabled()
 							? new HbmMetadataSourceProcessorImpl( managedResources, rootMetadataBuildingContext )
 							: new NoOpMetadataSourceProcessorImpl();
 
@@ -339,19 +339,8 @@ public void finishUp() {
 
 		processor.finishUp();
 
-		processAdditionalMappingContributions(
-				metadataCollector,
-				options,
-				classLoaderService,
-				rootMetadataBuildingContext
-		);
-		processAdditionalJaxbMappingProducer(
-				metadataCollector,
-				options,
-				jandexView,
-				classLoaderService,
-				rootMetadataBuildingContext
-		);
+		processAdditionalMappingContributions( metadataCollector, options, classLoaderService, rootMetadataBuildingContext );
+		processAdditionalJaxbMappingProducer( metadataCollector, options, jandexView, classLoaderService, rootMetadataBuildingContext );
 
 		applyExtraQueryImports( managedResources, metadataCollector );
 
@@ -391,8 +380,7 @@ public boolean transformHbmMappings() {
 				rootMetadataBuildingContext
 		);
 
-		final Collection<AdditionalMappingContributor> additionalMappingContributors = classLoaderService.loadJavaServices(
-				AdditionalMappingContributor.class );
+		final Collection<AdditionalMappingContributor> additionalMappingContributors = classLoaderService.loadJavaServices( AdditionalMappingContributor.class );
 		additionalMappingContributors.forEach( (contributor) -> {
 			contributions.setCurrentContributor( contributor.getContributorName() );
 			try {
@@ -463,7 +451,7 @@ public void contributeBinding(InputStream xmlStream) {
 
 		@Override
 		public void contributeBinding(JaxbEntityMappings mappingJaxbBinding) {
-			if ( !options.isXmlMappingEnabled() ) {
+			if ( ! options.isXmlMappingEnabled() ) {
 				return;
 			}
 
@@ -475,7 +463,7 @@ public void contributeBinding(JaxbEntityMappings mappingJaxbBinding) {
 
 		@Override
 		public void contributeBinding(JaxbHbmHibernateMapping hbmJaxbBinding) {
-			if ( !options.isXmlMappingEnabled() ) {
+			if ( ! options.isXmlMappingEnabled() ) {
 				return;
 			}
 
@@ -540,8 +528,7 @@ private static void processAdditionalJaxbMappingProducer(
 			ClassLoaderService classLoaderService,
 			MetadataBuildingContextRootImpl rootMetadataBuildingContext) {
 		if ( options.isXmlMappingEnabled() ) {
-			final Iterable<AdditionalJaxbMappingProducer> producers = classLoaderService.loadJavaServices(
-					AdditionalJaxbMappingProducer.class );
+			final Iterable<AdditionalJaxbMappingProducer> producers = classLoaderService.loadJavaServices( AdditionalJaxbMappingProducer.class );
 			if ( producers != null ) {
 				final EntityHierarchyBuilder hierarchyBuilder = new EntityHierarchyBuilder();
 				final MappingBinder mappingBinder = new MappingBinder(
@@ -611,7 +598,7 @@ private static void handleTypes(
 			MetadataBuildingOptions options,
 			InFlightMetadataCollector metadataCollector) {
 		final ClassLoaderService classLoaderService =
-				options.getServiceRegistry().requireService( ClassLoaderService.class );
+				options.getServiceRegistry().requireService(ClassLoaderService.class);
 
 		final TypeConfiguration typeConfiguration = bootstrapContext.getTypeConfiguration();
 		final StandardServiceRegistry serviceRegistry = bootstrapContext.getServiceRegistry();
@@ -645,7 +632,7 @@ public void contributeType(CompositeUserType<?> type) {
 			basicTypeRegistry.addTypeReferenceRegistrationKey(
 					StandardBasicTypes.BINARY_WRAPPER.getName(),
 					Byte[].class.getName(), "Byte[]"
-			);
+					);
 		}
 
 		// add Dialect contributed types
@@ -855,9 +842,7 @@ private static void adaptTimestampTypesToDefaultTimeZoneStorage(
 		);
 	}
 
-	private static JdbcType getTimeWithTimeZoneOverride(
-			MetadataBuildingOptions options,
-			JdbcTypeRegistry jdbcTypeRegistry) {
+	private static JdbcType getTimeWithTimeZoneOverride(MetadataBuildingOptions options, JdbcTypeRegistry jdbcTypeRegistry) {
 		switch ( options.getDefaultTimeZoneStorage() ) {
 			case NORMALIZE:
 				// For NORMALIZE, we replace the standard types that use TIME_WITH_TIMEZONE to use TIME
@@ -870,9 +855,7 @@ private static JdbcType getTimeWithTimeZoneOverride(
 		}
 	}
 
-	private static JdbcType getTimestampWithTimeZoneOverride(
-			MetadataBuildingOptions options,
-			JdbcTypeRegistry jdbcTypeRegistry) {
+	private static JdbcType getTimestampWithTimeZoneOverride(MetadataBuildingOptions options, JdbcTypeRegistry jdbcTypeRegistry) {
 		switch ( options.getDefaultTimeZoneStorage() ) {
 			case NORMALIZE:
 				// For NORMALIZE, we replace the standard types that use TIMESTAMP_WITH_TIMEZONE to use TIMESTAMP