ProxyDataSourceBuilder (datasource-proxy 1.4.2 API)

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

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

Since:

1.3

Author:

Tadaya Tsuyukubo

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`	`asJson()` Format logging output as JSON.
`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`	`jdbcProxyFactory(JdbcProxyFactory jdbcProxyFactory)` Register `JdbcProxyFactory`.
`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`	`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`	`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`	`multiline()` Use multiline output for logging query.
`ProxyDataSourceBuilder`	`name(String dataSourceName)` Set datasource name.
`ProxyDataSourceBuilder`	`parameterTransformer(ParameterTransformer parameterTransformer)` Register `ParameterTransformer`.
`ProxyDataSourceBuilder`	`queryTransformer(QueryTransformer queryTransformer)` Register `QueryTransformer`.

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)

Parameters:: logLevel - log level for commons; commonsLoggerName - commons logger name
Returns:: builder
Since:: 1.3.1

logSlowQueryByCommons

public ProxyDataSourceBuilder logSlowQueryByCommons(long thresholdTime,
                                                    TimeUnit timeUnit)

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)

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)

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)

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)

Parameters:: logLevel - log level for slf4j; slf4jLoggerName - slf4j logger name
Returns:: builder
Since:: 1.3.1

logSlowQueryBySlf4j

public ProxyDataSourceBuilder logSlowQueryBySlf4j(long thresholdTime,
                                                  TimeUnit timeUnit)

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)

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)

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)

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)

Parameters:: logLevel - log level for JUL; julLoggerName - JUL logger name
Returns:: builder
Since:: 1.4

logSlowQueryByJUL

public ProxyDataSourceBuilder logSlowQueryByJUL(long thresholdTime,
                                                TimeUnit timeUnit)

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)

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)

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)

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

logQueryToSysOut
```
public ProxyDataSourceBuilder logQueryToSysOut()
```
Register SystemOutQueryLoggingListener.

Returns:

builder

logSlowQueryToSysOut

public ProxyDataSourceBuilder logSlowQueryToSysOut(long thresholdTime,
                                                   TimeUnit timeUnit)

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

asJson
```
public ProxyDataSourceBuilder asJson()
```
Format logging output as JSON.

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

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

build
```
public ProxyDataSource build()
```

Class ProxyDataSourceBuilder

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

logQueryToSysOut

logSlowQueryToSysOut

countQuery

countQuery

listener

asJson

name

queryTransformer

parameterTransformer

multiline

jdbcProxyFactory

connectionIdManager

build