Package com.databricks.jdbc.api
Interface IDatabricksConnectionContext
-
- All Known Implementing Classes:
DatabricksConnectionContext
public interface IDatabricksConnectionContext
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIDatabricksConnectionContext.AuthFlowstatic classIDatabricksConnectionContext.AuthMechstatic classIDatabricksConnectionContext.Cloud
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanacceptUndeterminedCertificateRevocation()booleancheckCertificateRevocation()booleanenableTelemetry()intgetAsyncExecPollInterval()StringgetAuthEndpoint()Returns the OAuth2 authorization endpoint URL for the authorization code flow.IDatabricksConnectionContext.AuthFlowgetAuthFlow()IDatabricksConnectionContext.AuthMechgetAuthMech()StringgetAuthScope()Returns the OAuth2 authentication scope used in the request.StringgetCatalog()StringgetClientId()StringgetClientSecret()DatabricksClientTypegetClientType()StringgetClientUserAgent()com.databricks.sdk.core.ProxyConfig.ProxyAuthTypegetCloudFetchProxyAuthType()StringgetCloudFetchProxyHost()StringgetCloudFetchProxyPassword()intgetCloudFetchProxyPort()StringgetCloudFetchProxyUser()intgetCloudFetchThreadPoolSize()Returns the number of threads to be used for fetching data from cloud storageCompressionTypegetCompressionType()IDatabricksComputeResourcegetComputeResource()Returns warehouse-Id as parsed from JDBC connection UrlStringgetConnectionURL()BooleangetDirectResultMode()StringgetEndpointURL()StringgetHostForOAuth()StringgetHostUrl()Returns host-Url for Databricks server as parsed from JDBC connection in formathttps://server:portStringgetHttpPath()intgetIdleHttpConnectionExpiry()StringgetJWTAlgorithm()Returns the algorithm used for signing the JWT (e.g., RS256, ES256).StringgetJWTKeyFile()Returns the file path to the JWT private key used for signing the JWT.StringgetJWTPassphrase()Returns the passphrase to decrypt the private key if the key is encrypted.StringgetKID()Returns the Key ID (KID) used in the JWT header, identifying the key.intgetLogFileCount()intgetLogFileSize()LogLevelgetLogLevel()StringgetLogPathString()StringgetNonProxyHosts()Returns the non-proxy hosts that should be excluded from proxying.StringgetOAuthDiscoveryURL()Returns the discovery URL used to obtain the OAuth2 token and authorization endpoints.StringgetOAuthRefreshToken()Returns the OAuth2 refresh token used to obtain a new access token when the current one expires.List<String>getOAuthScopesForU2M()StringgetPassThroughAccessToken()Returns the pass through access tokencom.databricks.sdk.core.ProxyConfig.ProxyAuthTypegetProxyAuthType()StringgetProxyHost()StringgetProxyPassword()intgetProxyPort()StringgetProxyUser()intgetRateLimitRetryTimeout()StringgetSchema()Map<String,String>getSessionConfigs()StringgetSSLTrustStore()Returns the SSL trust store file path used for SSL connections.StringgetSSLTrustStorePassword()Returns the SSL trust store password of the trust store file.StringgetSSLTrustStoreProvider()Returns the SSL trust store provider of the trust store file.StringgetSSLTrustStoreType()Returns the SSL trust store type of the trust store file.intgetTemporarilyUnavailableRetryTimeout()StringgetToken()Returns the auth token (personal access token)StringgetTokenEndpoint()Returns the OAuth2 token endpoint URL for retrieving tokens.BooleangetUseCloudFetchProxy()BooleangetUseEmptyMetadata()BooleangetUseProxy()BooleangetUseSystemProxy()booleanisAllPurposeCluster()booleanisFakeServiceTest()booleanisOAuthDiscoveryModeEnabled()Returns whether OAuth2 discovery mode is enabled, which fetches endpoints dynamically.BooleanshouldEnableArrow()BooleanshouldRetryRateLimitError()BooleanshouldRetryTemporarilyUnavailableError()booleansupportManyParameters()booleanuseJWTAssertion()Returns whether JWT assertion should be used for OAuth2 authentication.
-
-
-
Method Detail
-
getHostUrl
String getHostUrl() throws DatabricksParsingException
Returns host-Url for Databricks server as parsed from JDBC connection in formathttps://server:port- Returns:
- Databricks host-Url
- Throws:
DatabricksParsingException
-
getComputeResource
IDatabricksComputeResource getComputeResource()
Returns warehouse-Id as parsed from JDBC connection Url- Returns:
- warehouse-Id
-
getToken
String getToken()
Returns the auth token (personal access token)- Returns:
- auth token
-
getPassThroughAccessToken
String getPassThroughAccessToken()
Returns the pass through access token- Returns:
- access token
-
getHostForOAuth
String getHostForOAuth()
-
getClientId
String getClientId() throws DatabricksParsingException
- Throws:
DatabricksParsingException
-
getClientSecret
String getClientSecret()
-
getOAuthScopesForU2M
List<String> getOAuthScopesForU2M() throws DatabricksParsingException
- Throws:
DatabricksParsingException
-
getAuthMech
IDatabricksConnectionContext.AuthMech getAuthMech()
-
getAuthFlow
IDatabricksConnectionContext.AuthFlow getAuthFlow()
-
getLogLevel
LogLevel getLogLevel()
-
getLogPathString
String getLogPathString()
-
getLogFileSize
int getLogFileSize()
-
getLogFileCount
int getLogFileCount()
-
getClientUserAgent
String getClientUserAgent()
-
getCompressionType
CompressionType getCompressionType()
-
getCatalog
String getCatalog()
-
getSchema
String getSchema()
-
isAllPurposeCluster
boolean isAllPurposeCluster()
-
getHttpPath
String getHttpPath()
-
getProxyHost
String getProxyHost()
-
getProxyPort
int getProxyPort()
-
getProxyUser
String getProxyUser()
-
getProxyPassword
String getProxyPassword()
-
getUseProxy
Boolean getUseProxy()
-
getProxyAuthType
com.databricks.sdk.core.ProxyConfig.ProxyAuthType getProxyAuthType()
-
getUseSystemProxy
Boolean getUseSystemProxy()
-
getUseCloudFetchProxy
Boolean getUseCloudFetchProxy()
-
getCloudFetchProxyHost
String getCloudFetchProxyHost()
-
getCloudFetchProxyPort
int getCloudFetchProxyPort()
-
getCloudFetchProxyUser
String getCloudFetchProxyUser()
-
getCloudFetchProxyPassword
String getCloudFetchProxyPassword()
-
getCloudFetchProxyAuthType
com.databricks.sdk.core.ProxyConfig.ProxyAuthType getCloudFetchProxyAuthType()
-
getEndpointURL
String getEndpointURL() throws DatabricksParsingException
- Throws:
DatabricksParsingException
-
getAsyncExecPollInterval
int getAsyncExecPollInterval()
-
shouldEnableArrow
Boolean shouldEnableArrow()
-
getClientType
DatabricksClientType getClientType()
-
getUseEmptyMetadata
Boolean getUseEmptyMetadata()
-
getCloudFetchThreadPoolSize
int getCloudFetchThreadPoolSize()
Returns the number of threads to be used for fetching data from cloud storage
-
getDirectResultMode
Boolean getDirectResultMode()
-
shouldRetryTemporarilyUnavailableError
Boolean shouldRetryTemporarilyUnavailableError()
-
shouldRetryRateLimitError
Boolean shouldRetryRateLimitError()
-
getTemporarilyUnavailableRetryTimeout
int getTemporarilyUnavailableRetryTimeout()
-
getRateLimitRetryTimeout
int getRateLimitRetryTimeout()
-
getIdleHttpConnectionExpiry
int getIdleHttpConnectionExpiry()
-
supportManyParameters
boolean supportManyParameters()
-
isFakeServiceTest
boolean isFakeServiceTest()
-
enableTelemetry
boolean enableTelemetry()
-
getConnectionURL
String getConnectionURL()
-
checkCertificateRevocation
boolean checkCertificateRevocation()
-
acceptUndeterminedCertificateRevocation
boolean acceptUndeterminedCertificateRevocation()
-
getJWTKeyFile
String getJWTKeyFile()
Returns the file path to the JWT private key used for signing the JWT.
-
getKID
String getKID()
Returns the Key ID (KID) used in the JWT header, identifying the key.
-
getJWTPassphrase
String getJWTPassphrase()
Returns the passphrase to decrypt the private key if the key is encrypted.
-
getJWTAlgorithm
String getJWTAlgorithm()
Returns the algorithm used for signing the JWT (e.g., RS256, ES256).
-
useJWTAssertion
boolean useJWTAssertion()
Returns whether JWT assertion should be used for OAuth2 authentication.
-
getTokenEndpoint
String getTokenEndpoint()
Returns the OAuth2 token endpoint URL for retrieving tokens.
-
getAuthEndpoint
String getAuthEndpoint()
Returns the OAuth2 authorization endpoint URL for the authorization code flow.
-
isOAuthDiscoveryModeEnabled
boolean isOAuthDiscoveryModeEnabled()
Returns whether OAuth2 discovery mode is enabled, which fetches endpoints dynamically.
-
getOAuthDiscoveryURL
String getOAuthDiscoveryURL()
Returns the discovery URL used to obtain the OAuth2 token and authorization endpoints.
-
getAuthScope
String getAuthScope()
Returns the OAuth2 authentication scope used in the request.
-
getOAuthRefreshToken
String getOAuthRefreshToken()
Returns the OAuth2 refresh token used to obtain a new access token when the current one expires.
-
getNonProxyHosts
String getNonProxyHosts()
Returns the non-proxy hosts that should be excluded from proxying.
-
getSSLTrustStore
String getSSLTrustStore()
Returns the SSL trust store file path used for SSL connections.
-
getSSLTrustStoreProvider
String getSSLTrustStoreProvider()
Returns the SSL trust store provider of the trust store file.
-
getSSLTrustStorePassword
String getSSLTrustStorePassword()
Returns the SSL trust store password of the trust store file.
-
getSSLTrustStoreType
String getSSLTrustStoreType()
Returns the SSL trust store type of the trust store file.
-
-