/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* JBoss, Home of Professional Open Source
* Copyright 2011 Red Hat Inc. and/or its affiliates and other contributors
* as indicated by the @authors tag. All rights reserved.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
package org.hibernate.search.jpa.impl;
import javax.persistence.OptimisticLockException;
import org.hibernate.HibernateException;
import org.hibernate.Session;
/**
* Helper class for {@code FullTextQueryImpl} to extract information out of an
* Hibernate {@code OptimisticLockException} and create the JPA counterpart.
*
* @author Sanne Grinovero <sanne@hibernate.org> (C) 2011 Red Hat Inc.
*/
public class OptimisticLockingCompatibilityHelper {
//This is the new class name, and is extended by the deprecated one so it is compatible with both types
private static final String parentOptimisticLockExceptionClassName = "org.hibernate.dialect.lock.OptimisticEntityLockException";
private static final String deprecatedOptimisticLockExceptionClassName = "org.hibernate.OptimisticLockException";
private static final Class optimisticLockExceptionClass = determineCompatibleOptimisticLockExceptionClass();
/**
* Looks for the new Hibernate class name, or falls back to the older one.
*
* @return the type of optimistic lock exceptions which Hibernate is going to throw
*/
private static Class determineCompatibleOptimisticLockExceptionClass() {
try {
return Class.forName( parentOptimisticLockExceptionClassName, true, Session.class.getClassLoader() );
}
catch (ClassNotFoundException e) {
// the failing class was introduced in Hibernate Core 4.0.0.CR7 only; fall back to old name when it's not found:
try {
return Class.forName(
deprecatedOptimisticLockExceptionClassName,
true,
Session.class.getClassLoader()
);
}
catch (ClassNotFoundException e1) {
// this is fatal, will need to check for null at runtime
return null;
}
}
}
/**
* We might need different ways to extract the error message according to what is available at runtime
*
* @param e the Hibernate exception
*
* @return Returns the entity passed as part of the exception context. {@code null} is returned if no entity is
* provided within the exception
*/
private static Object extractEntityOufOfException(HibernateException e) {
if ( parentOptimisticLockExceptionClassName.equals( optimisticLockExceptionClass.getName() ) ) {
org.hibernate.dialect.lock.OptimisticEntityLockException oele = (org.hibernate.dialect.lock.OptimisticEntityLockException) e;
return oele.getEntity();
}
else if ( deprecatedOptimisticLockExceptionClassName.equals( optimisticLockExceptionClass.getName() ) ) {
org.hibernate.OptimisticLockException oele = (org.hibernate.OptimisticLockException) e;
return oele.getEntity();
}
return null;
}
/**
* @param e an Hibernate runtime exception
*
* @return true if it's definitely an optimistic locking exception, false if we can't tell
*/
public static boolean isOptimisticLockException(HibernateException e) {
return optimisticLockExceptionClass != null && optimisticLockExceptionClass.isInstance( e );
}
/**
* Convert a provided Hibernate exception to a JPA exception. If possible entity information is added.
*
* @param e the Hibernate exception to convert
*
* @return A JPA optimistic lock exception
*/
public static OptimisticLockException convertToLockException(HibernateException e) {
Object entity = extractEntityOufOfException( e );
if ( entity != null ) {
return new OptimisticLockException( e.getMessage(), e, entity );
}
else {
return new OptimisticLockException( e.getMessage(), e );
}
}
}