ProxyDataSourceBuilder (datasource-proxy 1.9 API)

java.lang.Object
- net.ttddyy.dsproxy.support.ProxyDataSourceBuilder

```
public class ProxyDataSourceBuilder
extends Object
```
Builder for ProxyDataSource.

Since:

1.3

Author:

Tadaya Tsuyukubo

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProxyDataSourceBuilder.FormatQueryCallback` Functional interface to be called for formatting a query.
`static interface`	`ProxyDataSourceBuilder.SingleMethodExecution` Functional interface to simplify adding `MethodExecutionListener`.
`static interface`	`ProxyDataSourceBuilder.SingleQueryExecution` Functional interface to simplify adding `QueryExecutionListener`.

Constructor Summary

Constructors
Constructor and Description

ProxyDataSourceBuilder()

ProxyDataSourceBuilder(DataSource dataSource)

Constructors
Constructor and Description
`ProxyDataSourceBuilder()`
`ProxyDataSourceBuilder(DataSource dataSource)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProxyDataSourceBuilder`	`afterMethod(ProxyDataSourceBuilder.SingleMethodExecution callback)` Add `MethodExecutionListener` that performs given lambda on `MethodExecutionListener.afterMethod(MethodExecutionContext)`.
`ProxyDataSourceBuilder`	`afterQuery(ProxyDataSourceBuilder.SingleQueryExecution callback)` Add `QueryExecutionListener` that performs given lambda on `QueryExecutionListener.afterQuery(ExecutionInfo, List)`.
`ProxyDataSourceBuilder`	`asJson()` Format logging output as JSON.
`ProxyDataSourceBuilder`	`autoRetrieveGeneratedKeys(boolean autoClose)` Enable auto retrieval of generated keys.
`ProxyDataSourceBuilder`	`autoRetrieveGeneratedKeys(boolean autoClose, ResultSetProxyLogicFactory factory)` Enable auto retrieval of generated keys with proxy created by specified factory.
`ProxyDataSourceBuilder`	`autoRetrieveGeneratedKeysWithRepeatableReadProxy(boolean autoClose)` Enable auto retrieval of generated keys with `RepeatableReadResultSetProxyLogicFactory`.
`ProxyDataSourceBuilder`	`beforeMethod(ProxyDataSourceBuilder.SingleMethodExecution callback)` Add `MethodExecutionListener` that performs given lambda on `MethodExecutionListener.beforeMethod(MethodExecutionContext)`.
`ProxyDataSourceBuilder`	`beforeQuery(ProxyDataSourceBuilder.SingleQueryExecution callback)` Add `QueryExecutionListener` that performs given lambda on `QueryExecutionListener.beforeQuery(ExecutionInfo, List)`.
`ProxyDataSource`	`build()`
`ProxyDataSourceBuilder`	`connectionIdManager(ConnectionIdManager connectionIdManager)` Register `ConnectionIdManager`.
`ProxyDataSourceBuilder`	`countQuery()` Create `DataSourceQueryCountListener`.
`ProxyDataSourceBuilder`	`countQuery(QueryCountStrategy queryCountStrategy)` Create `DataSourceQueryCountListener`.
`static ProxyDataSourceBuilder`	`create()`
`static ProxyDataSourceBuilder`	`create(DataSource dataSource)`
`static ProxyDataSourceBuilder`	`create(String dataSourceName, DataSource dataSource)`
`ProxyDataSourceBuilder`	`dataSource(DataSource dataSource)` Set actual datasource.
`ProxyDataSourceBuilder`	`formatQuery(ProxyDataSourceBuilder.FormatQueryCallback formatQueryCallback)` Take an callback that can format a query.
`ProxyDataSourceBuilder`	`jdbcProxyFactory(JdbcProxyFactory jdbcProxyFactory)` Register `JdbcProxyFactory`.
`ProxyDataSourceBuilder`	`listener(JdbcLifecycleEventListener listener)` Register given `JdbcLifecycleEventListener`.
`ProxyDataSourceBuilder`	`listener(QueryExecutionListener listener)` Register given listener.
`ProxyDataSourceBuilder`	`logQueryByCommons()` Register `CommonsQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByCommons(CommonsLogLevel logLevel)` Register `CommonsQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByCommons(CommonsLogLevel logLevel, String commonsLoggerName)` Register `CommonsQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByCommons(String commonsLoggerName)` Register `CommonsQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByJUL()` Register `JULQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByJUL(Level logLevel)` Register `JULQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByJUL(Level logLevel, String julLoggerName)` Register `JULQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByJUL(String julLoggerName)` Register `JULQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByLog4j()` Register `Log4jQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByLog4j(Log4jLogLevel log4jLogLevel)` Register `Log4jQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByLog4j(Log4jLogLevel logLevel, String loggerName)` Register `Log4jQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryByLog4j(String loggerName)` Register `Log4jQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryBySlf4j()` Register `SLF4JQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryBySlf4j(SLF4JLogLevel logLevel)` Register `SLF4JQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryBySlf4j(SLF4JLogLevel logLevel, String slf4jLoggerName)` Register `SLF4JQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryBySlf4j(String slf4jLoggerName)` Register `SLF4JQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logQueryToSysOut()` Register `SystemOutQueryLoggingListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByCommons(long thresholdTime, TimeUnit timeUnit)` Register `CommonsSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByCommons(long thresholdTime, TimeUnit timeUnit, CommonsLogLevel logLevel)` Register `CommonsSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByCommons(long thresholdTime, TimeUnit timeUnit, CommonsLogLevel logLevel, String logName)` Register `CommonsSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByCommons(long thresholdTime, TimeUnit timeUnit, String logName)` Register `CommonsSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByJUL(long thresholdTime, TimeUnit timeUnit)` Register `JULSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByJUL(long thresholdTime, TimeUnit timeUnit, Level logLevel)` Register `JULSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByJUL(long thresholdTime, TimeUnit timeUnit, Level logLevel, String loggerName)` Register `JULSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByJUL(long thresholdTime, TimeUnit timeUnit, String loggerName)` Register `JULSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByLog4j(long thresholdTime, TimeUnit timeUnit)` Register `Log4jSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByLog4j(long thresholdTime, TimeUnit timeUnit, Log4jLogLevel logLevel)` Register `Log4jSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByLog4j(long thresholdTime, TimeUnit timeUnit, Log4jLogLevel logLevel, String loggerName)` Register `Log4jSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryByLog4j(long thresholdTime, TimeUnit timeUnit, String loggerName)` Register `Log4jSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryBySlf4j(long thresholdTime, TimeUnit timeUnit)` Register `SLF4JSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryBySlf4j(long thresholdTime, TimeUnit timeUnit, SLF4JLogLevel logLevel)` Register `SLF4JSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryBySlf4j(long thresholdTime, TimeUnit timeUnit, SLF4JLogLevel logLevel, String loggerName)` Register `SLF4JSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryBySlf4j(long thresholdTime, TimeUnit timeUnit, String loggerName)` Register `SLF4JSlowQueryListener`.
`ProxyDataSourceBuilder`	`logSlowQueryToSysOut(long thresholdTime, TimeUnit timeUnit)` Register `SystemOutSlowQueryListener`.
`ProxyDataSourceBuilder`	`methodListener(MethodExecutionListener listener)` Add `MethodExecutionListener`.
`ProxyDataSourceBuilder`	`multiline()` Use multiline output for logging query.
`ProxyDataSourceBuilder`	`name(String dataSourceName)` Set datasource name.
`ProxyDataSourceBuilder`	`parameterTransformer(ParameterTransformer parameterTransformer)` Register `ParameterTransformer`.
`ProxyDataSourceBuilder`	`proxyGeneratedKeys()` Enable `ResultSet` proxy for generated keys(e.g.: Statement#getGeneratedKeys()).
`ProxyDataSourceBuilder`	`proxyGeneratedKeys(ResultSetProxyLogicFactory factory)` Enable `ResultSet` proxy for generated keys with given proxy logic factory.
`ProxyDataSourceBuilder`	`proxyResultSet()` Enable resultset proxy.
`ProxyDataSourceBuilder`	`proxyResultSet(ResultSetProxyLogicFactory factory)` Enable resultset proxy with given proxy logic factory.
`ProxyDataSourceBuilder`	`queryTransformer(QueryTransformer queryTransformer)` Register `QueryTransformer`.
`ProxyDataSourceBuilder`	`repeatableReadGeneratedKeys()` Enable `ResultSet` proxy for generated keys that allows repeatable read.
`ProxyDataSourceBuilder`	`repeatableReadResultSet()` Enable resultset proxy that allows repeatable read.
`ProxyDataSourceBuilder`	`retrieveGeneratedKeysForBatch(boolean forStatement, boolean forPreparedOrCallable)` Configure generated-keys retrieval for batch statement and prepared/callable when auto retrieval is enabled.
`ProxyDataSourceBuilder`	`traceMethods()` Enable `TracingMethodListener`.
`ProxyDataSourceBuilder`	`traceMethods(TracingMethodListener.TracingMessageConsumer messageConsumer)` Enable `TracingMethodListener` with consumer that receives trace logging message.
`ProxyDataSourceBuilder`	`traceMethodsWhen(TracingMethodListener.TracingCondition condition)` Enable `TracingMethodListener`.
`ProxyDataSourceBuilder`	`traceMethodsWhen(TracingMethodListener.TracingCondition condition, TracingMethodListener.TracingMessageConsumer messageConsumer)` Enable `TracingMethodListener`.
`ProxyDataSourceBuilder`	`writeIsolation()` Add connection isolation to logging query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProxyDataSourceBuilder
```
public ProxyDataSourceBuilder()
```
  - ProxyDataSourceBuilder
```
public ProxyDataSourceBuilder(DataSource dataSource)
```
- Method Detail
  - create
```
public static ProxyDataSourceBuilder create()
```
  - create
```
public static ProxyDataSourceBuilder create(DataSource dataSource)
```
  - create
```
public static ProxyDataSourceBuilder create(String dataSourceName,
                                            DataSource dataSource)
