org.ofbiz.core.entity.jdbc.interceptors

Interface SQLInterceptor

All Known Subinterfaces:

SQLConnectionInterceptor

All Known Implementing Classes:

SafeDelegatingSqlConnectionInterceptor

public interface SQLInterceptor

The SQLInterceptor is called before and after SQL is to be executed in OFBIZ.

Method Summary

Modifier and Type	Method and Description
void	afterSuccessfulExecution(String sqlString, List<String> parameterValues, Statement statement, ResultSet resultSet, int rowsUpdated) This is called after a successful (ie no SQLException generated) JDBC query is run.
void	beforeExecution(String sqlString, List<String> parameterValues, Statement statement) This is called before an JDBC query is run.
void	onException(String sqlString, List<String> parameterValues, Statement statement, SQLException sqlException) This is called if an SQLException is thrown during the JDBC query If this method runs then by design the afterSuccessfulExecution(String, java.util.List, java.sql.Statement, java.sql.ResultSet, int) (String, java.util.List, java.sql.Statement, java.sql.SQLException)} will have NOT run.

Method Detail

beforeExecution

void beforeExecution(String sqlString,
                     List<String> parameterValues,
                     Statement statement)

This is called before an JDBC query is run.

Parameters:

sqlString - thw SQL string in play

parameterValues - this list of the Java parameters passed to this statement. This is a simple String.valueOf() on these parameters

statement - the JDBC Statement in play

afterSuccessfulExecution

void afterSuccessfulExecution(String sqlString,
                              List<String> parameterValues,
                              Statement statement,
                              ResultSet resultSet,
                              int rowsUpdated)

This is called after a successful (ie no SQLException generated) JDBC query is run.

If this method runs then by design the onException(String, java.util.List, java.sql.Statement, java.sql.SQLException) will NOT run.

Parameters:

sqlString - the SQL string in play

parameterValues - this list of the Java parameters passed to this statement. This is a simple String.valueOf() on these parameters

statement - the JDBC Statement in play

resultSet - a JDBC ResultSet. In the case of an update, this will be NULL.

rowsUpdated - the number of rows updated. In the case of a SELECT, this will be -1

onException

void onException(String sqlString,
                 List<String> parameterValues,
                 Statement statement,
                 SQLException sqlException)

This is called if an SQLException is thrown during the JDBC query

If this method runs then by design the afterSuccessfulExecution(String, java.util.List, java.sql.Statement, java.sql.ResultSet, int) (String, java.util.List, java.sql.Statement, java.sql.SQLException)} will have NOT run.

Parameters:

sqlString - thw SQL string in play

parameterValues - this list of the Java parameters passed to this statement. This is a simple String.valueOf() on these parameters

statement - the JDBC Statement in play

sqlException - the exception that occurred