io.r2dbc.spi

Interface ConnectionFactoryProvider

public interface ConnectionFactoryProvider

A Java Service interface for implementations to examine a collection of ConnectionFactoryOptions and optionally return an implementation of ConnectionFactory.

ConnectionFactoryProvider implementations are typically discovered by ConnectionFactories from the class path using ServiceLoader.

See Also:

ConnectionFactoryOptions, ConnectionFactory, ConnectionFactories, ServiceLoader

Method Summary

Modifier and Type	Method and Description
ConnectionFactory	create(ConnectionFactoryOptions connectionFactoryOptions) Creates a new ConnectionFactory given a collection of ConnectionFactoryOptions.
String	getDriver() Returns the driver identifier used by the driver.
boolean	supports(ConnectionFactoryOptions connectionFactoryOptions) Whether this ConnectionFactoryProvider supports this collection of ConnectionFactoryOptions.

Method Detail

create

ConnectionFactory create(ConnectionFactoryOptions connectionFactoryOptions)

Creates a new ConnectionFactory given a collection of ConnectionFactoryOptions. This method is only called if a previous invocation of supports(ConnectionFactoryOptions) has returned true.

Parameters:

connectionFactoryOptions - a collection of ConnectionFactoryOptions

Returns:

the ConnectionFactory created from this collection of ConnectionFactoryOptions

Throws:

IllegalArgumentException - if connectionFactoryOptions is null

supports

boolean supports(ConnectionFactoryOptions connectionFactoryOptions)

Whether this ConnectionFactoryProvider supports this collection of ConnectionFactoryOptions.

Parameters:

connectionFactoryOptions - a collection of ConnectionFactoryOptions

Returns:

true if this ConnectionFactoryProvider supports this collection of ConnectionFactoryOptions, false otherwise

Throws:

IllegalArgumentException - if connectionFactoryOptions is null

getDriver

String getDriver()

Returns the driver identifier used by the driver. The identifier for drivers would be the value applicable to ConnectionFactoryOptions.DRIVER

Returns:

the driver identifier used by the driver