```
  - dataSource
```
public ProxyDataSourceBuilder dataSource(DataSource dataSource)
```
    Set actual datasource.
    
    Parameters:
    
    dataSource - actual datasource
    
    Returns:
    
    builder
  - logQueryByCommons
```
public ProxyDataSourceBuilder logQueryByCommons()
```
    Register CommonsQueryLoggingListener.
    
    Returns:
    
    builder
  - logQueryByCommons
```
public ProxyDataSourceBuilder logQueryByCommons(CommonsLogLevel logLevel)
```
    Register CommonsQueryLoggingListener.
    
    Parameters:
    
    logLevel - log level for commons
    
    Returns:
    
    builder
  - logQueryByCommons
```
public ProxyDataSourceBuilder logQueryByCommons(String commonsLoggerName)
```
    Register CommonsQueryLoggingListener.
    
    Parameters:
    
    commonsLoggerName - commons logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.3.1
  - logQueryByCommons
```
public ProxyDataSourceBuilder logQueryByCommons(CommonsLogLevel logLevel,
                                                String commonsLoggerName)
```
    Register CommonsQueryLoggingListener.
    
    Parameters:
    
    logLevel - log level for commons
    
    commonsLoggerName - commons logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.3.1
  - logSlowQueryByCommons
```
public ProxyDataSourceBuilder logSlowQueryByCommons(long thresholdTime,
                                                    TimeUnit timeUnit)
