Spring Boot + Spring Data with multi tenancy

Question

Is it possible to configure Spring Boot to use a MultiTenantConnectionProvider so that each client of my system connects to their own private database?

Specifically I am looking to use the built-in hibernate support for multi-tenancy:

http://docs.jboss.org/hibernate/orm/4.1/devguide/en-US/html_single/#d5e4561

And this is an example of the sort of config I am after, but I can't figure out how to use this in a Spring Boot setup:

Manage Connection Pooling in multi-tenant web app with Spring, Hibernate and C3P0

I've tried adding these properties to application.properties:

spring.jpa.hibernate.multiTenancy=DATABASE
spring.jpa.hibernate.tenant_identifier_resolver=com.mystuff.MyCurrentTenantIdentifierResolver
spring.jpa.hibernate.multi_tenant_connection_provider=com.mystuff.MyMultiTenantConnectionProviderImplX

I've also tried coding up my own CurrentTenantIdentifierResolver and MultiTenantConnectionProvider and tried serving these up from my main @Configuration bean:

@Bean
public CurrentTenantIdentifierResolver currentTenantIdentifierResolver() {
    return new CurrentTenantIdentifierResolver() {
        public String resolveCurrentTenantIdentifier() {
            // this is never called ...
        }
        public boolean validateExistingCurrentSessions() {
            // this is never called ...
        }
    };
}

@Bean
public MultiTenantConnectionProvider multiTenantConnectionProvider() {
    return new AbstractMultiTenantConnectionProvider() {
        protected ConnectionProvider getAnyConnectionProvider() {
            // this is never called ...
        }
        protected ConnectionProvider selectConnectionProvider(String s) {
            // this is never called ...
        }
    };
}

None of this seems to have any affect so my question is really how to get spring-boot / spring-data to use these multi-tenant classes?

Thanks for your help!

See my question here.<br/> I use a LocalContainerEntityManagerFactoryBean and it works.<br/> But I'm not entirely understand the difference between this and .ymlor.properties.<br/> I agree with @M.Deinum , in yml hibernate controls the lifecycle of mulitTenantConnectionProvider and CurrentTenantIdentifierResolver.But I don't know why. — linghu

M. Deinum M. Deinum · Accepted Answer · 2014-11-13T07:15:14

Any property for JPA/Hibernate that isn't defined can be set using the spring.jpa.properties property in the application.properties.

The sample you link to has 3 properties for multitenancy:

<prop key="hibernate.multiTenancy">SCHEMA</prop>
<prop key="hibernate.tenant_identifier_resolver">com.webapp.persistence.utility.CurrentTenantContextIdentifierResolver</prop>
<prop key="hibernate.multi_tenant_connection_provider">com.webapp.persistence.utility.MultiTenantContextConnectionProvider</prop>

That converted to Spring Boot would be the following properties in the application.properties file.

spring.jpa.properties.hibernate.multiTenancy=SCHEMA
spring.jpa.properties.hibernate.tenant_identifier_resolver=com.mystuff.MyCurrentTenantIdentifierResolver
spring.jpa.properties.hibernate.multi_tenant_connection_provider=com.webapp.persistence.utility.MultiTenantContextConnectionProvider

For your situation (as stated in your question).

spring.jpa.properties.hibernate.multiTenancy=DATABASE
spring.jpa.properties.hibernate.tenant_identifier_resolver=com.webapp.persistence.utility.CurrentTenantContextIdentifierResolver 
spring.jpa.properties.hibernate.multi_tenant_connection_provider=com.mystuff.MyMultiTenantConnectionProviderImplX

It will not work with Spring manged beans as hibernate controls the lifecycle of those instances.

For more properties see the the Spring Boot reference guide.

Spring Boot + Spring Data with multi tenancy

1 Answers