org.springframework.cloud.aws.jdbc.datasource.support

Class MapBasedDatabasePlatformSupport

java.lang.Object

org.springframework.cloud.aws.jdbc.datasource.support.MapBasedDatabasePlatformSupport

All Implemented Interfaces:

DatabasePlatformSupport

Direct Known Subclasses:

StaticDatabasePlatformSupport

public abstract class MapBasedDatabasePlatformSupport
extends Object
implements DatabasePlatformSupport

A map based implementation of the DatabasePlatformSupport interface. Sub classes must only provide map with the database specific information. This class takes care of asserting and computing the returned information.

Since:

1.0

Author:

Agim Emruli

Constructor Summary

Constructors

Constructor and Description
MapBasedDatabasePlatformSupport()

Method Summary

Modifier and Type	Method and Description
protected abstract Map<DatabaseType,String>	getAuthenticationInfo()
String	getDatabaseUrlForDatabase(DatabaseType databaseType, String hostname, int port, String databaseName) Constructs the URL for the database by using a URI to construct the URL
String	getDriverClassNameForDatabase(DatabaseType databaseType) Returns the driver class for the database platform.
protected abstract Map<DatabaseType,String>	getDriverClassNameMappings() Template method that must be implemented in order to retrieve all driver class names for every supported database platform.
protected abstract Map<DatabaseType,String>	getSchemeNames() Template method that mus be implemented to get all scheme names for every supported database platform.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBasedDatabasePlatformSupport

public MapBasedDatabasePlatformSupport()

Method Detail

getDriverClassNameForDatabase

public String getDriverClassNameForDatabase(DatabaseType databaseType)

Returns the driver class for the database platform.

Specified by:

getDriverClassNameForDatabase in interface DatabasePlatformSupport

Parameters:

databaseType - - The database type used to lookup the driver class name. Must not be null

Returns:

- The driver class name, is never null

Throws:

IllegalArgumentException - if there is not driver class name available for the DatabaseType

getDatabaseUrlForDatabase

public String getDatabaseUrlForDatabase(DatabaseType databaseType,
                                        String hostname,
                                        int port,
                                        String databaseName)

Constructs the URL for the database by using a URI to construct the URL

Specified by:

getDatabaseUrlForDatabase in interface DatabasePlatformSupport

Parameters:

databaseType - - The databaseType for which the URL should be constructed.

hostname - - The hostname without any port information used to connect to.

port - - The port used to connect to the database

databaseName - - The database name used to connect to. The usage is implementation specific (e.g. for Oracle this is the SID)

Returns:

- the database specific URL

Throws:

IllegalArgumentException - if there is no scheme available for the database type or if the information is not valid to construct a URL.

getDriverClassNameMappings

protected abstract Map<DatabaseType,String> getDriverClassNameMappings()

Template method that must be implemented in order to retrieve all driver class names for every supported database platform.

Returns:

Map containing the driver class name for every database platform

getSchemeNames

protected abstract Map<DatabaseType,String> getSchemeNames()

Template method that mus be implemented to get all scheme names for every supported database platform. Scheme names are unfortunately only standardized in the root scheme (jdbc:) but not in the sub-scheme which is database platform specific.

Returns:

Map containing the schema (and sub-scheme) names for every support database platform

getAuthenticationInfo

protected abstract Map<DatabaseType,String> getAuthenticationInfo()