software.amazon.timestream.jdbc

Class TimestreamDataSource

java.lang.Object

software.amazon.timestream.jdbc.TimestreamDataSource

All Implemented Interfaces:

Wrapper, EventListener, CommonDataSource, ConnectionEventListener, ConnectionPoolDataSource, DataSource

public class TimestreamDataSource
extends Object
implements DataSource, ConnectionPoolDataSource, ConnectionEventListener

DataSource implementation of Timestream, supports pooled and non-pooled connections.

Constructor Summary

Constructors

Constructor and Description
TimestreamDataSource()

Method Summary

Modifier and Type	Method and Description
void	connectionClosed(ConnectionEvent event)
void	connectionErrorOccurred(ConnectionEvent event)
protected TimestreamConnection	createTimestreamConnection(Properties info) Creates a TimestreamConnection object.
String	getAadAppId() Gets the unique id of the registered application on Azure AD.
String	getAadClientSecret() Gets the client secret associated with the registered application on Azure AD used to authorize fetching tokens.
String	getAadTenantId() Gets Azure Active Directory tenant ID.
String	getAccessKeyId() Getter for the AWS access key ID.
String	getAwsRoleArn() Gets the Amazon Resource Name (ARN) of the role that the caller is assuming.
Connection	getConnection()
Connection	getConnection(String accessKey, String secretKey)
String	getCredentialsFilePath() Gets the path to a properties file containing AWS security credentials `accessKey` and `secretKey`.
String	getCredentialsProviderClass() Gets credentials provider class.
String	getEndpoint() Getter for the Timestream service endpoint.
String	getIdpArn() Gets the Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
String	getIdpHost() Gets the hostname of the specified IdP.
String	getIdpName() Gets the Identity Provider (IdP) name to use for SAML-based authentication.
String	getIdpPassword() Gets the password for the specified IdP account.
String	getIdpUserName() Gets the user name for the specified IdP account.
int	getLoginTimeout()
PrintWriter	getLogWriter()
int	getMaxConnections() Gets the maximum number of allowed concurrently opened HTTP connections to the Timestream service.
int	getMaxRetryCount() Gets the maximum number of retry attempts for retryable errors with 5XX error codes in the client.
String	getOktaAppId() Gets the unique Okta-provided ID associated with the Timestream application.
Logger	getParentLogger()
PooledConnection	getPooledConnection()
PooledConnection	getPooledConnection(String accessKey, String secretKey)
String	getRegion() Getter for the database's region.
int	getRequestTimeout() Gets the time in milliseconds the client will wait for a query request before timing out.
String	getSecretAccessKey() Getter for the AWS secret access key.
String	getSessionToken() Getter for the temporary AWS session token.
int	getSocketTimeout() Gets the time in milliseconds the client will wait for data to be transferred over an open connection before timing out.
boolean	isEnableMetaDataPreparedStatement() Getter for the enableMetaDataPreparedStatement.
boolean	isWrapperFor(Class<?> iface)
void	setAadAppId(String aadAppId) Sets the unique id of the registered application on Azure AD.
void	setAadClientSecret(String aadClientSecret) Sets the client secret associated with the registered application on Azure AD used to authorize fetching tokens.
void	setAadTenantId(String aadTenantId) Sets Azure Active Directory tenant ID.
void	setAccessKeyId(String accessKeyId) Setter for the AWS access key ID.
void	setAwsRoleArn(String awsRoleArn) Sets the Amazon Resource Name (ARN) of the role that the caller is assuming.
void	setCredentialsFilePath(String credentialsFilePath) Sets the path to a properties file containing AWS security credentials `accessKey` and `secretKey`.
void	setCredentialsProviderClass(String credentialsProviderClass) Sets credentials provider class.
void	setEnableMetaDataPreparedStatement(boolean enableMetaDataPreparedStatement) Setter for tracking if the driver can return metadata for PreparedStatements.
void	setEndpoint(String endpoint) Setter for the Timestream service endpoint.
void	setIdpArn(String idpArn) Sets the Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
void	setIdpHost(String idpHost) Sets the hostname of the specified IdP.
void	setIdpName(String idpName) Sets the Identity Provider (IdP) name to use for SAML-based authentication.
void	setIdpPassword(String idpPassword) Sets the password for the specified IdP account.
void	setIdpUserName(String idpUserName) Sets the user name for the specified IdP account.
void	setLoginTimeout(int seconds)
void	setLogWriter(PrintWriter out)
void	setMaxConnections(int maxConnections) Sets the maximum number of allowed concurrently opened HTTP connections to the Timestream service.
void	setMaxRetryCount(int maxRetryCountClient) Sets the maximum retry attempts for retryable errors on the client.
void	setOktaAppId(String oktaAppId) Sets the unique Okta-provided ID associated with the Timestream application.
void	setRegion(String region) Setter for the AWS database region.
void	setRequestTimeout(int requestTimeout) Sets the time in milliseconds the client will wait for a query request before timing out.
void	setSecretAccessKey(String secretAccessKey) Setter for the AWS secret access key.
void	setSessionToken(String sessionToken) Setter for the AWS session token.
void	setSocketTimeout(int socketTimeout) Sets the time in milliseconds the client will wait for data to be transferred over an open connection before timing out.
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimestreamDataSource

