org.jooq.impl

Class DefaultConfiguration

java.lang.Object

org.jooq.impl.DefaultConfiguration

All Implemented Interfaces:

Serializable, Configuration

public class DefaultConfiguration
extends Object
implements Configuration

A default implementation for configurations within a DSLContext, if no custom configuration was supplied to DSL.using(Configuration).

The DefaultConfiguration

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultConfiguration() Create a new "empty" configuration object.

Method Summary

Modifier and Type	Method and Description
ConnectionProvider	connectionProvider() Get this configuration's underlying connection provider.
ConverterProvider	converterProvider() Get the configured ConverterProvider from this configuration.
ConcurrentHashMap<Object,Object>	data() Get all custom data from this Configuration.
Object	data(Object key) Get some custom data from this Configuration.
Object	data(Object key, Object value) Set some custom data to this Configuration.
Configuration	derive() Create a derived configuration from this one, without changing any properties.
Configuration	derive(Connection newConnection) Create a derived configuration from this one, with a new connection wrapped in a DefaultConnectionProvider.
Configuration	derive(ConnectionProvider newConnectionProvider) Create a derived configuration from this one, with a new connection provider.
Configuration	derive(ConverterProvider newConverterProvider) Create a derived configuration from this one, with new converter provider.
Configuration	derive(DataSource newDataSource) Create a derived configuration from this one, with a new data source wrapped in a DataSourceConnectionProvider.
Configuration	derive(ExecuteListenerProvider... newExecuteListenerProviders) Create a derived configuration from this one, with new execute listener providers.
Configuration	derive(ExecutorProvider newExecutorProvider) Create a derived configuration from this one, with a new executor provider.
Configuration	derive(RecordListenerProvider... newRecordListenerProviders) Create a derived configuration from this one, with new record listener providers.
Configuration	derive(RecordMapperProvider newRecordMapperProvider) Create a derived configuration from this one, with a new record mapper provider.
Configuration	derive(Settings newSettings) Create a derived configuration from this one, with new settings.
Configuration	derive(SQLDialect newDialect) Create a derived configuration from this one, with a new dialect.
Configuration	derive(TransactionProvider newTransactionProvider) Create a derived configuration from this one, with a new transaction provider.
Configuration	derive(VisitListenerProvider... newVisitListenerProviders) Create a derived configuration from this one, with new visit listener providers.
SQLDialect	dialect() Retrieve the configured dialect.
ExecuteListenerProvider[]	executeListenerProviders() Get the configured ExecuteListenerProviders from this configuration.
ExecutorProvider	executorProvider() Get this configuration's underlying executor provider.
SQLDialect	family() Retrieve the family of the configured dialect.
RecordListenerProvider[]	recordListenerProviders() Get the configured RecordListenerProviders from this configuration.
RecordMapperProvider	recordMapperProvider() Get this configuration's underlying record mapper provider.
SchemaMapping	schemaMapping() Deprecated.
Configuration	set(Connection newConnection) Change this configuration to hold a new connection wrapped in a DefaultConnectionProvider.
Configuration	set(ConnectionProvider newConnectionProvider) Change this configuration to hold a new connection provider.
Configuration	set(ConverterProvider newConverterProvider) Change this configuration to hold a new converter provider.
Configuration	set(DataSource newDataSource) Change this configuration to hold a new data source wrapped in a DataSourceConnectionProvider.
Configuration	set(ExecuteListenerProvider... newExecuteListenerProviders) Change this configuration to hold a new execute listener providers.
Configuration	set(ExecutorProvider newExecutorProvider) Change this configuration to hold a new executor provider.
Configuration	set(RecordListenerProvider... newRecordListenerProviders) Change this configuration to hold a new record listener providers.
Configuration	set(RecordMapperProvider newRecordMapperProvider) Change this configuration to hold a new record mapper provider.
Configuration	set(Settings newSettings) Change this configuration to hold a new settings.
Configuration	set(SQLDialect newDialect) Change this configuration to hold a new dialect.
Configuration	set(TransactionProvider newTransactionProvider) Change this configuration to hold a new transaction provider.
Configuration	set(VisitListenerProvider... newVisitListenerProviders) Change this configuration to hold a new visit listener providers.
void	setConnection(Connection newConnection)
void	setConnectionProvider(ConnectionProvider newConnectionProvider)
void	setDataSource(DataSource newDataSource)
void	setExecuteListenerProvider(ExecuteListenerProvider... newExecuteListenerProviders)
void	setExecutorProvider(ExecutorProvider newExecutorProvider)
void	setRecordListenerProvider(RecordListenerProvider... newRecordListenerProviders)
void	setRecordMapperProvider(RecordMapperProvider newRecordMapperProvider)
void	setSettings(Settings newSettings)
void	setSQLDialect(SQLDialect newDialect)
Settings	settings() Retrieve the runtime configuration settings.
void	setTransactionProvider(TransactionProvider newTransactionProvider)
void	setVisitListenerProvider(VisitListenerProvider... newVisitListenerProviders)
String	toString()
TransactionProvider	transactionProvider() Get this configuration's underlying transaction provider.
VisitListenerProvider[]	visitListenerProviders() TODO [#2667]

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfiguration

public DefaultConfiguration()

Create a new "empty" configuration object.

This can be used as is, as a "dummy" configuration object, or as a base implementation for creating more sophisticated "derived" configurations through the various derive() or set() methods.

Method Detail

derive

public final Configuration derive()

Create a derived configuration from this one, without changing any properties.

Specified by:

derive in interface Configuration

Returns:

The derived configuration.

derive

public final Configuration derive(Connection newConnection)

Create a derived configuration from this one, with a new connection wrapped in a DefaultConnectionProvider.

Specified by:

derive in interface Configuration

Parameters:

newConnection - The new connection to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(DataSource newDataSource)

Create a derived configuration from this one, with a new data source wrapped in a DataSourceConnectionProvider.

Specified by:

derive in interface Configuration

Parameters:

newDataSource - The new data source to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(ConnectionProvider newConnectionProvider)

Create a derived configuration from this one, with a new connection provider.

Specified by:

derive in interface Configuration

Parameters:

newConnectionProvider - The new connection provider to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(ExecutorProvider newExecutorProvider)

Create a derived configuration from this one, with a new executor provider.

Specified by:

derive in interface Configuration

Parameters:

newExecutorProvider - The new executor provider to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(TransactionProvider newTransactionProvider)

Create a derived configuration from this one, with a new transaction provider.

Specified by:

derive in interface Configuration

Parameters:

newTransactionProvider - The new transaction provider to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(RecordMapperProvider newRecordMapperProvider)

Create a derived configuration from this one, with a new record mapper provider.

Specified by:

derive in interface Configuration

Parameters:

newRecordMapperProvider - The new record mapper provider to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(RecordListenerProvider... newRecordListenerProviders)

Create a derived configuration from this one, with new record listener providers.

Specified by:

derive in interface Configuration

Parameters:

newRecordListenerProviders - The new record listener providers to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(ExecuteListenerProvider... newExecuteListenerProviders)

Create a derived configuration from this one, with new execute listener providers.

Specified by:

derive in interface Configuration

Parameters:

newExecuteListenerProviders - The new execute listener providers to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(VisitListenerProvider... newVisitListenerProviders)

Create a derived configuration from this one, with new visit listener providers.

Specified by:

derive in interface Configuration

Parameters:

newVisitListenerProviders - The new visit listener providers to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(ConverterProvider newConverterProvider)

Create a derived configuration from this one, with new converter provider.

Specified by:

derive in interface Configuration

Parameters:

newConverterProvider - The new converter provider to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(SQLDialect newDialect)

Create a derived configuration from this one, with a new dialect.

Specified by:

derive in interface Configuration

Parameters:

newDialect - The new dialect to be contained in the derived configuration.

Returns:

The derived configuration.

derive

public final Configuration derive(Settings newSettings)

Create a derived configuration from this one, with new settings.

Specified by:

derive in interface Configuration

Parameters:

newSettings - The new settings to be contained in the derived configuration.

Returns:

The derived configuration.

set

public final Configuration set(Connection newConnection)

Change this configuration to hold a new connection wrapped in a DefaultConnectionProvider.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newConnection - The new connection to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(DataSource newDataSource)

Change this configuration to hold a new data source wrapped in a DataSourceConnectionProvider.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Returns:

The changed configuration.

set

public final Configuration set(ConnectionProvider newConnectionProvider)

Change this configuration to hold a new connection provider.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newConnectionProvider - The new connection provider to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(ExecutorProvider newExecutorProvider)

Change this configuration to hold a new executor provider.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newExecutorProvider - The new executor provider to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(TransactionProvider newTransactionProvider)

Change this configuration to hold a new transaction provider.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newTransactionProvider - The new transaction provider to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(RecordMapperProvider newRecordMapperProvider)

Change this configuration to hold a new record mapper provider.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newRecordMapperProvider - The new record mapper provider to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(RecordListenerProvider... newRecordListenerProviders)

Change this configuration to hold a new record listener providers.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newRecordListenerProviders - The new record listener providers to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(ExecuteListenerProvider... newExecuteListenerProviders)

Change this configuration to hold a new execute listener providers.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newExecuteListenerProviders - The new execute listener providers to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(VisitListenerProvider... newVisitListenerProviders)

Change this configuration to hold a new visit listener providers.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newVisitListenerProviders - The new visit listener providers to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(ConverterProvider newConverterProvider)

Description copied from interface: Configuration

Change this configuration to hold a new converter provider.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newConverterProvider - The new converter provider to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(SQLDialect newDialect)

Change this configuration to hold a new dialect.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newDialect - The new dialect to be contained in the changed configuration.

Returns:

The changed configuration.

set

public final Configuration set(Settings newSettings)

Change this configuration to hold a new settings.

This method is not thread-safe and should not be used in globally available Configuration objects.

Specified by:

set in interface Configuration

Parameters:

newSettings - The new settings to be contained in the changed configuration.

Returns:

The changed configuration.

setConnection

public final void setConnection(Connection newConnection)

See Also:

set(Connection)

setDataSource

public final void setDataSource(DataSource newDataSource)

See Also:

set(DataSource)

setConnectionProvider

public final void setConnectionProvider(ConnectionProvider newConnectionProvider)

See Also:

set(ConnectionProvider)

setExecutorProvider

public final void setExecutorProvider(ExecutorProvider newExecutorProvider)

See Also:

set(ExecutorProvider)

setTransactionProvider

public final void setTransactionProvider(TransactionProvider newTransactionProvider)

See Also:

set(TransactionProvider)

setRecordMapperProvider

public final void setRecordMapperProvider(RecordMapperProvider newRecordMapperProvider)

See Also:

set(RecordMapperProvider)

setRecordListenerProvider

public final void setRecordListenerProvider(RecordListenerProvider... newRecordListenerProviders)

See Also:

set(RecordListenerProvider[])

setExecuteListenerProvider

public final void setExecuteListenerProvider(ExecuteListenerProvider... newExecuteListenerProviders)

See Also:

set(ExecuteListenerProvider[])

setVisitListenerProvider

public final void setVisitListenerProvider(VisitListenerProvider... newVisitListenerProviders)

See Also:

set(VisitListenerProvider[])

setSQLDialect

public final void setSQLDialect(SQLDialect newDialect)

See Also:

set(SQLDialect)

setSettings

public final void setSettings(Settings newSettings)

See Also:

set(Settings)

connectionProvider

public final ConnectionProvider connectionProvider()

Get this configuration's underlying connection provider.

Specified by:

connectionProvider in interface Configuration

executorProvider

public final ExecutorProvider executorProvider()

Get this configuration's underlying executor provider.

Asynchronous operations will call back to this SPI to obtain an executor. This applies, for example, to ResultQuery.fetchAsync().

The following logic is applied when resolving the appropriate executor:

1. If Configuration.executorProvider() does not return null, then ExecutorProvider.provide() is called to obtain an Executor for the asynchronous task.
2. In the jOOQ Java 8 distribution, ForkJoinPool.commonPool() is used if ForkJoinPool.getCommonPoolParallelism() > 1
3. A new "one thread per call" Executor is used in any other case.

The SPI will not be called if an asynchronous operation explicitly overrides the Executor, e.g. as is the case for ResultQuery.fetchAsync(Executor).

Specified by:

executorProvider in interface Configuration

transactionProvider

public final TransactionProvider transactionProvider()

Get this configuration's underlying transaction provider.

If no explicit transaction provider was specified, and if Configuration.connectionProvider() is a DefaultConnectionProvider, then this will return a DefaultTransactionProvider.

Specified by:

transactionProvider in interface Configuration

recordMapperProvider

public final RecordMapperProvider recordMapperProvider()

Get this configuration's underlying record mapper provider.

Specified by:

recordMapperProvider in interface Configuration

recordListenerProviders

public final RecordListenerProvider[] recordListenerProviders()

Get the configured RecordListenerProviders from this configuration.

This method allows for retrieving the configured RecordListenerProvider from this configuration. The providers will provide jOOQ with RecordListener instances. These instances receive record manipulation notification events every time jOOQ executes queries. jOOQ makes no assumptions about the internal state of these listeners, i.e. listener instances may

• share this Configuration's lifecycle (i.e. that of a JDBC Connection, or that of a transaction)
• share the lifecycle of an RecordContext (i.e. that of a single record manipulation)
• follow an entirely different lifecycle.

Specified by:

recordListenerProviders in interface Configuration

Returns:

The configured set of record listeners.

See Also:

RecordListenerProvider, RecordListener, RecordContext

executeListenerProviders

public final ExecuteListenerProvider[] executeListenerProviders()

Get the configured ExecuteListenerProviders from this configuration.

This method allows for retrieving the configured ExecuteListenerProvider from this configuration. The providers will provide jOOQ with ExecuteListener instances. These instances receive execution lifecycle notification events every time jOOQ executes queries. jOOQ makes no assumptions about the internal state of these listeners, i.e. listener instances may

• share this Configuration's lifecycle (i.e. that of a JDBC Connection, or that of a transaction)
• share the lifecycle of an ExecuteContext (i.e. that of a single query execution)
• follow an entirely different lifecycle.

Note, depending on your Settings.isExecuteLogging(), some additional listeners may be prepended to this list, internally. Those listeners will never be exposed through this method, though.

Specified by:

executeListenerProviders in interface Configuration

Returns:

The configured set of execute listeners.

See Also:

ExecuteListenerProvider, ExecuteListener, ExecuteContext

visitListenerProviders

public final VisitListenerProvider[] visitListenerProviders()

TODO [#2667]

Specified by:

visitListenerProviders in interface Configuration

converterProvider

public final ConverterProvider converterProvider()

Get the configured ConverterProvider from this configuration.

Specified by:

converterProvider in interface Configuration

dialect

public final SQLDialect dialect()

Retrieve the configured dialect.

Specified by:

dialect in interface Configuration

family

public final SQLDialect family()

Retrieve the family of the configured dialect.

Specified by:

family in interface Configuration

settings

public final Settings settings()

Retrieve the runtime configuration settings.

Specified by:

settings in interface Configuration

data

public final ConcurrentHashMap<Object,Object> data()

Get all custom data from this Configuration.

This is custom data that was previously set to the configuration using Configuration.data(Object, Object). Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.

See ExecuteListener for more details.

Specified by:

data in interface Configuration

Returns:

The custom data. This is never null

See Also:

ExecuteListener

data

public final Object data(Object key)

Get some custom data from this Configuration.

This is custom data that was previously set to the configuration using Configuration.data(Object, Object). Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.

See ExecuteListener for more details.

Specified by:

data in interface Configuration

Parameters:

key - A key to identify the custom data

Returns:

The custom data or null if no such data is contained in this Configuration

See Also:

ExecuteListener

data

public final Object data(Object key,
                         Object value)

Set some custom data to this Configuration.

Use custom data if you want to pass data to your custom QueryPart or ExecuteListener objects to be made available at render, bind, execution, fetch time.

Be sure that your custom data implements Serializable if you want to serialise this Configuration or objects referencing this Configuration, e.g. your Record types.

See ExecuteListener for more details.

Specified by:

data in interface Configuration

Parameters:

key - A key to identify the custom data

value - The custom data

Returns:

The previously set custom data or null if no data was previously set for the given key

See Also:

ExecuteListener

schemaMapping

@Deprecated
public final SchemaMapping schemaMapping()

Deprecated.

Retrieve the configured schema mapping.

Specified by:

schemaMapping in interface Configuration

toString

public String toString()

Overrides:

toString in class Object