org.hibernate.exception.SQLExceptionConverter Maven / Gradle / Ivy
// $Id: SQLExceptionConverter.java 4782 2004-11-21 00:11:27Z pgmjsd $
package org.hibernate.exception;
import org.hibernate.JDBCException;
import java.sql.SQLException;
/**
* Defines a contract for implementations that know how to convert a SQLException
* into Hibernate's JDBCException hierarchy. Inspired by Spring's
* SQLExceptionTranslator.
*
* Implementations must have a constructor which takes a
* {@link ViolatedConstraintNameExtracter} parameter.
*
* Implementations may implement {@link Configurable} if they need to perform
* configuration steps prior to first use.
*
* @author Steve Ebersole
* @see SQLExceptionConverterFactory
*/
public interface SQLExceptionConverter {
/**
* Convert the given SQLException into Hibernate's JDBCException hierarchy.
*
* @param sqlException The SQLException to be converted.
* @param message An optional error message.
* @return The resulting JDBCException.
* @see ConstraintViolationException, JDBCConnectionException, SQLGrammarException, LockAcquisitionException
*/
public JDBCException convert(SQLException sqlException, String message, String sql);
}