com.gtcgroup.justify.jpa.helper.JstTransactionUtilHelper 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.ArrayList;
import java.util.List;

import javax.persistence.CascadeType;
import javax.persistence.EntityManager;

import com.gtcgroup.justify.core.exception.internal.JustifyRuntimeException;
import com.gtcgroup.justify.core.helper.internal.ReflectionUtilHelper;
import com.gtcgroup.justify.jpa.po.JstTransactionJpaPO;

/**
 * This Helper class provides persistence transaction support.
 *
 * 
 * Copyright (c) 2006 - 2017 by Global Technology Consulting Group, Inc. at
 * gtcGroup.com .
 * 
 *
 * @author Marvin Toll
 * @since v3.0
 */
public enum JstTransactionUtilHelper {

	@SuppressWarnings("javadoc")
	INSTANCE;

	/**
	 * This convenience method guarantees deletion as long as the entity
	 * identity is specified.
	 */
	public static  void findAndDeleteEntity(final EntityManager entityManager,
			final ENTITY entityWithIdentity) {

		ENTITY entity = JstFindUtilHelper.findForceDatabaseTrip(entityManager, entityWithIdentity, false);

		if (null == entity) {
			return;
		}

		entityManager.getTransaction().begin();
		entity = entityManager.merge(entity);
		entityManager.remove(entity);
		entityManager.getTransaction().commit();
	}

	/**
	 * This convenience method guarantees deletion as long as the entity
	 * identity is specified.
	 */
	public static  void findAndDeleteEntity(final String persistenceUnitName, final ENTITY entityWithIdentity) {

		findAndDeleteEntity(JstEntityManagerFactoryCacheHelper.createEntityManagerToBeClosed(persistenceUnitName),
				entityWithIdentity);
	}

	/**
	 * This convenience method guarantees deletion of child objects typically
	 * not marked for cascading remove that needs removal programmatically from
	 * a parent entity.
	 */
	public static  void findAndDeleteRelatedEntity(final EntityManager entityManager,
			final Object entityWithReleatedEnitityContainingIdentity, final String relatedEntityGetterMethodName) {

		@SuppressWarnings("unchecked")
		final ENTITY entity = (ENTITY) ReflectionUtilHelper.invokePublicMethod(relatedEntityGetterMethodName,
				entityWithReleatedEnitityContainingIdentity);

		if (null == entity) {
			throw new JustifyRuntimeException("The entity represented by the method [" + relatedEntityGetterMethodName
					+ "] could not be found for deletion (removal).");
		}

		findAndDeleteEntity(entityManager, entity);
	}

	/**
	 * @return {@link List}
	 */
	private static  void mergeCreateAndUpdates(final PO transactionPO) {

		final List