```
    Register CommonsSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryByCommons
```
public ProxyDataSourceBuilder logSlowQueryByCommons(long thresholdTime,
                                                    TimeUnit timeUnit,
                                                    CommonsLogLevel logLevel)
```
    Register CommonsSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for commons
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryByCommons
```
public ProxyDataSourceBuilder logSlowQueryByCommons(long thresholdTime,
                                                    TimeUnit timeUnit,
                                                    String logName)
```
    Register CommonsSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logName - commons logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryByCommons
```
public ProxyDataSourceBuilder logSlowQueryByCommons(long thresholdTime,
                                                    TimeUnit timeUnit,
                                                    CommonsLogLevel logLevel,
                                                    String logName)
```
    Register CommonsSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for commons
    
    logName - commons logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logQueryBySlf4j
```
public ProxyDataSourceBuilder logQueryBySlf4j()
```
    Register SLF4JQueryLoggingListener.
    
    Returns:
    
    builder
  - logQueryBySlf4j
```
public ProxyDataSourceBuilder logQueryBySlf4j(SLF4JLogLevel logLevel)
```
    Register SLF4JQueryLoggingListener.
    
    Parameters:
    
    logLevel - log level for slf4j
    
    Returns:
    
    builder
  - logQueryBySlf4j
```
public ProxyDataSourceBuilder logQueryBySlf4j(String slf4jLoggerName)
```
    Register SLF4JQueryLoggingListener.
    
    Parameters:
    
    slf4jLoggerName - slf4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.3.1
  - logQueryBySlf4j
```
public ProxyDataSourceBuilder logQueryBySlf4j(SLF4JLogLevel logLevel,
                                              String slf4jLoggerName)
