Spring JDBC 6.1.4 · org.springframework.jdbc.support.SQLExceptionTranslator

Strategy interface for translating between SQLExceptions and Spring's data access strategy-agnostic DataAccessException hierarchy.

Implementations can be generic (for example, using SQLState codes for JDBC) or wholly proprietary (for example, using Oracle error codes) for greater precision.

Method Summary

Modifier and Type	Method and Description
public DataAccessException	Returns: the DataAccessException wrapping the `SQLException`, or `null` if no specific translation could be applied translate(String readable text describing the task being attempted task, String the SQL query or update that caused the problem (if known) sql, SQLException the offending `SQLException` ex) Translate the given `SQLException` into a generic `DataAccessException`.

Method Detail

translate back to summary

translate	back to summary
public DataAccessException translate(String task, String sql, SQLException ex) Translate the given `SQLException` into a generic `DataAccessException`. The returned DataAccessException is supposed to contain the original `SQLException` as root cause. However, client code may not generally rely on this due to DataAccessExceptions possibly being caused by other resource APIs as well. That said, a `getRootCause() instanceof SQLException` check (and subsequent cast) is considered reliable when expecting JDBC-based access to have happened. Parameters task:String readable text describing the task being attempted sql:String the SQL query or update that caused the problem (if known) ex:SQLException the offending `SQLException` Returns:DataAccessException the DataAccessException wrapping the `SQLException`, or `null` if no specific translation could be applied Annotations @Nullable See Also `org.springframework.dao.DataAccessException#getRootCause()`

public DataAccessException translate(String task, String sql, SQLException ex)

Translate the given SQLException into a generic DataAccessException.

The returned DataAccessException is supposed to contain the original SQLException as root cause. However, client code may not generally rely on this due to DataAccessExceptions possibly being caused by other resource APIs as well. That said, a getRootCause() instanceof SQLException check (and subsequent cast) is considered reliable when expecting JDBC-based access to have happened.

Parameters

task:String: readable text describing the task being attempted
sql:String: the SQL query or update that caused the problem (if known)
ex:SQLException: the offending SQLException

Returns:DataAccessException

the DataAccessException wrapping the SQLException, or null if no specific translation could be applied

Annotations

@Nullable

public Interface SQLExceptionTranslator

Method Summary

Method Detail