org.seasar.doma.jdbc

Interface JdbcLogger

All Known Implementing Classes:

AbstractJdbcLogger, UtilLoggingJdbcLogger

public interface JdbcLogger

The logger for JDBC related operations.

The implementation instance must be thread safe.

The implementation methods must not throw any exceptions.

Method Summary

Modifier and Type	Method and Description
void	logAutoCommitEnablingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of an auto commit enabling.
void	logConnectionClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of a connection close.
void	logDaoMethodEntering(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.Object... args) Logs the start of a DAO method.
void	logDaoMethodExiting(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.Object result) Logs the normal end of a DAO method.
void	logDaoMethodThrowing(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.RuntimeException e) Logs the abnormal end of a DAO method.
void	logResultSetClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of a result set close.
void	logSql(java.lang.String callerClassName, java.lang.String callerMethodName, Sql<?> sql) Logs an SQL statement.
void	logSqlExecutionSkipping(java.lang.String callerClassName, java.lang.String callerMethodName, SqlExecutionSkipCause cause) Logs a skip of an SQL execution.
void	logStatementClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of a statement close.
void	logTransactionBegun(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId) Logs a beginning of a transaction.
void	logTransactionCommitted(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId) Logs a commit of a transaction.
void	logTransactionEnded(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId) Logs an end of a transaction.
void	logTransactionIsolationSettingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, int transactionIsolationLevel, java.sql.SQLException e) Logs a failure of a transaction isolation setting.
void	logTransactionRollbackFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, java.sql.SQLException e) Logs a failure of a transaction rollback.
void	logTransactionRolledback(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId) Logs a rollback of a transaction.
void	logTransactionSavepointCreated(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, java.lang.String savepointName) Logs a creation of a save point.
default void	logTransactionSavepointReleased(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, java.lang.String savepointName) Logs a release of a save point.
void	logTransactionSavepointRolledback(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, java.lang.String savepointName) Logs a rollback of a save point.

Method Detail

logDaoMethodEntering

void logDaoMethodEntering(java.lang.String callerClassName,
                          java.lang.String callerMethodName,
                          java.lang.Object... args)

Logs the start of a DAO method.

Parameters:

callerClassName - the name of the DAO class

callerMethodName - the name of the DAO method

args - the arguments of the DAO method

logDaoMethodExiting

void logDaoMethodExiting(java.lang.String callerClassName,
                         java.lang.String callerMethodName,
                         java.lang.Object result)

Logs the normal end of a DAO method.

At the end of the DAO method, either this method or logDaoMethodThrowing(String, String, RuntimeException) must be invoked.

Parameters:

callerClassName - the name of the DAO class

callerMethodName - the name of the DAO method

result - the method result or null if the method return type is void

logDaoMethodThrowing

void logDaoMethodThrowing(java.lang.String callerClassName,
                          java.lang.String callerMethodName,
                          java.lang.RuntimeException e)

Logs the abnormal end of a DAO method.

At the end of the DAO method, either this method or logDaoMethodExiting(String, String, Object) must be invoked.

Parameters:

callerClassName - the name of the DAO class

callerMethodName - the name of the DAO method

e - the runtime exception

logSqlExecutionSkipping

void logSqlExecutionSkipping(java.lang.String callerClassName,
                             java.lang.String callerMethodName,
                             SqlExecutionSkipCause cause)

Logs a skip of an SQL execution.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

cause - the cause of the skip

logSql

void logSql(java.lang.String callerClassName,
            java.lang.String callerMethodName,
            Sql<?> sql)

Logs an SQL statement.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

sql - SQL

logTransactionBegun

void logTransactionBegun(java.lang.String callerClassName,
                         java.lang.String callerMethodName,
                         java.lang.String transactionId)

Logs a beginning of a transaction.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionEnded

void logTransactionEnded(java.lang.String callerClassName,
                         java.lang.String callerMethodName,
                         java.lang.String transactionId)

Logs an end of a transaction.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionCommitted

void logTransactionCommitted(java.lang.String callerClassName,
                             java.lang.String callerMethodName,
                             java.lang.String transactionId)

Logs a commit of a transaction.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionSavepointCreated

void logTransactionSavepointCreated(java.lang.String callerClassName,
                                    java.lang.String callerMethodName,
                                    java.lang.String transactionId,
                                    java.lang.String savepointName)

Logs a creation of a save point.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

savepointName - the save point name

logTransactionRolledback

void logTransactionRolledback(java.lang.String callerClassName,
                              java.lang.String callerMethodName,
                              java.lang.String transactionId)

Logs a rollback of a transaction.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionSavepointRolledback

void logTransactionSavepointRolledback(java.lang.String callerClassName,
                                       java.lang.String callerMethodName,
                                       java.lang.String transactionId,
                                       java.lang.String savepointName)

Logs a rollback of a save point.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

savepointName - the save point name

logTransactionSavepointReleased

default void logTransactionSavepointReleased(java.lang.String callerClassName,
                                             java.lang.String callerMethodName,
                                             java.lang.String transactionId,
                                             java.lang.String savepointName)

Logs a release of a save point.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

savepointName - the save point name

logTransactionRollbackFailure

void logTransactionRollbackFailure(java.lang.String callerClassName,
                                   java.lang.String callerMethodName,
                                   java.lang.String transactionId,
                                   java.sql.SQLException e)

Logs a failure of a transaction rollback.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

e - the cause of the failure

logAutoCommitEnablingFailure

void logAutoCommitEnablingFailure(java.lang.String callerClassName,
                                  java.lang.String callerMethodName,
                                  java.sql.SQLException e)

Logs a failure of an auto commit enabling.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

Connection.setAutoCommit(boolean)

logTransactionIsolationSettingFailure

void logTransactionIsolationSettingFailure(java.lang.String callerClassName,
                                           java.lang.String callerMethodName,
                                           int transactionIsolationLevel,
                                           java.sql.SQLException e)

Logs a failure of a transaction isolation setting.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionIsolationLevel - the transaction isolation level

e - the cause of the failure

See Also:

Connection.setTransactionIsolation(int)

logConnectionClosingFailure

void logConnectionClosingFailure(java.lang.String callerClassName,
                                 java.lang.String callerMethodName,
                                 java.sql.SQLException e)

Logs a failure of a connection close.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

Connection.close()

logStatementClosingFailure

void logStatementClosingFailure(java.lang.String callerClassName,
                                java.lang.String callerMethodName,
                                java.sql.SQLException e)

Logs a failure of a statement close.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

Statement.close()

logResultSetClosingFailure

void logResultSetClosingFailure(java.lang.String callerClassName,
                                java.lang.String callerMethodName,
                                java.sql.SQLException e)

Logs a failure of a result set close.

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

ResultSet.close()