```
    Register SLF4JQueryLoggingListener.
    
    Parameters:
    
    logLevel - log level for slf4j
    
    slf4jLoggerName - slf4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.3.1
  - logSlowQueryBySlf4j
```
public ProxyDataSourceBuilder logSlowQueryBySlf4j(long thresholdTime,
                                                  TimeUnit timeUnit)
```
    Register SLF4JSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryBySlf4j
```
public ProxyDataSourceBuilder logSlowQueryBySlf4j(long thresholdTime,
                                                  TimeUnit timeUnit,
                                                  SLF4JLogLevel logLevel)
```
    Register SLF4JSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for slf4j
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryBySlf4j
```
public ProxyDataSourceBuilder logSlowQueryBySlf4j(long thresholdTime,
                                                  TimeUnit timeUnit,
                                                  String loggerName)
```
    Register SLF4JSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    loggerName - slf4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryBySlf4j
```
public ProxyDataSourceBuilder logSlowQueryBySlf4j(long thresholdTime,
                                                  TimeUnit timeUnit,
                                                  SLF4JLogLevel logLevel,
                                                  String loggerName)
```
    Register SLF4JSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for slf4j
    
    loggerName - slf4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logQueryByJUL
```
public ProxyDataSourceBuilder logQueryByJUL()
```
    Register JULQueryLoggingListener.
    
    Returns:
    
    builder
    
    Since:
    
    1.4
  - logQueryByJUL
```
public ProxyDataSourceBuilder logQueryByJUL(Level logLevel)
```
    Register JULQueryLoggingListener.
    
    Parameters:
    
    logLevel - log level for JUL
    
    Returns:
    
    builder
    
    Since:
    
    1.4
  - logQueryByJUL
```
public ProxyDataSourceBuilder logQueryByJUL(String julLoggerName)
```
    Register JULQueryLoggingListener.
    
    Parameters:
    
    julLoggerName - JUL logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4
  - logQueryByJUL
```
public ProxyDataSourceBuilder logQueryByJUL(Level logLevel,
                                            String julLoggerName)
```
    Register JULQueryLoggingListener.
    
    Parameters:
    
    logLevel - log level for JUL
    
    julLoggerName - JUL logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4
  - logSlowQueryByJUL
```
public ProxyDataSourceBuilder logSlowQueryByJUL(long thresholdTime,
                                                TimeUnit timeUnit)
```
    Register JULSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryByJUL
```
public ProxyDataSourceBuilder logSlowQueryByJUL(long thresholdTime,
                                                TimeUnit timeUnit,
                                                Level logLevel)
```
    Register JULSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for JUL
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryByJUL
```
public ProxyDataSourceBuilder logSlowQueryByJUL(long thresholdTime,
                                                TimeUnit timeUnit,
                                                String loggerName)
