Skip to content

migrate to BOOT_LOGGER + more cleanups in boot packages #10942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 14, 2025
Merged

migrate to BOOT_LOGGER + more cleanups in boot packages #10942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
323 changes: 321 additions & 2 deletions hibernate-core/src/main/java/org/hibernate/boot/BootLogging.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,26 @@
package org.hibernate.boot;

import org.hibernate.Internal;
import org.hibernate.boot.model.relational.Namespace;
import org.hibernate.internal.log.SubSystemLogging;

import java.io.File;
import java.io.FileNotFoundException;
import java.lang.invoke.MethodHandles;

import org.hibernate.type.SerializationException;
import org.jboss.logging.BasicLogger;
import org.jboss.logging.Logger;
import org.jboss.logging.annotations.Cause;
import org.jboss.logging.annotations.LogMessage;
import org.jboss.logging.annotations.Message;
import org.jboss.logging.annotations.MessageLogger;
import org.jboss.logging.annotations.ValidIdRange;

import static org.jboss.logging.Logger.Level.DEBUG;
import static org.jboss.logging.Logger.Level.TRACE;
import static org.jboss.logging.Logger.Level.WARN;
import static org.jboss.logging.Logger.Level.INFO;

/**
* Logging related to Hibernate bootstrapping
Expand All @@ -17,8 +33,311 @@
name = BootLogging.NAME,
description = "Logging related to bootstrapping of a SessionFactory / EntityManagerFactory"
)
@MessageLogger(projectCode = "HHH")
@ValidIdRange(min = 160101, max = 160200)
@Internal
public interface BootLogging {
public interface BootLogging extends BasicLogger {
String NAME = SubSystemLogging.BASE + ".boot";
Logger BOOT_LOGGER = Logger.getLogger( NAME );
BootLogging BOOT_LOGGER = Logger.getMessageLogger( MethodHandles.lookup(), BootLogging.class, NAME );

@LogMessage(level = WARN)
@Message(id = 160101, value = "Duplicate generator name %s")
void duplicateGeneratorName(String name);

@LogMessage(level = INFO)
@Message(id = 160102, value = "Reading mappings from file: %s")
void readingMappingsFromFile(String path);

@LogMessage(level = INFO)
@Message(id = 160103, value = "Reading mappings from cache file: %s")
void readingCachedMappings(File cachedFile);

@LogMessage(level = WARN)
@Message(id = 160104, value = "Could not deserialize cache file [%s]: %s")
void unableToDeserializeCache(String path, SerializationException error);

@LogMessage(level = WARN)
@Message(id = 160105, value = "I/O reported error writing cached file: [%s]: %s")
void unableToWriteCachedFile(String path, String message);

@LogMessage(level = WARN)
@Message(id = 160106, value = "Could not update cached file timestamp: [%s]")
@SuppressWarnings("unused")
void unableToUpdateCachedFileTimestamp(String path);

@LogMessage(level = WARN)
@Message(id = 160107, value = "I/O reported cached file could not be found: [%s]: %s")
void cachedFileNotFound(String path, FileNotFoundException error);

@LogMessage(level = INFO)
@Message(id = 160108, value = "Omitting cached file [%s] as the mapping file is newer")
void cachedFileObsolete(File cachedFile);

@LogMessage(level = DEBUG)
@Message(id = 160111, value = "Package not found or no package-info.java: %s")
void packageNotFound(String packageName);

@LogMessage(level = WARN)
@Message(id = 160112, value = "LinkageError while attempting to load package: %s")
void linkageError(String packageName, @Cause LinkageError e);

@LogMessage(level = TRACE)
@Message(id = 160121, value = "Trying via [new URL(\"%s\")]")
void tryingURL(String name);

@LogMessage(level = TRACE)
@Message(id = 160122, value = "Trying via [ClassLoader.getResourceAsStream(\"%s\")]")
void tryingClassLoader(String name);

@LogMessage(level = WARN)
@Message(id = 160130, value = "Ignoring unique constraints specified on table generator [%s]")
void ignoringTableGeneratorConstraints(String name);

@LogMessage(level = WARN)
@Message(
id = 160131,
value = """
@Convert annotation applied to Map attribute [%s] did not explicitly specify\
'attributeName="key" or 'attributeName="value"' as required by spec;\
attempting to infer whether converter applies to key or value"""
)
void nonCompliantMapConversion(String collectionRole);

@LogMessage(level = WARN)
@Message(
id = 160133,
value = """
'%1$s.%2$s' uses both @NotFound and FetchType.LAZY;\
@ManyToOne and @OneToOne associations mapped with @NotFound are forced to EAGER fetching""")
void ignoreNotFoundWithFetchTypeLazy(String entity, String association);

// --- New typed TRACE/DEBUG messages for boot internals ---
@LogMessage(level = TRACE)
@Message(id = 160140, value = "Binding formula: %s")
void bindingFormula(String formula);

@LogMessage(level = TRACE)
@Message(id = 160141, value = "Binding column: %s")
void bindingColumn(String column);

@LogMessage(level = TRACE)
@Message(id = 160142, value = "Column mapping overridden for property: %s")
void columnMappingOverridden(String propertyName);

@LogMessage(level = TRACE)
@Message(id = 160143, value = "Could not perform @ColumnDefault lookup as 'PropertyData' did not give access to XProperty")
void couldNotPerformColumnDefaultLookup();

@LogMessage(level = TRACE)
@Message(id = 160144, value = "Could not perform @GeneratedColumn lookup as 'PropertyData' did not give access to XProperty")
void couldNotPerformGeneratedColumnLookup();

@LogMessage(level = TRACE)
@Message(id = 160145, value = "Could not perform @Check lookup as 'PropertyData' did not give access to XProperty")
void couldNotPerformCheckLookup();

@LogMessage(level = TRACE)
@Message(id = 160146, value = "Binding embeddable with path: %s")
void bindingEmbeddable(String path);

@LogMessage(level = TRACE)
@Message(id = 160147, value = "Binding filter definition: %s")
void bindingFilterDefinition(String name);

@LogMessage(level = TRACE)
@Message(id = 160148, value = "Second pass for collection: %s")
void secondPassForCollection(String role);

@LogMessage(level = TRACE)
@Message(id = 160149, value = "Binding collection role: %s")
void bindingCollectionRole(String role);

@LogMessage(level = TRACE)
@Message(id = 160150, value = "Binding one-to-many association through foreign key: %s")
void bindingOneToManyThroughForeignKey(String role);

@LogMessage(level = TRACE)
@Message(id = 160151, value = "Binding one-to-many association through association table: %s")
void bindingOneToManyThroughAssociationTable(String role);

@LogMessage(level = TRACE)
@Message(id = 160152, value = "Binding many-to-many association through association table: %s")
void bindingManyToManyThroughAssociationTable(String role);

@LogMessage(level = TRACE)
@Message(id = 160153, value = "Binding many-to-any: %s")
void bindingManyToAny(String role);

@LogMessage(level = TRACE)
@Message(id = 160154, value = "Binding element collection to collection table: %s")
void bindingElementCollectionToCollectionTable(String role);

@LogMessage(level = TRACE)
@Message(id = 160155, value = "Import: %s -> %s")
void importEntry(String importName, String className);

@LogMessage(level = TRACE)
@Message(id = 160156, value = "Processing association property references")
void processingAssociationPropertyReferences();

@LogMessage(level = TRACE)
@Message(id = 160157, value = "Mapping class: %s -> %s")
void mappingClassToTable(String entityName, String tableName);

@LogMessage(level = TRACE)
@Message(id = 160158, value = "Mapping joined-subclass: %s -> %s")
void mappingJoinedSubclassToTable(String entityName, String tableName);

@LogMessage(level = TRACE)
@Message(id = 160159, value = "Mapping union-subclass: %s -> %s")
void mappingUnionSubclassToTable(String entityName, String tableName);

@LogMessage(level = TRACE)
@Message(id = 160160, value = "Mapped property: %s -> [%s]")
void mappedProperty(String propertyName, String columns);

@LogMessage(level = TRACE)
@Message(id = 160161, value = "Binding dynamic component [%s]")
void bindingDynamicComponent(String role);

@LogMessage(level = TRACE)
@Message(id = 160162, value = "Binding virtual component [%s] to owner class [%s]")
void bindingVirtualComponentToOwner(String role, String ownerClassName);

@LogMessage(level = TRACE)
@Message(id = 160163, value = "Binding virtual component [%s] as dynamic")
void bindingVirtualComponentAsDynamic(String role);

@LogMessage(level = TRACE)
@Message(id = 160164, value = "Binding component [%s]")
void bindingComponent(String role);

@LogMessage(level = TRACE)
@Message(id = 160165, value = "Attempting to determine component class by reflection %s")
void attemptingToDetermineComponentClassByReflection(String role);

@LogMessage(level = TRACE)
@Message(id = 160166, value = "Mapped collection: %s")
void mappedCollection(String role);

@LogMessage(level = TRACE)
@Message(id = 160167, value = "Mapping collection: %s -> %s")
void mappingCollectionToTable(String role, String tableName);

@LogMessage(level = TRACE)
@Message(id = 160168, value = "Binding natural id UniqueKey for entity: %s")
void bindingNaturalIdUniqueKey(String entityName);

@LogMessage(level = TRACE)
@Message(id = 160169, value = "Binding named query '%s' to [%s]")
void bindingNamedQuery(String queryName, String bindingTarget);

@LogMessage(level = TRACE)
@Message(id = 160170, value = "Binding named native query '%s' to [%s]")
void bindingNamedNativeQuery(String queryName, String bindingTarget);

@LogMessage(level = TRACE)
@Message(id = 160171, value = "Binding SQL result set mapping '%s' to [%s]")
void bindingSqlResultSetMapping(String name, String target);

@LogMessage(level = TRACE)
@Message(id = 160172, value = "Bound named stored procedure query: %s => %s")
void boundStoredProcedureQuery(String name, String procedure);

@LogMessage(level = TRACE)
@Message(id = 160173, value = "Adding global sequence generator with name: %s")
void addingGlobalSequenceGenerator(String name);

@LogMessage(level = TRACE)
@Message(id = 160174, value = "Adding global table generator with name: %s")
void addingGlobalTableGenerator(String name);

@LogMessage(level = TRACE)
@Message(id = 160175, value = "Binding entity with annotated class: %s")
void bindingEntityWithAnnotatedClass(String className);

@LogMessage(level = DEBUG)
@Message(id = 160176, value = "Import name [%s] overrode previous [{%s}]")
void importOverrodePrevious(String importName, String previous);

@LogMessage(level = TRACE)
@Message(id = 160177, value = "%s")
void mappedCollectionDetails(String details);

@LogMessage(level = TRACE)
@Message(id = 160178, value = "Mapping entity secondary table: %s -> %s")
void mappingEntitySecondaryTableToTable(String entityName, String tableName);

@LogMessage(level = TRACE)
@Message(id = 160179, value = "Writing cache file for: %s to: %s")
void writingCacheFile(String xmlPath, String serPath);

@LogMessage(level = DEBUG)
@Message(id = 160180, value = "Unexpected ServiceRegistry type [%s] encountered during building of MetadataSources; may cause problems later attempting to construct MetadataBuilder")
void unexpectedServiceRegistryType(String registryType);

@LogMessage(level = TRACE)
@Message(id = 160181, value = "Created database namespace [logicalName=%s, physicalName=%s]")
void createdDatabaseNamespace(Namespace.Name logicalName, Namespace.Name physicalName);

@LogMessage(level = DEBUG)
@Message(id = 160182, value = "Could load component class [%s]")
void couldLoadComponentClass(String className, @Cause Throwable ex);

@LogMessage(level = DEBUG)
@Message(id = 160183, value = "Unable to load explicit any-discriminator type name as Java Class - %s")
void unableToLoadExplicitAnyDiscriminatorType(String typeName);

@LogMessage(level = DEBUG)
@Message(id = 160184, value = "Ignoring exception thrown when trying to build IdentifierGenerator as part of Metadata building")
void ignoringExceptionBuildingIdentifierGenerator(@Cause Throwable ex);

@LogMessage(level = TRACE)
@Message(id = 160185, value = "Binding component [%s] to explicitly specified class [%s]")
void bindingComponentToExplicitClass(String role, String className);

@LogMessage(level = DEBUG)
@Message(id = 160186, value = "Unable to determine component class name via reflection, and explicit class name not given; role=[%s]")
void unableToDetermineComponentClassByReflection(String role);

@LogMessage(level = DEBUG)
@Message(id = 160187, value = "Replacing Table registration(%s) : %s -> %s")
void replacingTableRegistration(String logicalName, String previous, String table);

@LogMessage(level = DEBUG)
@Message(id = 160188, value = "Ignoring %s XML mappings due to '%s'")
void ignoringXmlMappings(int count, String setting);

@LogMessage(level = WARN)
@Message(id = 160189, value = "Duplicate fetch profile name '%s'")
void duplicatedFetchProfile(String name);

// EntityBinder discriminator handling
@LogMessage(level = TRACE)
@Message(id = 160190, value = "Ignoring explicit @DiscriminatorColumn annotation on: %s")
void ignoringExplicitDiscriminatorForJoined(String className);

@LogMessage(level = TRACE)
@Message(id = 160191, value = "Inferring implicit @DiscriminatorColumn using defaults for: %s")
void inferringImplicitDiscriminatorForJoined(String className);

// GeneratorBinder additions
@LogMessage(level = TRACE)
@Message(id = 160192, value = "Added generator with name: %s, strategy: %s")
void addedGenerator(String name, String strategy);

@LogMessage(level = TRACE)
@Message(id = 160193, value = "Added sequence generator with name: %s")
void addedSequenceGenerator(String name);

@LogMessage(level = TRACE)
@Message(id = 160194, value = "Added table generator with name: %s")
void addedTableGenerator(String name);

@LogMessage(level = DEBUG)
@Message(id = 160195,
value = """
ServiceRegistry passed to MetadataBuilder was a BootstrapServiceRegistry; \
this likely won't end well if attempt is made to build SessionFactory""")
void badServiceRegistry();
}
8 changes: 3 additions & 5 deletions hibernate-core/src/main/java/org/hibernate/boot/MetadataSources.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
import static java.util.Collections.addAll;
import static java.util.Collections.emptyList;
import static java.util.Collections.emptySet;
import static org.hibernate.internal.CoreMessageLogger.CORE_LOGGER;
import static org.hibernate.boot.BootLogging.BOOT_LOGGER;
import static org.hibernate.internal.util.collections.CollectionHelper.arrayList;

/**
Expand Down Expand Up @@ -104,10 +104,8 @@ public MetadataSources(ServiceRegistry serviceRegistry) {
public MetadataSources(ServiceRegistry serviceRegistry, XmlMappingBinderAccess xmlMappingBinderAccess) {
// service registry really should be either BootstrapServiceRegistry or StandardServiceRegistry type...
if ( !isExpectedServiceRegistryType( serviceRegistry ) ) {
if ( CORE_LOGGER.isDebugEnabled() ) {
CORE_LOGGER.debugf(
"Unexpected ServiceRegistry type [%s] encountered during building of MetadataSources; may cause " +
"problems later attempting to construct MetadataBuilder",
if ( BOOT_LOGGER.isDebugEnabled() ) {
BOOT_LOGGER.unexpectedServiceRegistryType(
serviceRegistry.getClass().getName()
);
}
Expand Down
Loading
Loading