org.mycore.backend.jpa.MCRJPABootstrapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.backend.jpa;

import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import javax.persistence.EntityManagerFactory;
import javax.persistence.Persistence;
import javax.persistence.PersistenceException;
import javax.persistence.metamodel.EntityType;
import javax.persistence.metamodel.Metamodel;
import javax.servlet.ServletContext;

import org.apache.logging.log4j.LogManager;
import org.mycore.backend.hibernate.MCRHibernateConfigHelper;
import org.mycore.common.MCRException;
import org.mycore.common.config.MCRConfiguration2;
import org.mycore.common.events.MCRShutdownHandler;
import org.mycore.common.events.MCRStartupHandler.AutoExecutable;

/**
 * Initializes JPA {@link EntityManagerFactory}
 * @author Thomas Scheffler (yagee)
 */
public class MCRJPABootstrapper implements AutoExecutable {

    public static final String PERSISTENCE_UNIT_NAME = "MyCoRe";

    @Override
    public String getName() {
        return "JPA Bootstrapper";
    }

    @Override
    public int getPriority() {
        return 1000;
    }

    @Override
    public void startUp(ServletContext servletContext) {
        try {
            initializeJPA();
        } catch (PersistenceException e) {
            //fix for MCR-1236
            if (MCRConfiguration2.getBoolean("MCR.Persistence.Database.Enable").orElse(true)) {
                LogManager.getLogger()
                    .error(() -> "Could not initialize JPA. Database access is disabled in this session.", e);
                MCRConfiguration2.set("MCR.Persistence.Database.Enable", String.valueOf(false));
            }
            MCREntityManagerProvider.init(e);
            return;
        }
        Metamodel metamodel = MCREntityManagerProvider.getEntityManagerFactory().getMetamodel();
        checkHibernateMappingConfig(metamodel);
        LogManager.getLogger()
            .info("Mapping these entities: {}", metamodel.getEntities()
                .stream()
                .map(EntityType::getJavaType)
                .map(Class::getName)
                .collect(Collectors.toList()));
        MCRShutdownHandler.getInstance().addCloseable(new MCRJPAShutdownProcessor());
    }

    public static void initializeJPA() {
        initializeJPA(null, null);
    }

    public static void initializeJPA(String persistenceUnitName) {
        initializeJPA(persistenceUnitName, null);
    }

    public static void initializeJPA(String persistenceUnitName, Map properties) {
        EntityManagerFactory entityManagerFactory = Persistence.createEntityManagerFactory(
            Optional.ofNullable(persistenceUnitName).orElse(PERSISTENCE_UNIT_NAME),
            properties);
        checkFactory(entityManagerFactory);
        MCREntityManagerProvider.init(entityManagerFactory);
    }

    private static void checkFactory(EntityManagerFactory entityManagerFactory) {
        MCRHibernateConfigHelper.checkEntityManagerFactoryConfiguration(entityManagerFactory);
    }

    private void checkHibernateMappingConfig(Metamodel metamodel) {
        Set mappedEntities = metamodel
            .getEntities()
            .stream()
            .map(EntityType::getJavaType)
            .map(Class::getName)
            .collect(Collectors.toSet());
        List unMappedEntities = MCRConfiguration2.getString("MCR.Hibernate.Mappings")
            .map(MCRConfiguration2::splitValue)
            .orElseGet(Stream::empty)
            .filter(cName -> !mappedEntities.contains(cName))
            .collect(Collectors.toList());
        if (!unMappedEntities.isEmpty()) {
            throw new MCRException(
                "JPA Mapping is inclomplete. Could not find a mapping for these classes: " + unMappedEntities);
        }
    }

}