```
    Register JULSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    loggerName - JUL logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logSlowQueryByJUL
```
public ProxyDataSourceBuilder logSlowQueryByJUL(long thresholdTime,
                                                TimeUnit timeUnit,
                                                Level logLevel,
                                                String loggerName)
```
    Register JULSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for JUL
    
    loggerName - JUL logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - logQueryByLog4j
```
public ProxyDataSourceBuilder logQueryByLog4j()
```
    Register Log4jQueryLoggingListener.
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logQueryByLog4j
```
public ProxyDataSourceBuilder logQueryByLog4j(Log4jLogLevel log4jLogLevel)
```
    Register Log4jQueryLoggingListener.
    
    Parameters:
    
    log4jLogLevel - log level for log4j
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logQueryByLog4j
```
public ProxyDataSourceBuilder logQueryByLog4j(String loggerName)
```
    Register Log4jQueryLoggingListener.
    
    Parameters:
    
    loggerName - log4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logQueryByLog4j
```
public ProxyDataSourceBuilder logQueryByLog4j(Log4jLogLevel logLevel,
                                              String loggerName)
```
    Register Log4jQueryLoggingListener.
    
    Parameters:
    
    logLevel - log level for log4j
    
    loggerName - log4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logSlowQueryByLog4j
```
public ProxyDataSourceBuilder logSlowQueryByLog4j(long thresholdTime,
                                                  TimeUnit timeUnit)
```
    Register Log4jSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logSlowQueryByLog4j
```
public ProxyDataSourceBuilder logSlowQueryByLog4j(long thresholdTime,
                                                  TimeUnit timeUnit,
                                                  Log4jLogLevel logLevel)
```
    Register Log4jSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for log4j
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logSlowQueryByLog4j
```
public ProxyDataSourceBuilder logSlowQueryByLog4j(long thresholdTime,
                                                  TimeUnit timeUnit,
                                                  String loggerName)
```
    Register Log4jSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    loggerName - Log4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logSlowQueryByLog4j
```
public ProxyDataSourceBuilder logSlowQueryByLog4j(long thresholdTime,
                                                  TimeUnit timeUnit,
                                                  Log4jLogLevel logLevel,
                                                  String loggerName)
```
    Register Log4jSlowQueryListener.
    
    Parameters:
    
    thresholdTime - slow query threshold time
    
    timeUnit - slow query threshold time unit
    
    logLevel - log level for JUL
    
    loggerName - Log4j logger name
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - logQueryToSysOut
```
public ProxyDataSourceBuilder logQueryToSysOut()
```
    Register SystemOutQueryLoggingListener.
    
    Returns:
    
    builder
  - logSlowQueryToSysOut
```
public ProxyDataSourceBuilder logSlowQueryToSysOut(long thresholdTime,
                                                   TimeUnit timeUnit)
