HHH-14822 Support custom tenant identifier type

Author: beikov

hibernate-core/src/main/java/org/hibernate/SessionBuilder.java

@@ -112,9 +112,21 @@ public interface SessionBuilder {
 	 * @param tenantIdentifier The tenant identifier.
 	 *
 	 * @return {@code this}, for method chaining
+	 * @deprecated Use {@link #tenantIdentifier(Object)} instead
 	 */
+	@Deprecated(forRemoval = true)
 	SessionBuilder tenantIdentifier(String tenantIdentifier);
 
+	/**
+	 * Define the tenant identifier to be associated with the opened session.
+	 *
+	 * @param tenantIdentifier The tenant identifier.
+	 *
+	 * @return {@code this}, for method chaining
+	 * @since 6.4
+	 */
+	SessionBuilder tenantIdentifier(Object tenantIdentifier);
+
 	/**
 	 * Add one or more {@link SessionEventListener} instances to the list of
 	 * listeners for the new session to be built.

hibernate-core/src/main/java/org/hibernate/SharedSessionContract.java

@@ -31,6 +31,14 @@ public interface SharedSessionContract extends QueryProducer, Closeable, Seriali
 	 */
 	String getTenantIdentifier();
 
+	/**
+	 * Obtain the tenant identifier associated with this session.
+	 *
+	 * @return The tenant identifier associated with this session, or {@code null}
+	 * @since 6.4
+	 */
+	Object getTenantIdentifierValue();
+
 	/**
 	 * End the session by releasing the JDBC connection and cleaning up.
 	 *

hibernate-core/src/main/java/org/hibernate/StatelessSessionBuilder.java

@@ -36,6 +36,18 @@ public interface StatelessSessionBuilder {
 	 * @param tenantIdentifier The tenant identifier.
 	 *
 	 * @return {@code this}, for method chaining
+	 * @deprecated Use {@link #tenantIdentifier(Object)} instead
 	 */
+	@Deprecated(forRemoval = true)
 	StatelessSessionBuilder tenantIdentifier(String tenantIdentifier);
+
+	/**
+	 * Define the tenant identifier to be associated with the opened session.
+	 *
+	 * @param tenantIdentifier The tenant identifier.
+	 *
+	 * @return {@code this}, for method chaining
+	 * @since 6.4
+	 */
+	StatelessSessionBuilder tenantIdentifier(Object tenantIdentifier);
 }

hibernate-core/src/main/java/org/hibernate/binder/internal/TenantIdBinder.java

@@ -55,23 +55,7 @@ public void bind(
 							FILTER_NAME,
 							"",
 							singletonMap( PARAMETER_NAME, tenantIdType )
-					) {
-						// unfortunately the old APIs only accept String for a tenantId, so parse it
-						@Override
-						public Object processArgument(Object value) {
-							if (value==null) {
-								return null;
-							}
-							else if (value instanceof String) {
-								return getParameterJdbcMapping( PARAMETER_NAME )
-										.getJavaTypeDescriptor()
-										.fromString((String) value);
-							}
-							else {
-								return value;
-							}
-						}
-					}
+					)
 			);
 		}
 		else {
@@ -89,27 +73,27 @@ else if (value instanceof String) {
 			}
 		}
 		persistentClass.addFilter(
-						FILTER_NAME,
-						columnNameOrFormula(property)
-								+ " = :"
-								+ PARAMETER_NAME,
-						true,
-						emptyMap(),
-						emptyMap()
-				);
+				FILTER_NAME,
+				columnNameOrFormula( property )
+						+ " = :"
+						+ PARAMETER_NAME,
+				true,
+				emptyMap(),
+				emptyMap()
+		);
 
-		property.resetUpdateable(false);
-		property.resetOptional(false);
+		property.resetUpdateable( false );
+		property.resetOptional( false );
 	}
 
 	private String columnNameOrFormula(Property property) {
-		if ( property.getColumnSpan()!=1 ) {
-			throw new MappingException("@TenantId attribute must be mapped to a single column or formula");
+		if ( property.getColumnSpan() != 1 ) {
+			throw new MappingException( "@TenantId attribute must be mapped to a single column or formula" );
 		}
-		Selectable selectable = property.getSelectables().get(0);
+		Selectable selectable = property.getSelectables().get( 0 );
 		return selectable.isFormula()
-				? ((Formula) selectable).getFormula()
-				: ((Column) selectable).getName();
+				? ( (Formula) selectable ).getFormula()
+				: ( (Column) selectable ).getName();
 	}
 
 }

hibernate-core/src/main/java/org/hibernate/boot/SessionFactoryBuilder.java

