org.ameba.integration.hibernate.ColumnSeparationConfigurator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ameba-lib Show documentation

Ameba Utilities

There is a newer version: 4.1.0-jdk17

/*
 * Copyright 2015-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ameba.integration.hibernate;

import org.hibernate.cfg.MultiTenancySettings;
import org.springframework.boot.autoconfigure.orm.jpa.HibernatePropertiesCustomizer;

import java.util.Map;

/**
 * A ColumnSeparationConfigurator is a Spring Boot recognized class type to customize Hibernate properties programmatically at application
 * startup (when the EntityManagerFactory and SessionFactory are bootstrapped). In fact this implementation configures Hibernate to use a
 * partitioning-based data separation with a Hibernate managed discriminator column (since Hibernate 6 with {@code @TenantId}. The tenant
 * resolution strategy may change between projects and can be defined as an attribute of the {@code EnableMultiTenancy} annotation.
 *
 * @author Heiko Scherrer
 */
public class ColumnSeparationConfigurator implements HibernatePropertiesCustomizer {

    public static Object tenantResolver;

    /**
     * {@inheritDoc}
     * 
     * Setup partitioning-based data separation for multiple tenants.
     */
    @Override
    public void customize(Map hibernateProperties) {
        hibernateProperties.put(MultiTenancySettings.MULTI_TENANT_IDENTIFIER_RESOLVER, tenantResolver);
    }
}