```
    Register SystemOutSlowQueryListener.
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - countQuery
```
public ProxyDataSourceBuilder countQuery()
```
    Create DataSourceQueryCountListener.
    
    Returns:
    
    builder
  - countQuery
```
public ProxyDataSourceBuilder countQuery(QueryCountStrategy queryCountStrategy)
```
    Create DataSourceQueryCountListener.
    
    Returns:
    
    builder
    
    Since:
    
    1.4.2
  - listener
```
public ProxyDataSourceBuilder listener(QueryExecutionListener listener)
```
    Register given listener.
    
    Parameters:
    
    listener - a listener to register
    
    Returns:
    
    builder
  - listener
```
public ProxyDataSourceBuilder listener(JdbcLifecycleEventListener listener)
```
    Register given JdbcLifecycleEventListener.
    
    Parameters:
    
    listener - a listener to register
    
    Returns:
    
    builder
    
    Since:
    
    1.5
  - beforeQuery
```
public ProxyDataSourceBuilder beforeQuery(ProxyDataSourceBuilder.SingleQueryExecution callback)
```
    Add QueryExecutionListener that performs given lambda on QueryExecutionListener.beforeQuery(ExecutionInfo, List).
    
    Parameters:
    
    callback - a lambda function executed on QueryExecutionListener.beforeQuery(ExecutionInfo, List)
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - afterQuery
```
public ProxyDataSourceBuilder afterQuery(ProxyDataSourceBuilder.SingleQueryExecution callback)
```
    Add QueryExecutionListener that performs given lambda on QueryExecutionListener.afterQuery(ExecutionInfo, List).
    
    Parameters:
    
    callback - a lambda function executed on QueryExecutionListener.afterQuery(ExecutionInfo, List)
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - asJson
```
public ProxyDataSourceBuilder asJson()
```
    Format logging output as JSON.
    This method is mutually exclusive to formatQuery(FormatQueryCallback).
    
    Returns:
    
    builder
  - name
```
public ProxyDataSourceBuilder name(String dataSourceName)
```
    Set datasource name.
    
    Parameters:
    
    dataSourceName - datasource name
    
    Returns:
    
    builder
  - queryTransformer
```
public ProxyDataSourceBuilder queryTransformer(QueryTransformer queryTransformer)
```
    Register QueryTransformer.
    
    Parameters:
    
    queryTransformer - a query-transformer to register
    
    Returns:
    
    builder
  - parameterTransformer
```
public ProxyDataSourceBuilder parameterTransformer(ParameterTransformer parameterTransformer)
```
    Register ParameterTransformer.
    
    Parameters:
    
    parameterTransformer - a query-parameter-transformer to register
    
    Returns:
    
    builder
  - multiline
```
public ProxyDataSourceBuilder multiline()
```
    Use multiline output for logging query.
    
    Returns:
    
    builder
    
    Since:
    
    1.4.1
  - formatQuery
```
public ProxyDataSourceBuilder formatQuery(ProxyDataSourceBuilder.FormatQueryCallback formatQueryCallback)
```
    Take an callback that can format a query.
    This method is mutually exclusive to asJson().
    
    Parameters:
    
    formatQueryCallback - A callback to format the query
    
    Returns:
    
    builder
    
    Since:
    
    1.9
  - writeIsolation
```
public ProxyDataSourceBuilder writeIsolation()
```
    Add connection isolation to logging query.
    
    Returns:
    
    builder
    
    Since:
    
    1.8
  - jdbcProxyFactory
```
public ProxyDataSourceBuilder jdbcProxyFactory(JdbcProxyFactory jdbcProxyFactory)
```
    Register JdbcProxyFactory.
    
    Parameters:
    
    jdbcProxyFactory - a JdbcProxyFactory to register
    
    Returns:
    
    builder
    
    Since:
    
    1.4.2
  - connectionIdManager
```
public ProxyDataSourceBuilder connectionIdManager(ConnectionIdManager connectionIdManager)
```
    Register ConnectionIdManager.
    
    Parameters:
    
    connectionIdManager - a ConnectionIdManager to register
    
    Returns:
    
    builder
    
    Since:
    
    1.4.2
  - proxyResultSet
```
public ProxyDataSourceBuilder proxyResultSet()
```
    Enable resultset proxy. When it is enabled, returned ResultSet will be proxied(e.g.: Statement#executeQuery()).
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - proxyResultSet
```
public ProxyDataSourceBuilder proxyResultSet(ResultSetProxyLogicFactory factory)
```
    Enable resultset proxy with given proxy logic factory.
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - proxyGeneratedKeys
```
public ProxyDataSourceBuilder proxyGeneratedKeys()
```
    Enable ResultSet proxy for generated keys(e.g.: Statement#getGeneratedKeys()).
    
    Returns:
    
    builder
    
    Since:
    
    1.4.5
  - proxyGeneratedKeys
```
public ProxyDataSourceBuilder proxyGeneratedKeys(ResultSetProxyLogicFactory factory)
```
    Enable ResultSet proxy for generated keys with given proxy logic factory.
    
    Returns:
    
    builder
    
    Since:
    
    1.4.5
  - repeatableReadGeneratedKeys
```
public ProxyDataSourceBuilder repeatableReadGeneratedKeys()
```
    Enable ResultSet proxy for generated keys that allows repeatable read.
    
    Returns:
    
    builder
    
    Since:
    
    1.4.5
  - autoRetrieveGeneratedKeys
```
public ProxyDataSourceBuilder autoRetrieveGeneratedKeys(boolean autoClose)
```
    Enable auto retrieval of generated keys. When it is enabled, after executing query, it always call Statement.getGeneratedKeys(). The retrieved ResultSet is available via ExecutionInfo.getGeneratedKeys(). When this configuration is combined with proxyGeneratedKeys(ResultSetProxyLogicFactory), the proxied ResultSet will be returned from ExecutionInfo.getGeneratedKeys(). When autoClose parameter is set to true, datasource-proxy will close the generated-keys ResultSet after it called QueryExecutionListener.afterQuery(ExecutionInfo, List). This behavior might not be ideal if above layer, such as OR Mapper or application code, need to access generated-keys because when they access generated-keys, the resultset is already closed. To support such usecase, specify RepeatableReadResultSetProxyLogicFactory and set autoClose=false. This way, even though your QueryExecutionListener has accessed generated-keys, it is still readable at upper layer of the code, and they can close the generated-keys resultset.
    
    Parameters:
    
    autoClose - set true to close the generated-keys ResultSet after query listener execution
    
    Returns:
    
    builder
    
    Since:
    
    1.4.5
  - autoRetrieveGeneratedKeys
```
public ProxyDataSourceBuilder autoRetrieveGeneratedKeys(boolean autoClose,
                                                        ResultSetProxyLogicFactory factory)
