io.awspring.cloud.jdbc.datasource.support

Interface DatabasePlatformSupport

All Known Implementing Classes:

MapBasedDatabasePlatformSupport, StaticDatabasePlatformSupport

public interface DatabasePlatformSupport

Support interface used by the DataSourceFactory implementation to retrieve the necessary configuration data for every database platform. As databases platform have differences in the URL scheme, driver class name this interface provides an abstraction to retrieve the information based on the particular database platform.

Normally this information is provided at configuration time by the user, because of the fact that Spring Cloud AWS creates the datasource at runtime, this information must be provided through a registry.

Since:

1.0

Author:

Agim Emruli

Method Summary

Modifier and Type	Method and Description
String	getDatabaseUrlForDatabase(DatabaseType databaseType, String hostname, int port, String databaseName) Constructs the database URL for the database instance.
String	getDriverClassNameForDatabase(DatabaseType databaseType) Returns the fully qualified driver class name for the database platform.

Method Detail

getDriverClassNameForDatabase

String getDriverClassNameForDatabase(DatabaseType databaseType)

Returns the fully qualified driver class name for the database platform. Implementation may return one static driver class name or check for the existence of different driver class on the class path and return the best matching one.

Parameters:

databaseType - - The database type for which the database driver class should be returned.

Returns:

The fully qualified driver class name used to connect to the database.

getDatabaseUrlForDatabase

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

Constructs the database URL for the database instance. Implementation will typically infer the URI scheme from the database type (e.g. for mysql jdbc:mysql). The remaining parts like the hostname and port are used to fully construct the url based on the database platform.

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:

- A fully constructed and valid url for the datasource to connect to the database platform.