org.seasar.doma.jdbc

Class AbstractJdbcLogger<LEVEL>

java.lang.Object

org.seasar.doma.jdbc.AbstractJdbcLogger<LEVEL>

Type Parameters:

LEVEL - The log level

All Implemented Interfaces:

JdbcLogger

Direct Known Subclasses:

UtilLoggingJdbcLogger

public abstract class AbstractJdbcLogger<LEVEL>
extends java.lang.Object
implements JdbcLogger

A skeletal implementation of the JdbcLogger interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected LEVEL	defaultLevel the default log level

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJdbcLogger(LEVEL level) Creates an instance with a log level.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getSqlText(Sql<?> sql)
protected abstract void	log(LEVEL level, java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.Throwable throwable, java.util.function.Supplier<java.lang.String> messageSupplier) Logs an error or an exception.
void	logAutoCommitEnablingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of an auto commit enabling.
protected void	logAutoCommitEnablingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logConnectionClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of a connection close.
protected void	logConnectionClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logDaoMethodEntering(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.Object... args) Logs the start of a DAO method.
protected void	logDaoMethodEntering(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.Object[] args, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logDaoMethodExiting(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.Object result) Logs the normal end of a DAO method.
protected void	logDaoMethodExiting(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.Object result, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logDaoMethodThrowing(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.RuntimeException e) Logs the abnormal end of a DAO method.
protected void	logDaoMethodThrowing(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.RuntimeException e, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logResultSetClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of a result set close.
protected void	logResultSetClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logSql(java.lang.String callerClassName, java.lang.String callerMethodName, Sql<?> sql) Logs an SQL statement.
protected void	logSql(java.lang.String callerClassName, java.lang.String callerMethodName, Sql<?> sql, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logSqlExecutionSkipping(java.lang.String callerClassName, java.lang.String callerMethodName, SqlExecutionSkipCause cause) Logs a skip of an SQL execution.
protected void	logSqlExecutionSkipping(java.lang.String callerClassName, java.lang.String callerMethodName, SqlExecutionSkipCause cause, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logStatementClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e) Logs a failure of a statement close.
protected void	logStatementClosingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logTransactionBegun(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId) Logs a beginning of a transaction.
protected void	logTransactionBegun(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logTransactionCommitted(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId) Logs a commit of a transaction.
protected void	logTransactionCommitted(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logTransactionEnded(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId) Logs an end of a transaction.
protected void	logTransactionEnded(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
void	logTransactionIsolationSettingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, int transactionIsolationLevel, java.sql.SQLException e) Logs a failure of a transaction isolation setting.
protected void	logTransactionIsolationSettingFailure(java.lang.String callerClassName, java.lang.String callerMethodName, int transactionIsolationLevel, java.sql.SQLException e, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
protected void	logTransactionRollbackFailure(java.lang.String callerClassName, java.lang.String callerMethodName, java.sql.SQLException e, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
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.
protected void	logTransactionRolledback(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
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.
protected void	logTransactionSavepointCreated(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, java.lang.String savepointName, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
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.
protected void	logTransactionSavepointReleased(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, java.lang.String savepointName, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)
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.
protected void	logTransactionSavepointRolledback(java.lang.String callerClassName, java.lang.String callerMethodName, java.lang.String transactionId, java.lang.String savepointName, LEVEL level, java.util.function.Supplier<java.lang.String> messageSupplier)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultLevel

protected LEVEL defaultLevel

the default log level

Constructor Detail

AbstractJdbcLogger

protected AbstractJdbcLogger(LEVEL level)

Creates an instance with a log level.

Parameters:

level - the log level

Method Detail

log

protected abstract void log(LEVEL level,
                            java.lang.String callerClassName,
                            java.lang.String callerMethodName,
                            java.lang.Throwable throwable,
                            java.util.function.Supplier<java.lang.String> messageSupplier)

Logs an error or an exception.

Parameters:

level - the log level

callerClassName - the caller class name

callerMethodName - the caller method name

throwable - the error or exception

messageSupplier - the message supplier

logDaoMethodEntering

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

Description copied from interface: JdbcLogger

Logs the start of a DAO method.

Specified by:

logDaoMethodEntering in interface JdbcLogger

Parameters:

callerClassName - the name of the DAO class

callerMethodName - the name of the DAO method

args - the arguments of the DAO method

logDaoMethodEntering

protected void logDaoMethodEntering(java.lang.String callerClassName,
                                    java.lang.String callerMethodName,
                                    java.lang.Object[] args,
                                    LEVEL level,
                                    java.util.function.Supplier<java.lang.String> messageSupplier)

logDaoMethodExiting

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

Description copied from interface: JdbcLogger

Logs the normal end of a DAO method.

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

Specified by:

logDaoMethodExiting in interface JdbcLogger

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

logDaoMethodExiting

protected void logDaoMethodExiting(java.lang.String callerClassName,
                                   java.lang.String callerMethodName,
                                   java.lang.Object result,
                                   LEVEL level,
                                   java.util.function.Supplier<java.lang.String> messageSupplier)

logDaoMethodThrowing

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

Description copied from interface: JdbcLogger

Logs the abnormal end of a DAO method.

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

Specified by:

logDaoMethodThrowing in interface JdbcLogger

Parameters:

callerClassName - the name of the DAO class

callerMethodName - the name of the DAO method

e - the runtime exception

logDaoMethodThrowing

protected void logDaoMethodThrowing(java.lang.String callerClassName,
                                    java.lang.String callerMethodName,
                                    java.lang.RuntimeException e,
                                    LEVEL level,
                                    java.util.function.Supplier<java.lang.String> messageSupplier)

logSqlExecutionSkipping

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

Description copied from interface: JdbcLogger

Logs a skip of an SQL execution.

Specified by:

logSqlExecutionSkipping in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

cause - the cause of the skip

logSqlExecutionSkipping

protected void logSqlExecutionSkipping(java.lang.String callerClassName,
                                       java.lang.String callerMethodName,
                                       SqlExecutionSkipCause cause,
                                       LEVEL level,
                                       java.util.function.Supplier<java.lang.String> messageSupplier)

logSql

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

Description copied from interface: JdbcLogger

Logs an SQL statement.

Specified by:

logSql in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

sql - SQL

logSql

protected void logSql(java.lang.String callerClassName,
                      java.lang.String callerMethodName,
                      Sql<?> sql,
                      LEVEL level,
                      java.util.function.Supplier<java.lang.String> messageSupplier)

getSqlText

protected java.lang.String getSqlText(Sql<?> sql)

logTransactionBegun

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

Description copied from interface: JdbcLogger

Logs a beginning of a transaction.

Specified by:

logTransactionBegun in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionBegun

protected void logTransactionBegun(java.lang.String callerClassName,
                                   java.lang.String callerMethodName,
                                   java.lang.String transactionId,
                                   LEVEL level,
                                   java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionEnded

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

Description copied from interface: JdbcLogger

Logs an end of a transaction.

Specified by:

logTransactionEnded in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionEnded

protected void logTransactionEnded(java.lang.String callerClassName,
                                   java.lang.String callerMethodName,
                                   java.lang.String transactionId,
                                   LEVEL level,
                                   java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionSavepointCreated

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

Description copied from interface: JdbcLogger

Logs a creation of a save point.

Specified by:

logTransactionSavepointCreated in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

savepointName - the save point name

logTransactionSavepointCreated

protected void logTransactionSavepointCreated(java.lang.String callerClassName,
                                              java.lang.String callerMethodName,
                                              java.lang.String transactionId,
                                              java.lang.String savepointName,
                                              LEVEL level,
                                              java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionCommitted

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

Description copied from interface: JdbcLogger

Logs a commit of a transaction.

Specified by:

logTransactionCommitted in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionCommitted

protected void logTransactionCommitted(java.lang.String callerClassName,
                                       java.lang.String callerMethodName,
                                       java.lang.String transactionId,
                                       LEVEL level,
                                       java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionRolledback

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

Description copied from interface: JdbcLogger

Logs a rollback of a transaction.

Specified by:

logTransactionRolledback in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

logTransactionRolledback

protected void logTransactionRolledback(java.lang.String callerClassName,
                                        java.lang.String callerMethodName,
                                        java.lang.String transactionId,
                                        LEVEL level,
                                        java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionSavepointRolledback

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

Description copied from interface: JdbcLogger

Logs a rollback of a save point.

Specified by:

logTransactionSavepointRolledback in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

savepointName - the save point name

logTransactionSavepointRolledback

protected void logTransactionSavepointRolledback(java.lang.String callerClassName,
                                                 java.lang.String callerMethodName,
                                                 java.lang.String transactionId,
                                                 java.lang.String savepointName,
                                                 LEVEL level,
                                                 java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionSavepointReleased

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

Description copied from interface: JdbcLogger

Logs a release of a save point.

Specified by:

logTransactionSavepointReleased in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

savepointName - the save point name

logTransactionSavepointReleased

protected void logTransactionSavepointReleased(java.lang.String callerClassName,
                                               java.lang.String callerMethodName,
                                               java.lang.String transactionId,
                                               java.lang.String savepointName,
                                               LEVEL level,
                                               java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionRollbackFailure

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

Description copied from interface: JdbcLogger

Logs a failure of a transaction rollback.

Specified by:

logTransactionRollbackFailure in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

transactionId - the transaction id

e - the cause of the failure

logTransactionRollbackFailure

protected void logTransactionRollbackFailure(java.lang.String callerClassName,
                                             java.lang.String callerMethodName,
                                             java.sql.SQLException e,
                                             LEVEL level,
                                             java.util.function.Supplier<java.lang.String> messageSupplier)

logAutoCommitEnablingFailure

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

Description copied from interface: JdbcLogger

Logs a failure of an auto commit enabling.

Specified by:

logAutoCommitEnablingFailure in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

Connection.setAutoCommit(boolean)

logAutoCommitEnablingFailure

protected void logAutoCommitEnablingFailure(java.lang.String callerClassName,
                                            java.lang.String callerMethodName,
                                            java.sql.SQLException e,
                                            LEVEL level,
                                            java.util.function.Supplier<java.lang.String> messageSupplier)

logTransactionIsolationSettingFailure

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

Description copied from interface: JdbcLogger

Logs a failure of a transaction isolation setting.

Specified by:

logTransactionIsolationSettingFailure in interface JdbcLogger

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)

logTransactionIsolationSettingFailure

protected void logTransactionIsolationSettingFailure(java.lang.String callerClassName,
                                                     java.lang.String callerMethodName,
                                                     int transactionIsolationLevel,
                                                     java.sql.SQLException e,
                                                     LEVEL level,
                                                     java.util.function.Supplier<java.lang.String> messageSupplier)

logConnectionClosingFailure

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

Description copied from interface: JdbcLogger

Logs a failure of a connection close.

Specified by:

logConnectionClosingFailure in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

Connection.close()

logConnectionClosingFailure

protected void logConnectionClosingFailure(java.lang.String callerClassName,
                                           java.lang.String callerMethodName,
                                           java.sql.SQLException e,
                                           LEVEL level,
                                           java.util.function.Supplier<java.lang.String> messageSupplier)

logStatementClosingFailure

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

Description copied from interface: JdbcLogger

Logs a failure of a statement close.

Specified by:

logStatementClosingFailure in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

Statement.close()

logStatementClosingFailure

protected void logStatementClosingFailure(java.lang.String callerClassName,
                                          java.lang.String callerMethodName,
                                          java.sql.SQLException e,
                                          LEVEL level,
                                          java.util.function.Supplier<java.lang.String> messageSupplier)

logResultSetClosingFailure

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

Description copied from interface: JdbcLogger

Logs a failure of a result set close.

Specified by:

logResultSetClosingFailure in interface JdbcLogger

Parameters:

callerClassName - the caller class name

callerMethodName - the caller method name

e - the cause of the failure

See Also:

ResultSet.close()

logResultSetClosingFailure

protected void logResultSetClosingFailure(java.lang.String callerClassName,
                                          java.lang.String callerMethodName,
                                          java.sql.SQLException e,
                                          LEVEL level,
                                          java.util.function.Supplier<java.lang.String> messageSupplier)