```
    Enable auto retrieval of generated keys with proxy created by specified factory. See detail on autoRetrieveGeneratedKeys(boolean).
    
    Parameters:
    
    autoClose - set true to close the generated-keys ResultSet after query listener execution
    
    factory - a factory to create a generated-keys proxy
    
    Returns:
    
    builder
    
    Since:
    
    1.4.5
  - autoRetrieveGeneratedKeysWithRepeatableReadProxy
```
public ProxyDataSourceBuilder autoRetrieveGeneratedKeysWithRepeatableReadProxy(boolean autoClose)
```
    Enable auto retrieval of generated keys with RepeatableReadResultSetProxyLogicFactory. See detail on autoRetrieveGeneratedKeys(boolean).
    
    Parameters:
    
    autoClose - set true to close the generated-keys ResultSet after query listener execution
    
    Returns:
    
    builder
    
    Since:
    
    1.4.5
  - retrieveGeneratedKeysForBatch
```
public ProxyDataSourceBuilder retrieveGeneratedKeysForBatch(boolean forStatement,
                                                            boolean forPreparedOrCallable)
```
    Configure generated-keys retrieval for batch statement and prepared/callable when auto retrieval is enabled. Since JDBC spec defines creation of generated-keys for batch executions are driver implementation specific, this method controls whether to auto-retrieve generated-keys for batch execution of Statement and PreparedStatement / CallableStatement. Setting is only effective when generated-keys auto-retrieval is enabled. Defult values are set false for Statement, true for PreparedStatement and CallableStatement.
    
    Parameters:
    
    forStatement - for Statement
    
    forPreparedOrCallable - for PreparedStatement and CallableStatement
    
    Returns:
    
    builder
    
    Since:
    
    1.4.6
  - repeatableReadResultSet
```
public ProxyDataSourceBuilder repeatableReadResultSet()
```
    Enable resultset proxy that allows repeatable read. Equivalent to proxyResultSet(new RepeatableReadResultSetProxyLogicFactory())
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - methodListener
```
public ProxyDataSourceBuilder methodListener(MethodExecutionListener listener)
```
    Add MethodExecutionListener.
    
    Parameters:
    
    listener - a method execution listener
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - beforeMethod
```
public ProxyDataSourceBuilder beforeMethod(ProxyDataSourceBuilder.SingleMethodExecution callback)
```
    Add MethodExecutionListener that performs given lambda on MethodExecutionListener.beforeMethod(MethodExecutionContext).
    
    Parameters:
    
    callback - a lambda function executed on MethodExecutionListener.beforeMethod(MethodExecutionContext)
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - afterMethod
```
public ProxyDataSourceBuilder afterMethod(ProxyDataSourceBuilder.SingleMethodExecution callback)
```
    Add MethodExecutionListener that performs given lambda on MethodExecutionListener.afterMethod(MethodExecutionContext).
    
    Parameters:
    
    callback - a lambda function executed on MethodExecutionListener.afterMethod(MethodExecutionContext)
    
    Returns:
    
    builder
    
    Since:
    
    1.4.3
  - traceMethods
```
public ProxyDataSourceBuilder traceMethods()
```
    Enable TracingMethodListener.
    
    Returns:
    
    builder
    
    Since:
    
    1.4.4
  - traceMethods
```
public ProxyDataSourceBuilder traceMethods(TracingMethodListener.TracingMessageConsumer messageConsumer)
```
    Enable TracingMethodListener with consumer that receives trace logging message.
    
    Parameters:
    
    messageConsumer - receives trace logging message
    
    Returns:
    
    builder
    
    Since:
    
    1.4.4
  - traceMethodsWhen
```
public ProxyDataSourceBuilder traceMethodsWhen(TracingMethodListener.TracingCondition condition)
```
    Enable TracingMethodListener. When given condition returns true, it prints out trace log. The condition is used for dynamically turn on/off tracing.
    
    Parameters:
    
    condition - decide to turn on/off tracing
    
    Returns:
    
    builder
    
    Since:
    
    1.4.4
  - traceMethodsWhen
```
public ProxyDataSourceBuilder traceMethodsWhen(TracingMethodListener.TracingCondition condition,
                                               TracingMethodListener.TracingMessageConsumer messageConsumer)