public TimestreamDataSource()

Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String accessKey,
                                String secretKey)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getPooledConnection

public PooledConnection getPooledConnection()
                                     throws SQLException

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Throws:

SQLException

getPooledConnection

public PooledConnection getPooledConnection(String accessKey,
                                            String secretKey)
                                     throws SQLException

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Throws:

SQLException

getLogWriter

public PrintWriter getLogWriter()

Specified by:

getLogWriter in interface CommonDataSource

setLogWriter

public void setLogWriter(PrintWriter out)

Specified by:

setLogWriter in interface CommonDataSource

getLoginTimeout

public int getLoginTimeout()

Specified by:

getLoginTimeout in interface CommonDataSource

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

Specified by:

setLoginTimeout in interface CommonDataSource

Throws:

SQLException

getParentLogger

public Logger getParentLogger()

Specified by:

getParentLogger in interface CommonDataSource

isWrapperFor

public boolean isWrapperFor(Class<?> iface)

Specified by:

isWrapperFor in interface Wrapper

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

getAccessKeyId

public String getAccessKeyId()

Getter for the AWS access key ID.

Returns:

the AWS access key ID.

setAccessKeyId

public void setAccessKeyId(String accessKeyId)

Setter for the AWS access key ID.

Parameters:

accessKeyId - The AWS access key ID.

getSecretAccessKey

public String getSecretAccessKey()

Getter for the AWS secret access key.

Returns:

the AWS secret access key.

setSecretAccessKey

public void setSecretAccessKey(String secretAccessKey)

Setter for the AWS secret access key.

Parameters:

secretAccessKey - The AWS secret access key.

getSessionToken

public String getSessionToken()

Getter for the temporary AWS session token.

Returns:

the temporary session token required to access a database with multi-factor authentication (MFA) enabled.

setSessionToken

public void setSessionToken(String sessionToken)

Setter for the AWS session token.

Parameters:

sessionToken - The temporary session token required to access a database with multi-factor authentication (MFA) enabled.

getRegion

public String getRegion()

Getter for the database's region.

Returns:

the database's region.

setRegion

public void setRegion(String region)

Setter for the AWS database region.

Parameters:

region - The database's region.

getEndpoint

public String getEndpoint()

Getter for the Timestream service endpoint.

Returns:

the service endpoint.

setEndpoint

public void setEndpoint(String endpoint)

Setter for the Timestream service endpoint.

Parameters:

endpoint - The service endpoint.

isEnableMetaDataPreparedStatement

public boolean isEnableMetaDataPreparedStatement()

Getter for the enableMetaDataPreparedStatement.

