Package com.databricks.jdbc.dbclient.impl.common

Class ClientConfigurator

java.lang.Object

com.databricks.jdbc.dbclient.impl.common.ClientConfigurator

public class ClientConfigurator
extends Object

This class is responsible for configuring the Databricks config based on the connection context. The databricks config is then used to create the SDK or Thrift client.

Constructor Summary

Constructors

Constructor	Description
ClientConfigurator(IDatabricksConnectionContext connectionContext)

Method Summary

Modifier and Type	Method	Description
static CertPathTrustManagerParameters	buildTrustManagerParameters(Set<TrustAnchor> trustAnchors, boolean checkCertificateRevocation, boolean acceptUndeterminedCertificateRevocation)
static String	convertNonProxyHostConfigToBeSystemPropertyCompliant(String nonProxyHosts)	Currently, the ODBC driver takes in nonProxyHosts as a comma separated list of suffix of non-proxy hosts i.e.
static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>	getConnectionSocketFactoryRegistry(IDatabricksConnectionContext connectionContext)	This function returns the registry of connection socket factories based on the truststore and properties set in the connection context.
com.databricks.sdk.core.DatabricksConfig	getDatabricksConfig()
static Set<TrustAnchor>	getTrustAnchorsFromTrustStore(KeyStore trustStore)
com.databricks.sdk.WorkspaceClient	getWorkspaceClient()
static KeyStore	loadTruststoreOrNull(IDatabricksConnectionContext connectionContext)
void	resetAccessTokenInConfig(String newAccessToken)
void	setupAccessTokenConfig()	Setup the PAT authentication settings in the databricks config.
void	setupAuthConfig()	Setup the workspace authentication settings in the databricks config.
void	setupM2MConfig()	Setup the OAuth M2M authentication settings in the databricks config.
void	setupOAuthAccessTokenConfig()
void	setupOAuthConfig()	Setup the OAuth authentication settings in the databricks config.
void	setupProxyConfig(com.databricks.sdk.core.commons.CommonsHttpClient.Builder httpClientBuilder)	Setup proxy settings in the databricks config.
void	setupU2MConfig()	Setup the OAuth U2M authentication settings in the databricks config.
void	setupU2MRefreshConfig()	Setup the OAuth U2M refresh token authentication settings in the databricks config.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConfigurator

public ClientConfigurator(IDatabricksConnectionContext connectionContext)

Method Detail

getConnectionSocketFactoryRegistry

public static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> getConnectionSocketFactoryRegistry(IDatabricksConnectionContext connectionContext)

This function returns the registry of connection socket factories based on the truststore and properties set in the connection context.

Parameters:

connectionContext - The connection context to use to get the truststore, certificate revocation settings.

Returns:

The registry of connection socket factories.

loadTruststoreOrNull

public static KeyStore loadTruststoreOrNull(IDatabricksConnectionContext connectionContext)

Parameters:

connectionContext - The connection context to use to get the truststore.

Returns:

The truststore loaded from the connection context or null if the truststore is not set.

buildTrustManagerParameters

public static CertPathTrustManagerParameters buildTrustManagerParameters(Set<TrustAnchor> trustAnchors,
                                                                         boolean checkCertificateRevocation,
                                                                         boolean acceptUndeterminedCertificateRevocation)

Parameters:

trustAnchors - The trust anchors to use in the trust manager.

checkCertificateRevocation - Whether to check certificate revocation.

acceptUndeterminedCertificateRevocation - Whether to accept undetermined certificate

Returns:

The trust manager parameters based on the input parameters.

getTrustAnchorsFromTrustStore

public static Set<TrustAnchor> getTrustAnchorsFromTrustStore(KeyStore trustStore)

Parameters:

trustStore - The trust store from which to get the trust anchors.

Returns:

The set of trust anchors from the trust store.

setupProxyConfig

public void setupProxyConfig(com.databricks.sdk.core.commons.CommonsHttpClient.Builder httpClientBuilder)

Setup proxy settings in the databricks config.

getWorkspaceClient

public com.databricks.sdk.WorkspaceClient getWorkspaceClient()

setupAuthConfig

public void setupAuthConfig()

Setup the workspace authentication settings in the databricks config.

setupOAuthConfig

public void setupOAuthConfig()
                      throws DatabricksParsingException

Setup the OAuth authentication settings in the databricks config.

Throws:

DatabricksParsingException

setupU2MConfig

public void setupU2MConfig()
                    throws DatabricksParsingException

Setup the OAuth U2M authentication settings in the databricks config.

Throws:

DatabricksParsingException

setupAccessTokenConfig

public void setupAccessTokenConfig()
                            throws DatabricksParsingException

Setup the PAT authentication settings in the databricks config.

Throws:

DatabricksParsingException

setupOAuthAccessTokenConfig

public void setupOAuthAccessTokenConfig()
                                 throws DatabricksParsingException

Throws:

DatabricksParsingException

resetAccessTokenInConfig

public void resetAccessTokenInConfig(String newAccessToken)

setupU2MRefreshConfig

public void setupU2MRefreshConfig()
                           throws DatabricksParsingException

Setup the OAuth U2M refresh token authentication settings in the databricks config.

Throws:

DatabricksParsingException

setupM2MConfig

public void setupM2MConfig()
                    throws DatabricksParsingException

Setup the OAuth M2M authentication settings in the databricks config.

Throws:

DatabricksParsingException

convertNonProxyHostConfigToBeSystemPropertyCompliant

public static String convertNonProxyHostConfigToBeSystemPropertyCompliant(String nonProxyHosts)

Currently, the ODBC driver takes in nonProxyHosts as a comma separated list of suffix of non-proxy hosts i.e. suffix1|suffix2|suffix3. Whereas, the SDK takes in nonProxyHosts as a list of patterns separated by '|'. This pattern conforms to the system property format in the Java Proxy Guide.

Parameters:

nonProxyHosts - Comma separated list of suffix of non-proxy hosts

Returns:

nonProxyHosts in system property compliant format from Java Proxy Guide

getDatabricksConfig

public com.databricks.sdk.core.DatabricksConfig getDatabricksConfig()