```
    Enable TracingMethodListener. When given condition returns true, it prints out trace log. The condition is used for dynamically turn on/off tracing. The message consumer receives a tracing message that can be printed to console, logger, etc.
    
    Parameters:
    
    condition - decide to turn on/off tracing
    
    messageConsumer - receives trace logging message
    
    Returns:
    
    builder
    
    Since:
    
    1.4.4
  - build
```
public ProxyDataSource build()
```

Class ProxyDataSourceBuilder

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProxyDataSourceBuilder

ProxyDataSourceBuilder

Method Detail

create

create

create

dataSource

logQueryByCommons

logQueryByCommons

logQueryByCommons

logQueryByCommons

logSlowQueryByCommons

logSlowQueryByCommons

logSlowQueryByCommons

logSlowQueryByCommons

logQueryBySlf4j

logQueryBySlf4j

logQueryBySlf4j

logQueryBySlf4j

logSlowQueryBySlf4j

logSlowQueryBySlf4j

logSlowQueryBySlf4j

logSlowQueryBySlf4j

logQueryByJUL

logQueryByJUL

logQueryByJUL

logQueryByJUL

logSlowQueryByJUL

logSlowQueryByJUL

logSlowQueryByJUL

logSlowQueryByJUL

logQueryByLog4j

logQueryByLog4j

logQueryByLog4j

logQueryByLog4j

logSlowQueryByLog4j

logSlowQueryByLog4j

logSlowQueryByLog4j

logSlowQueryByLog4j

logQueryToSysOut

logSlowQueryToSysOut

countQuery

countQuery

listener

listener

beforeQuery

afterQuery

asJson

name

queryTransformer

parameterTransformer

multiline

formatQuery

writeIsolation

jdbcProxyFactory

connectionIdManager

proxyResultSet

proxyResultSet

proxyGeneratedKeys

proxyGeneratedKeys

repeatableReadGeneratedKeys

autoRetrieveGeneratedKeys

autoRetrieveGeneratedKeys

autoRetrieveGeneratedKeysWithRepeatableReadProxy

retrieveGeneratedKeysForBatch

repeatableReadResultSet

methodListener

beforeMethod

afterMethod

traceMethods

traceMethods

traceMethodsWhen

traceMethodsWhen

build