org.springframework.cloud.aws.jdbc.datasource

Class DataSourceInformation

java.lang.Object

org.springframework.cloud.aws.jdbc.datasource.DataSourceInformation

public final class DataSourceInformation
extends Object

Immutable parameter object that holds all information needed by the DataSourceFactory implementation to create a datasource. The attributes inside this class represents the minimal information for the DataSourceFactory to actually create the underlying datasource.

This parameter object is used to allow a more flexible DataSourceFactory interface

Since:

1.0

Author:

Agim Emruli

Constructor Summary

Constructors

Constructor and Description
DataSourceInformation(DatabaseType databaseType, String hostName, Integer port, String databaseName, String userName, String password) Main constructor to create this object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDatabaseName() The database name used to connect to the database.
DatabaseType	getDatabaseType() Returns the database type provided by this class.
String	getHostName() Returns the host name which will be used to connect to the database.
String	getPassword() The password used to connect to the database.
Integer	getPort() Returns the port used to connect to the database.
String	getUserName() The username used to connect to the database.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataSourceInformation

public DataSourceInformation(DatabaseType databaseType,
                             String hostName,
                             Integer port,
                             String databaseName,
                             String userName,
                             String password)

Main constructor to create this object. This constructor receives all information to fully construct the object and to allow the implementation to be immutable.

Parameters:

databaseType - - The database type used by the datasource to connect to. This information will be typically used to instantiate and use the particular driver class to connect to the database platform.

hostName - - The fully qualified hostname without any protocol or port information (e.g. myDbServer.domain.com, localhost, 192.168.23.1)

port - - The port used to connect to the particular database platform (eg. 3306 as a default for mysql)

databaseName - - The database name used to connect to the database. The meaning is database specific for (e.g for mysql the database name, for oracle the SID id)

userName - - The username used to connect to the database

password - - The password used to connect to the database

Method Detail

getDatabaseType

public DatabaseType getDatabaseType()

Returns the database type provided by this class. Represented by an enumeration based on the supported database platform in the AWS platform.

Returns:

- The databaseType - never null

getHostName

public String getHostName()

Returns the host name which will be used to connect to the database. This is only the hostname without any further protocol information.

Returns:

- The hostname - never null

getPort

public Integer getPort()

Returns the port used to connect to the database.

Returns:

- The port - never null

getDatabaseName

public String getDatabaseName()

The database name used to connect to the database. The information is databaseType type specific.

• MySQL - This is the database name to connect to
• Oracle - This is the system id (SID) to connect to
• SQLSERVER - This information is not used at all

Returns:

- The database name that can be used to connect to the database.

getUserName

public String getUserName()

The username used to connect to the database. The user must have the right to connect to the database.

Returns:

- The username never null

getPassword

public String getPassword()

The password used to connect to the database. The password might be empty but not null.

Returns:

- the password - never null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object