Class MapConnectionFactoryLookup

java.lang.Object

org.springframework.r2dbc.connection.lookup.MapConnectionFactoryLookup

All Implemented Interfaces:

ConnectionFactoryLookup

public class MapConnectionFactoryLookup
extends Object
implements ConnectionFactoryLookup

Simple ConnectionFactoryLookup implementation that relies on a map for doing lookups.

Useful for testing environments or applications that need to match arbitrary String names to target ConnectionFactory objects.

Since:

5.3

Author:

Mark Paluch, Jens Schauder

Constructor Summary

Constructors

Constructor	Description
MapConnectionFactoryLookup()	Create a new instance of the MapConnectionFactoryLookup class.
MapConnectionFactoryLookup(String connectionFactoryName, ConnectionFactory connectionFactory)	Create a new instance of the MapConnectionFactoryLookup class.
MapConnectionFactoryLookup(Map<String, ConnectionFactory> connectionFactories)	Create a new instance of the MapConnectionFactoryLookup class.

Method Summary

Modifier and Type	Method	Description
void	addConnectionFactory(String connectionFactoryName, ConnectionFactory connectionFactory)	Add the supplied ConnectionFactory to the map of ConnectionFactory instances maintained by this object.
Map<String, ConnectionFactory>	getConnectionFactories()	Get the Map of ConnectionFactories maintained by this object.
ConnectionFactory	getConnectionFactory(String connectionFactoryName)	Retrieve the ConnectionFactory identified by the given name.
void	setConnectionFactories(Map<String, ConnectionFactory> connectionFactories)	Set the Map of ConnectionFactories.

Methods inherited from class Object

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

Constructor Details

MapConnectionFactoryLookup

public MapConnectionFactoryLookup()

Create a new instance of the MapConnectionFactoryLookup class.

MapConnectionFactoryLookup

public MapConnectionFactoryLookup(Map<String, ConnectionFactory> connectionFactories)

Create a new instance of the MapConnectionFactoryLookup class.

Parameters:

connectionFactories - the Map of ConnectionFactory. The keys are Strings, the values are actual ConnectionFactory instances.

MapConnectionFactoryLookup

public MapConnectionFactoryLookup(String connectionFactoryName,
 ConnectionFactory connectionFactory)

Create a new instance of the MapConnectionFactoryLookup class.

Parameters:

connectionFactoryName - the name under which the supplied ConnectionFactory is to be added

connectionFactory - the ConnectionFactory to be added

Method Details

setConnectionFactories

public void setConnectionFactories(Map<String, ConnectionFactory> connectionFactories)

Set the Map of ConnectionFactories. The keys are Strings, the values are actual ConnectionFactory instances.

If the supplied Map is null, then this method call effectively has no effect.

Parameters:

connectionFactories - said Map of connectionFactories

getConnectionFactories

public Map<String, ConnectionFactory> getConnectionFactories()

Get the Map of ConnectionFactories maintained by this object.

The returned Map is unmodifiable.

Returns:

Map of connectionFactory (never null)

addConnectionFactory

public void addConnectionFactory(String connectionFactoryName,
 ConnectionFactory connectionFactory)

Add the supplied ConnectionFactory to the map of ConnectionFactory instances maintained by this object.

Parameters:

connectionFactoryName - the name under which the supplied ConnectionFactory is to be added

connectionFactory - the ConnectionFactory to be so added

getConnectionFactory

public ConnectionFactory getConnectionFactory(String connectionFactoryName)
                                       throws ConnectionFactoryLookupFailureException

Description copied from interface: ConnectionFactoryLookup

Retrieve the ConnectionFactory identified by the given name.

Specified by:

getConnectionFactory in interface ConnectionFactoryLookup

Parameters:

connectionFactoryName - the name of the ConnectionFactory

Returns:

the ConnectionFactory (never null)

Throws:

ConnectionFactoryLookupFailureException - if the lookup failed