Returns:

enableMetaDataPreparedStatement.

setEnableMetaDataPreparedStatement

public void setEnableMetaDataPreparedStatement(boolean enableMetaDataPreparedStatement)

Setter for tracking if the driver can return metadata for PreparedStatements.

Parameters:

enableMetaDataPreparedStatement - A flag that record enableMetaDataPreparedStatement.

getCredentialsProviderClass

public String getCredentialsProviderClass()

Gets credentials provider class.

Returns:

the credentials provider class

setCredentialsProviderClass

public void setCredentialsProviderClass(String credentialsProviderClass)

Sets credentials provider class. The class has to be one of `PropertiesFileCredentialsProvider` or `InstanceProfileCredentialsProvider` to use for authentication.

Parameters:

credentialsProviderClass - the credentials provider class

getCredentialsFilePath

public String getCredentialsFilePath()

Gets the path to a properties file containing AWS security credentials `accessKey` and `secretKey`.

Returns:

the credentials file path

setCredentialsFilePath

public void setCredentialsFilePath(String credentialsFilePath)

Sets the path to a properties file containing AWS security credentials `accessKey` and `secretKey`. This is only required if `AwsCredentialsProviderClass` is specified as `PropertiesFileCredentialsProvider`.

Parameters:

credentialsFilePath - the credentials file path

getIdpName

public String getIdpName()

Gets the Identity Provider (IdP) name to use for SAML-based authentication. One of `Okta` or `AzureAD`.

Returns:

the Identity Provider (IdP) name to use for SAML-based authentication. One of `Okta` or `AzureAD`.

setIdpName

public void setIdpName(String idpName)

Sets the Identity Provider (IdP) name to use for SAML-based authentication. One of `Okta` or `AzureAD`.

Parameters:

idpName - the Identity Provider (IdP) name to use for SAML-based authentication. One of `Okta` or `AzureAD`.

getIdpHost

public String getIdpHost()

Gets the hostname of the specified IdP.

Returns:

the IdP hostname.

setIdpHost

public void setIdpHost(String idpHost)

Sets the hostname of the specified IdP.

Parameters:

idpHost - the IdP hostname.

getIdpUserName

public String getIdpUserName()

Gets the user name for the specified IdP account.

Returns:

the user name for the specified IdP account.

setIdpUserName

public void setIdpUserName(String idpUserName)

Sets the user name for the specified IdP account.

Parameters:

idpUserName - he user name for the specified IdP account.

getIdpPassword

public String getIdpPassword()

Gets the password for the specified IdP account.

Returns:

the password for the specified IdP account.

setIdpPassword

public void setIdpPassword(String idpPassword)

Sets the password for the specified IdP account.

Parameters:

idpPassword - the password for the specified IdP account.

getOktaAppId

public String getOktaAppId()

Gets the unique Okta-provided ID associated with the Timestream application.

Returns:

the unique Okta-provided ID associated with the Timestream application.

setOktaAppId

public void setOktaAppId(String oktaAppId)

Sets the unique Okta-provided ID associated with the Timestream application.

Parameters:

oktaAppId - the unique Okta-provided ID associated with the Timestream application.

getAwsRoleArn

public String getAwsRoleArn()

Gets the Amazon Resource Name (ARN) of the role that the caller is assuming.

Returns:

the the Amazon Resource Name (ARN) of the role that the caller is assuming.

setAwsRoleArn

public void setAwsRoleArn(String awsRoleArn)

Sets the Amazon Resource Name (ARN) of the role that the caller is assuming.

Parameters:

awsRoleArn - the Amazon Resource Name (ARN) of the role that the caller is assuming.

getIdpArn

public String getIdpArn()

Gets the Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Returns:

the Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

setIdpArn

public void setIdpArn(String idpArn)

Sets the Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Parameters:

idpArn - the Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

getAadAppId

public String getAadAppId()

Gets the unique id of the registered application on Azure AD.

Returns:

