net.ttddyy.dsproxy.support

Class ProxyDataSourceBuilder

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.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)

Method Summary

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	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	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	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	proxyResultSet() Enable resultset proxy.
ProxyDataSourceBuilder	proxyResultSet(ResultSetProxyLogicFactory factory) Enable resultset proxy with given proxy logic factory.
ProxyDataSourceBuilder	queryTransformer(QueryTransformer queryTransformer) Register QueryTransformer.
ProxyDataSourceBuilder	repeatableReadResultSet() Enable resultset proxy that allows repeatable read.

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

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

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.

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

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

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

build

public ProxyDataSource build()