io.awspring.cloud.jdbc.rds

Class AmazonRdsReadReplicaAwareDataSourceFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<DataSource>

io.awspring.cloud.jdbc.rds.AmazonRdsDataSourceFactoryBean

io.awspring.cloud.jdbc.rds.AmazonRdsReadReplicaAwareDataSourceFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<DataSource>, InitializingBean

public class AmazonRdsReadReplicaAwareDataSourceFactoryBean
extends AmazonRdsDataSourceFactoryBean

AmazonRdsDataSourceFactoryBean sub-class that is capable to handle amazon rds read-replicas. This is especially useful in case of read-heavy applications to leverage read-replica instance for all read-accesses.

Author:

Agim Emruli

Field Summary

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
AmazonRdsReadReplicaAwareDataSourceFactoryBean(com.amazonaws.services.rds.AmazonRDS amazonRDS, String dbInstanceIdentifier, String password) Constructor which retrieves all mandatory objects to allow the object to be constructed.

Method Summary

Modifier and Type	Method and Description
protected DataSource	createInstance() Constructs a ReadOnlyRoutingDataSource data source that contains the regular data source as a default, and all read-replicas as additional data source.
protected void	destroyInstance(DataSource instance)

Methods inherited from class io.awspring.cloud.jdbc.rds.AmazonRdsDataSourceFactoryBean

createDataSourceInstance, getDbInstance, getDbInstanceIdentifier, getObjectType, setDatabaseName, setDataSourceFactory, setResourceIdResolver, setUsername

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonRdsReadReplicaAwareDataSourceFactoryBean

public AmazonRdsReadReplicaAwareDataSourceFactoryBean(com.amazonaws.services.rds.AmazonRDS amazonRDS,
                                                      String dbInstanceIdentifier,
                                                      String password)

Constructor which retrieves all mandatory objects to allow the object to be constructed. This are the minimal configuration options which uses defaults or no values for all optional elements.

Parameters:

amazonRDS - - The amazonRDS instance used to connect to the service. This object will be used to actually retrieve the datasource metadata from the Amazon RDS service.

dbInstanceIdentifier - - the unique database instance identifier in the Amazon RDS service

password - - The password used to connect to the datasource. For security reasons the password is not available in the

Method Detail

createInstance

protected DataSource createInstance()
                             throws Exception

Constructs a ReadOnlyRoutingDataSource data source that contains the regular data source as a default, and all read-replicas as additional data source. The ReadOnlyRoutingDataSource is additionally wrapped with a LazyConnectionDataSourceProxy, because the read-only flag is only available after the transactional context has been established. This is only the case if the physical connection is requested after the transaction start and not while starting a transaction.

Overrides:

createInstance in class AmazonRdsDataSourceFactoryBean

Returns:

a ReadOnlyRoutingDataSource that is wrapped with a LazyConnectionDataSourceProxy

Throws:

Exception - if the underlying data source setup throws any exception

destroyInstance

protected void destroyInstance(DataSource instance)
                        throws Exception

Overrides:

destroyInstance in class AmazonRdsDataSourceFactoryBean

Throws:

Exception