the unique id of the registered application on Azure AD.

setAadAppId

public void setAadAppId(String aadAppId)

Sets the unique id of the registered application on Azure AD.

Parameters:

aadAppId - the unique id of the registered application on Azure AD.

getAadClientSecret

public String getAadClientSecret()

Gets the client secret associated with the registered application on Azure AD used to authorize fetching tokens.

Returns:

the client secret associated with the registered application on Azure AD used to authorize fetching tokens.

setAadClientSecret

public void setAadClientSecret(String aadClientSecret)

Sets the client secret associated with the registered application on Azure AD used to authorize fetching tokens.

Parameters:

aadClientSecret - the client secret associated with the registered application on Azure AD used to authorize fetching tokens.

getAadTenantId

public String getAadTenantId()

Gets Azure Active Directory tenant ID.

Returns:

the Azure Active Directory tenant ID.

setAadTenantId

public void setAadTenantId(String aadTenantId)

Sets Azure Active Directory tenant ID.

Parameters:

aadTenantId - the Azure Active Directory tenant ID.

getRequestTimeout

public int getRequestTimeout()

Gets the time in milliseconds the client will wait for a query request before timing out.

Returns:

the request timeout value in milliseconds.

setRequestTimeout

public void setRequestTimeout(int requestTimeout)

Sets the time in milliseconds the client will wait for a query request before timing out. A non-positive value disables this feature.

Parameters:

requestTimeout - the request timeout value in milliseconds.

See Also:

ClientConfiguration.setRequestTimeout(int)

getSocketTimeout

public int getSocketTimeout()

Gets the time in milliseconds the client will wait for data to be transferred over an open connection before timing out.

Returns:

the socket timeout value in milliseconds.

See Also:

ClientConfiguration.getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(int socketTimeout)
                      throws SQLException

Sets the time in milliseconds the client will wait for data to be transferred over an open connection before timing out.

Parameters:

socketTimeout - The socket timeout value in milliseconds.

Throws:

SQLException - if the timeout value is negative.

See Also:

ClientConfiguration.setSocketTimeout(int)

getMaxConnections

public int getMaxConnections()

Gets the maximum number of allowed concurrently opened HTTP connections to the Timestream service.

Returns:

the maximum number of allowed opened HTTP connections.

See Also:

ClientConfiguration.getMaxConnections()

setMaxConnections

public void setMaxConnections(int maxConnections)
                       throws SQLException

Sets the maximum number of allowed concurrently opened HTTP connections to the Timestream service.

Parameters:

maxConnections - The maximum number of allowed opened HTTP connections.

Throws:

SQLException - if the value is negative.

See Also:

ClientConfiguration.setMaxConnections(int)

getMaxRetryCount

public int getMaxRetryCount()

Gets the maximum number of retry attempts for retryable errors with 5XX error codes in the client.

Returns:

the maximum number of retry attempts for retryable errors; -1 if value has not been set.

See Also:

ClientConfiguration.getMaxErrorRetry()

setMaxRetryCount

public void setMaxRetryCount(int maxRetryCountClient)
                      throws SQLException

Sets the maximum retry attempts for retryable errors on the client.

Parameters:

maxRetryCountClient - The maximum number of retry attempts for retryable errors.

Throws:

SQLException - if the value is negative.

See Also:

ClientConfiguration.setMaxErrorRetry(int)

connectionClosed

public void connectionClosed(ConnectionEvent event)

Specified by:

connectionClosed in interface ConnectionEventListener

connectionErrorOccurred

public void connectionErrorOccurred(ConnectionEvent event)

Specified by:

connectionErrorOccurred in interface ConnectionEventListener

createTimestreamConnection

protected TimestreamConnection createTimestreamConnection(Properties info)
                                                   throws SQLException

Creates a TimestreamConnection object.

Parameters:

info - Properties instance containing credential information.

Returns:

TimestreamConnection instance.

Throws:

SQLException - if connection cannot getClientInfo from the connection.