Package com.firebolt.jdbc.connection

Class FireboltConnectionServiceSecret

java.lang.Object

com.firebolt.jdbc.JdbcBase

com.firebolt.jdbc.connection.FireboltConnection

com.firebolt.jdbc.connection.FireboltConnectionServiceSecret

All Implemented Interfaces:

CacheListener, GenericWrapper, AutoCloseable, Connection, Wrapper, EventListener

Direct Known Subclasses:

LocalhostFireboltConnection

public class FireboltConnectionServiceSecret
extends FireboltConnection

Field Summary

Fields inherited from class com.firebolt.jdbc.connection.FireboltConnection

httpConnectionUrl, loginProperties, parserVersion, sessionProperties

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type	Method	Description
protected void	authenticate()
protected FireboltAuthenticationClient	createFireboltAuthenticationClient(okhttp3.OkHttpClient httpClient)
protected FireboltProperties	extractFireboltProperties(String jdbcUri, Properties connectionProperties)
FireboltBackendType	getBackendType()	Returns the backend type that the connection is established to
protected CacheKey	getCacheKey()
Optional<String>	getConnectionUserAgentHeader()	A connection should implement this method if it needs to set additional details on the user agent header for the calls sent to Firebolt backend
int	getInfraVersion()	Returns the version of the firebolt backend the connection is established to
protected boolean	isConnectionCachingEnabled()	If the connection information can be cached for subsequent reuse, then the specific connection should provide implementation
protected void	prepareCacheIfNeeded()	If there is no entry in the cache with this key, add one if caching is enabled
protected void	validateConnectionParameters()	Perform syntactic validation for the mandatory connection params which are: - clientId - clientSecret - account Also make sure the access token is not passed in

Methods inherited from class com.firebolt.jdbc.connection.FireboltConnection

abort, addProperty, addProperty, addProperty, addProperty, cancelAsyncQuery, cleanup, close, commit, connect, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAccessToken, getAccessToken, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getConnectionTimeout, getEndpoint, getEngine, getHoldability, getHttpClient, getMetaData, getNetworkTimeout, getProtocolVersion, getSchema, getSessionProperties, getTransactionIsolation, getTypeMap, isAsyncQueryRunning, isAsyncQuerySuccessful, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareInternalRequestValidationConnection, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, register, releaseSavepoint, removeClosedStatement, removeExpiredTokens, reset, retrieveMetaData, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setEndpoint, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap

Methods inherited from class com.firebolt.jdbc.JdbcBase

addWarning, clearWarnings, getWarnings

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Connection

beginRequest, clearWarnings, endRequest, getWarnings, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Methods inherited from interface com.firebolt.jdbc.GenericWrapper

isWrapperFor, unwrap

Method Details

authenticate

protected void authenticate()
                     throws SQLException

Specified by:

authenticate in class FireboltConnection

Throws:

SQLException

prepareCacheIfNeeded

protected void prepareCacheIfNeeded()

If there is no entry in the cache with this key, add one if caching is enabled

validateConnectionParameters

protected void validateConnectionParameters()
                                     throws FireboltException

Perform syntactic validation for the mandatory connection params which are: - clientId - clientSecret - account Also make sure the access token is not passed in

Specified by:

validateConnectionParameters in class FireboltConnection

Throws:

FireboltException

isConnectionCachingEnabled

protected boolean isConnectionCachingEnabled()

Description copied from class: FireboltConnection

If the connection information can be cached for subsequent reuse, then the specific connection should provide implementation

Specified by:

isConnectionCachingEnabled in class FireboltConnection

Returns:

- true if the connection supports caching. False otherwise

getConnectionUserAgentHeader

public Optional<String> getConnectionUserAgentHeader()

Description copied from class: FireboltConnection

A connection should implement this method if it needs to set additional details on the user agent header for the calls sent to Firebolt backend

Specified by:

getConnectionUserAgentHeader in class FireboltConnection

Returns:

getBackendType

public FireboltBackendType getBackendType()

Description copied from class: FireboltConnection

Returns the backend type that the connection is established to

Specified by:

getBackendType in class FireboltConnection

Returns:

getCacheKey

protected CacheKey getCacheKey()

extractFireboltProperties

protected FireboltProperties extractFireboltProperties(String jdbcUri,
 Properties connectionProperties)

Overrides:

extractFireboltProperties in class FireboltConnection

createFireboltAuthenticationClient

protected FireboltAuthenticationClient createFireboltAuthenticationClient(okhttp3.OkHttpClient httpClient)

Specified by:

createFireboltAuthenticationClient in class FireboltConnection

getInfraVersion

public int getInfraVersion()

Description copied from class: FireboltConnection

Returns the version of the firebolt backend the connection is established to

Specified by:

getInfraVersion in class FireboltConnection