org.springframework.cloud.aws.jdbc.rds

Class AmazonRdsDataSourceFactoryBean

java.lang.Object

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

org.springframework.cloud.aws.jdbc.rds.AmazonRdsDataSourceFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<DataSource>, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AmazonRdsReadReplicaAwareDataSourceFactoryBean

public class AmazonRdsDataSourceFactoryBean
extends org.springframework.beans.factory.config.AbstractFactoryBean<DataSource>

FactoryBean implementation that creates a datasource backed by an Amazon Relational Database service instance. This factory bean retrieves all the metadata from the AWS RDS service in order to create and configure a datasource. This class uses the AmazonRDS service to retrieve the metadata and the DataSourceFactory to actually create the datasource.

Since:

1.0

Author:

Agim Emruli

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
AmazonRdsDataSourceFactoryBean(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	createDataSourceInstance(String identifier) Creates a data source based in the instance name.
protected DataSource	createInstance()
protected void	destroyInstance(DataSource instance)
protected com.amazonaws.services.rds.model.DBInstance	getDbInstance(String identifier) Retrieves the DBInstance information
protected String	getDbInstanceIdentifier()
Class<DataSource>	getObjectType()
void	setDatabaseName(String databaseName) Configures an own database name to be used if the default database (that is configured in the meta-data) should not be used.
void	setDataSourceFactory(DataSourceFactory dataSourceFactory) Allows to configure a different DataSourceFactory in order to use a different DataSource implementation.
void	setResourceIdResolver(org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver) Configures an optional ResourceIdResolver used to resolve a logical name to a physical one.
void	setUsername(String username) Allows to set a different user then the master user name in order to connect to the database.

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

AmazonRdsDataSourceFactoryBean

public AmazonRdsDataSourceFactoryBean(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 metadata (in contrast to the user) so it must be provided in order to connect to the database with JDBC.

Method Detail

setDataSourceFactory

public void setDataSourceFactory(DataSourceFactory dataSourceFactory)

Allows to configure a different DataSourceFactory in order to use a different DataSource implementation. Uses the TomcatJdbcDataSourceFactory by default if not configured.

Parameters:

dataSourceFactory - - A fully configured DataSourceFactory instance, will be used to actually create the datasource.

setUsername

public void setUsername(String username)

Allows to set a different user then the master user name in order to connect to the database. In contrast to the password, the master user name is available in the metadata to connect to the database so this username is only used when configured.

Parameters:

username - - The username to connect to the database, every value provided (even empty ones) are used to connect to the database.

setDatabaseName

public void setDatabaseName(String databaseName)

Configures an own database name to be used if the default database (that is configured in the meta-data) should not be used.

Parameters:

databaseName - - the database name to be used while connecting

setResourceIdResolver

public void setResourceIdResolver(org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver)

Configures an optional ResourceIdResolver used to resolve a logical name to a physical one.

Parameters:

resourceIdResolver - - the resourceIdResolver instance, might be null or not called at all

getObjectType

public Class<DataSource> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<DataSource>

Specified by:

getObjectType in class org.springframework.beans.factory.config.AbstractFactoryBean<DataSource>

createInstance

protected DataSource createInstance()
                             throws Exception

Specified by:

createInstance in class org.springframework.beans.factory.config.AbstractFactoryBean<DataSource>

Throws:

Exception

destroyInstance

protected void destroyInstance(DataSource instance)
                        throws Exception

Overrides:

destroyInstance in class org.springframework.beans.factory.config.AbstractFactoryBean<DataSource>

Throws:

Exception

createDataSourceInstance

protected DataSource createDataSourceInstance(String identifier)
                                       throws Exception

Creates a data source based in the instance name. The physical information for the data source is retrieved by the name passed as identifier. This method does distinguish between regular amazon rds instances and read-replicas because both meta-data is retrieved on the same way.

Parameters:

identifier - - the database identifier for the data source configured in amazon rds

Returns:

a fully configured and initialized DataSource

Throws:

IllegalStateException - if no database has been found

Exception - in case of underlying exceptions

getDbInstance

protected com.amazonaws.services.rds.model.DBInstance getDbInstance(String identifier)
                                                             throws IllegalStateException

Retrieves the DBInstance information

Parameters:

identifier - - the database identifier used

Returns:

- the db instance

Throws:

IllegalStateException - if the db instance is not found

getDbInstanceIdentifier

protected String getDbInstanceIdentifier()