Spring Framework 6.1.4 · org.springframework.jdbc.support.AbstractFallbackSQLExceptionTranslator

Modifier and Type	Field and Description
private SQLExceptionTranslator	customTranslator
private SQLExceptionTranslator	fallbackTranslator
protected final Log	logger Logger available to subclasses.

Access	Constructor and Description
public	AbstractFallbackSQLExceptionTranslator()

Method Summary

Modifier and Type	Method and Description
protected String	Returns: the message `String` to use buildMessage(String readable text describing the task being attempted task, String the SQL statement that caused the problem sql, SQLException the offending `SQLException` ex) Build a message `String` for the given `java.sql.SQLException`.
protected abstract DataAccessException	Returns: the DataAccessException, wrapping the `SQLException`; or `null` if no exception match found doTranslate(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) Template method for actually translating the given exception.
public SQLExceptionTranslator	getCustomTranslator() Return a custom exception translator, if any.
public SQLExceptionTranslator	getFallbackTranslator() Return the fallback exception translator, if any.
public void	setCustomTranslator(SQLExceptionTranslator customTranslator) Set a custom exception translator to override any match that this translator would find.
public void	setFallbackTranslator(SQLExceptionTranslator fallback) Set the fallback translator to use when this translator cannot find a specific match itself.
public DataAccessException	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) Implements org.springframework.jdbc.support.SQLExceptionTranslator.translate. Pre-checks the arguments, calls `doTranslate`, and invokes the `fallback translator` if necessary.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

customTranslator	back to summary
private SQLExceptionTranslator customTranslator Annotations @Nullable

fallbackTranslator	back to summary
private SQLExceptionTranslator fallbackTranslator Annotations @Nullable

logger	back to summary
protected final Log logger Logger available to subclasses.

AbstractFallbackSQLExceptionTranslator	back to summary
public AbstractFallbackSQLExceptionTranslator()

Method Detail

buildMessage back to summary

buildMessage	back to summary
protected String buildMessage(String task, String sql, SQLException ex) Build a message `String` for the given `java.sql.SQLException`. To be called by translator subclasses when creating an instance of a generic `org.springframework.dao.DataAccessException` class. Parameters task:String readable text describing the task being attempted sql:String the SQL statement that caused the problem ex:SQLException the offending `SQLException` Returns:String the message `String` to use

protected String buildMessage(String task, String sql, SQLException ex)

Build a message String for the given java.sql.SQLException.

To be called by translator subclasses when creating an instance of a generic org.springframework.dao.DataAccessException class.

Parameters

task:String: readable text describing the task being attempted
sql:String: the SQL statement that caused the problem
ex:SQLException: the offending SQLException

Returns:String

the message String to use

doTranslate back to summary

doTranslate	back to summary
protected abstract DataAccessException doTranslate(String task, String sql, SQLException ex) Template method for actually translating the given exception. The passed-in arguments will have been pre-checked. Furthermore, this method is allowed to return `null` to indicate that no exception match has been found and that fallback translation should kick in. 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 exception match found Annotations @Nullable

protected abstract DataAccessException doTranslate(String task, String sql, SQLException ex)

Template method for actually translating the given exception.

The passed-in arguments will have been pre-checked. Furthermore, this method is allowed to return null to indicate that no exception match has been found and that fallback translation should kick in.

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 exception match found

Annotations

@Nullable

getCustomTranslator back to summary

getCustomTranslator	back to summary
public SQLExceptionTranslator getCustomTranslator() Return a custom exception translator, if any. Annotations @Nullable Since 6.1 See Also `setCustomTranslator`

public SQLExceptionTranslator getCustomTranslator()

Return a custom exception translator, if any.

Annotations

@Nullable

Since

6.1

See Also

setCustomTranslator

getFallbackTranslator back to summary

getFallbackTranslator	back to summary
public SQLExceptionTranslator getFallbackTranslator() Return the fallback exception translator, if any. Annotations @Nullable See Also `setFallbackTranslator`

public SQLExceptionTranslator getFallbackTranslator()

Return the fallback exception translator, if any.

Annotations

@Nullable

See Also

setFallbackTranslator

setCustomTranslator back to summary

setCustomTranslator	back to summary
public void setCustomTranslator(SQLExceptionTranslator customTranslator) Set a custom exception translator to override any match that this translator would find. Note that such a custom `SQLExceptionTranslator` delegate is meant to return `null` if it does not have an override itself. Since 6.1

public void setCustomTranslator(SQLExceptionTranslator customTranslator)

Set a custom exception translator to override any match that this translator would find. Note that such a custom SQLExceptionTranslator delegate is meant to return null if it does not have an override itself.

Since: 6.1

setFallbackTranslator	back to summary
public void setFallbackTranslator(SQLExceptionTranslator fallback) Set the fallback translator to use when this translator cannot find a specific match itself.

translate back to summary

translate	back to summary
public DataAccessException translate(String task, String sql, SQLException ex) Implements org.springframework.jdbc.support.SQLExceptionTranslator.translate. Pre-checks the arguments, calls `doTranslate`, and invokes the `fallback translator` if necessary. Parameters task:String Doc from org.springframework.jdbc.support.SQLExceptionTranslator.translate. readable text describing the task being attempted sql:String Doc from org.springframework.jdbc.support.SQLExceptionTranslator.translate. the SQL query or update that caused the problem (if known) ex:SQLException Doc from org.springframework.jdbc.support.SQLExceptionTranslator.translate. the offending `SQLException` Returns:DataAccessException Doc from org.springframework.jdbc.support.SQLExceptionTranslator.translate. the DataAccessException wrapping the `SQLException`, or `null` if no specific translation could be applied Annotations @Override @Nullable