@@ -377,7 +377,7 @@ public interface SessionFactoryBuilder {
 	 *
 	 * @see org.hibernate.cfg.AvailableSettings#MULTI_TENANT_IDENTIFIER_RESOLVER
 	 */
-	SessionFactoryBuilder applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver resolver);
+	SessionFactoryBuilder applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver<?> resolver);
 
 	/**
 	 * If using the built-in JTA-based

hibernate-core/src/main/java/org/hibernate/boot/internal/SessionFactoryBuilderImpl.java

@@ -262,7 +262,7 @@ public SessionFactoryBuilder applyMultiTenancy(boolean enabled) {
 	}
 
 	@Override
-	public SessionFactoryBuilder applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver resolver) {
+	public SessionFactoryBuilder applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver<?> resolver) {
 		this.optionsBuilder.applyCurrentTenantIdentifierResolver( resolver );
 		return this;
 	}

hibernate-core/src/main/java/org/hibernate/boot/internal/SessionFactoryOptionsBuilder.java

@@ -206,7 +206,7 @@ public class SessionFactoryOptionsBuilder implements SessionFactoryOptions {
 
 	// multi-tenancy
 	private boolean multiTenancyEnabled;
-	private CurrentTenantIdentifierResolver currentTenantIdentifierResolver;
+	private CurrentTenantIdentifierResolver<Object> currentTenantIdentifierResolver;
 
 	// Queries
 	private SqmFunctionRegistry sqmFunctionRegistry;
@@ -1008,7 +1008,7 @@ public boolean isMultiTenancyEnabled() {
 	}
 
 	@Override
-	public CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver() {
+	public CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver() {
 		return currentTenantIdentifierResolver;
 	}
 
@@ -1390,8 +1390,9 @@ public void applyMultiTenancy(boolean enabled) {
 		this.multiTenancyEnabled = enabled;
 	}
 
-	public void applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver resolver) {
-		this.currentTenantIdentifierResolver = resolver;
+	public void applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver<?> resolver) {
+		//noinspection unchecked
+		this.currentTenantIdentifierResolver = (CurrentTenantIdentifierResolver<Object>) resolver;
 	}
 
 	public void enableNamedQueryCheckingOnStartup(boolean enabled) {

hibernate-core/src/main/java/org/hibernate/boot/spi/AbstractDelegatingSessionFactoryBuilder.java

@@ -210,7 +210,7 @@ public T applyMultiTenancy(boolean enabled) {
 	}
 
 	@Override
-	public T applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver resolver) {
+	public T applyCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver<?> resolver) {
 		delegate.applyCurrentTenantIdentifierResolver( resolver );
 		return getThis();
 	}

hibernate-core/src/main/java/org/hibernate/boot/spi/AbstractDelegatingSessionFactoryOptions.java

@@ -35,6 +35,7 @@
 import org.hibernate.query.sqm.sql.SqmTranslatorFactory;
 import org.hibernate.resource.jdbc.spi.PhysicalConnectionHandlingMode;
 import org.hibernate.resource.jdbc.spi.StatementInspector;
+import org.hibernate.type.descriptor.java.JavaType;
 import org.hibernate.type.format.FormatMapper;
 
 /**
@@ -213,10 +214,15 @@ public boolean isMultiTenancyEnabled() {
 	}
 
 	@Override
-	public CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver() {
+	public CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver() {
 		return delegate.getCurrentTenantIdentifierResolver();
 	}
 
+	@Override
+	public JavaType<Object> getDefaultTenantIdentifierJavaType() {
+		return delegate.getDefaultTenantIdentifierJavaType();
+	}
+
 	@Override
 	public boolean isJtaTrackByThread() {
 		return delegate.isJtaTrackByThread();

hibernate-core/src/main/java/org/hibernate/boot/spi/SessionFactoryOptions.java

@@ -32,6 +32,8 @@
 import org.hibernate.resource.jdbc.spi.PhysicalConnectionHandlingMode;
 import org.hibernate.resource.jdbc.spi.StatementInspector;
 import org.hibernate.stat.Statistics;
+import org.hibernate.type.descriptor.java.JavaType;
+import org.hibernate.type.descriptor.java.ObjectJavaType;
 import org.hibernate.type.format.FormatMapper;
 
 /**
@@ -154,7 +156,7 @@ default boolean isAllowRefreshDetachedEntity() {
 
 	boolean isMultiTenancyEnabled();
 
-	CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver();
+	CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver();
 
 	boolean isJtaTrackByThread();
 
@@ -341,4 +343,14 @@ default boolean isCollectionsInDefaultFetchGroupEnabled() {
 	 */
 	@Incubating
 	FormatMapper getXmlFormatMapper();
+
+	/**
+	 * The default tenant identifier java type to use, in case no explicit tenant identifier property is defined.
+	 *
+	 * @since 6.4
+	 */
+	@Incubating
+	default JavaType<Object> getDefaultTenantIdentifierJavaType() {
+		return ObjectJavaType.INSTANCE;
+	}
 }