com.gtcgroup.justify.jpa.helper.JstEntityManagerFactoryCacheHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of justify-jpa Show documentation
JPA MODULE: PED Central is the home for the open-source �Justify� suite of software engineering modules. Justify seeks API alignment between Java 1.8+ application code and JUnit 5 test code.
There is a newer version: 8.5.0-alpha5
Show newest version
/*
 * [Licensed per the Open Source "MIT License".]
 *
 * Copyright (c) 2006 - 2017 by
 * Global Technology Consulting Group, Inc. at
 * http://gtcGroup.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.gtcgroup.justify.jpa.helper;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.Persistence;

import com.gtcgroup.justify.core.exception.internal.JustifyRuntimeException;
import com.gtcgroup.justify.jpa.helper.internal.PersistenceDotXmlCacheHelper;
import com.gtcgroup.justify.jpa.helper.internal.PersistenceKeyCacheHelper;

/**
 * This Helper class caches {@link EntityManagerFactory}(s).
 *
 * 
 * Copyright (c) 2006 - 2017 by Global Technology Consulting Group, Inc. at
 * gtcGroup.com .
 * 
 *
 * @author Marvin Toll
 * @since v3.0
 */
public enum JstEntityManagerFactoryCacheHelper {

    /** Instance */
    INSTANCE;

    private static Map ENTITY_MANAGER_FACTORY_MAP =
        new ConcurrentHashMap();

    /**
     * This method closes the {@link EntityManager}.
     */
    public static void closeEntityManager(final EntityManager entityManager) {

        if (null != entityManager) {

            if (entityManager.isOpen()) {

                entityManager.clear();
                entityManager.close();
            }
        }
        return;
    }

    /**
     * This method returns the entity manager factory key for use in subsequent
     * retrieval invocations.
     *
     * @return {@link String} Persistence key used to cache {@link EntityManagerFactory}.
     */
    public static String createEntityManagerFactory(final String persistenceUnitName,
        final Map persistencePropertyMapOrNull) {

        String persistenceKey = null;
        final String jdbcUrlOrDatasource =
            PersistenceDotXmlCacheHelper.retrieveJdbcUrlOrDatasource(persistenceUnitName, persistencePropertyMapOrNull);

        if (null == jdbcUrlOrDatasource) {

            throw new JustifyRuntimeException(
                "A jdbc url was not found for persistence unit name [" + persistenceUnitName + "].");
        }

        persistenceKey = PersistenceKeyCacheHelper.formatPersistenceKey(persistenceUnitName, jdbcUrlOrDatasource);

        createEntityManagerFactory(persistenceUnitName, persistencePropertyMapOrNull, persistenceKey);

        return persistenceKey;
    }

    private static String createEntityManagerFactory(final String persistenceUnitName,
        final Map persistencePropertyMapOrNull, final String persistenceKey) {

        if (ENTITY_MANAGER_FACTORY_MAP.containsKey(persistenceKey)) {
            return persistenceKey;
        }

        try {
            final EntityManagerFactory entityManagerFactory = Persistence
                .createEntityManagerFactory(persistenceUnitName, persistencePropertyMapOrNull);

            final EntityManager entityManager = entityManagerFactory.createEntityManager();
            entityManager.setProperty(null, "toForceCompletingConfiguration");
            JstEntityManagerFactoryCacheHelper.closeEntityManager(entityManager);

            JstEntityManagerFactoryCacheHelper.ENTITY_MANAGER_FACTORY_MAP.put(persistenceKey,
                entityManagerFactory);

        } catch (final Exception e) {

            throw new JustifyRuntimeException(e);
        }
        return persistenceKey;
    }

    /**
     * @return {@link EntityManager}
     */
    public static EntityManager createEntityManagerToBeClosedWithKey(final String persistenceKey) {

        if (ENTITY_MANAGER_FACTORY_MAP.containsKey(persistenceKey)) {
            return ENTITY_MANAGER_FACTORY_MAP.get(persistenceKey).createEntityManager();
        }
        throw new JustifyRuntimeException(
            "An entity manager was not found for the persistence key [" + persistenceKey + "].");
    }

    /**
     * @return {@link EntityManager}
     */
    public static EntityManager createEntityManagerToBeClosed(final String persistenceUnitName) {

        return createEntityManagerToBeClosed(persistenceUnitName, null);

    }

    /**
     * @return {@link EntityManager}
     */
    public static EntityManager createEntityManagerToBeClosed(final String persistenceUnitName,
        final Map persistencePropertyMapOrNull) {

        final String persistenceKey = createEntityManagerFactory(persistenceUnitName, persistencePropertyMapOrNull);

        return ENTITY_MANAGER_FACTORY_MAP.get(persistenceKey).createEntityManager();

    }
}