Class OptionsCapableConnectionFactory

java.lang.Object

org.springframework.boot.r2dbc.OptionsCapableConnectionFactory

All Implemented Interfaces:

ConnectionFactory, Wrapped<ConnectionFactory>

public class OptionsCapableConnectionFactory
extends Object
implements Wrapped<ConnectionFactory>, ConnectionFactory

ConnectionFactory capable of providing access to the ConnectionFactoryOptions from which it was built.

Since:

2.5.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor	Description
OptionsCapableConnectionFactory(ConnectionFactoryOptions options, ConnectionFactory delegate)	Create a new OptionsCapableConnectionFactory that will provide access to the given options that were used to build the given delegate ConnectionFactory.

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<? extends Connection>	create()
ConnectionFactoryMetadata	getMetadata()
ConnectionFactoryOptions	getOptions()
ConnectionFactory	unwrap()
static @Nullable OptionsCapableConnectionFactory	unwrapFrom(ConnectionFactory connectionFactory)	Returns, if possible, an OptionsCapableConnectionFactory by unwrapping the given connectionFactory as necessary.

Methods inherited from class Object

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

Methods inherited from interface Wrapped

unwrap

Constructor Details

OptionsCapableConnectionFactory

public OptionsCapableConnectionFactory(ConnectionFactoryOptions options,
 ConnectionFactory delegate)

Create a new OptionsCapableConnectionFactory that will provide access to the given options that were used to build the given delegate ConnectionFactory.

Parameters:

options - the options from which the connection factory was built

delegate - the delegate connection factory that was built with options

Method Details

getOptions

public ConnectionFactoryOptions getOptions()

create

public org.reactivestreams.Publisher<? extends Connection> create()

Specified by:

create in interface ConnectionFactory

getMetadata

public ConnectionFactoryMetadata getMetadata()

Specified by:

getMetadata in interface ConnectionFactory

unwrap

public ConnectionFactory unwrap()

Specified by:

unwrap in interface Wrapped<ConnectionFactory>

unwrapFrom

public static @Nullable OptionsCapableConnectionFactory unwrapFrom(ConnectionFactory connectionFactory)

Returns, if possible, an OptionsCapableConnectionFactory by unwrapping the given connectionFactory as necessary. If the given connectionFactory does not wrap an OptionsCapableConnectionFactory and is not itself an OptionsCapableConnectionFactory, null is returned.

Parameters:

connectionFactory - the connection factory to unwrap

Returns:

the OptionsCapableConnectionFactory or null

Since:

2.5.1