com.databricks.sdk.core.oauth

Class TokenSourceCredentialsProvider

java.lang.Object

com.databricks.sdk.core.oauth.TokenSourceCredentialsProvider

All Implemented Interfaces:

CredentialsProvider

public class TokenSourceCredentialsProvider
extends Object
implements CredentialsProvider

A credentials provider that uses a TokenSource to obtain and manage authentication tokens. This class serves as a base implementation for token-based authentication, handling the conversion of tokens into HTTP authorization headers.

The provider validates token availability during configuration and creates. appropriate authorization headers for API requests.

Constructor Summary

Constructors

Constructor and Description
TokenSourceCredentialsProvider(TokenSource tokenSource, String authType) Creates a new TokenSourceCredentialsProvider with the specified token source and auth type.

Method Summary

Modifier and Type	Method and Description
String	authType() Returns the authentication type identifier for this credentials provider.
OAuthHeaderFactory	configure(DatabricksConfig config) Configures the credentials provider and creates a HeaderFactory for generating authentication headers.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenSourceCredentialsProvider

public TokenSourceCredentialsProvider(TokenSource tokenSource,
                                      String authType)

Creates a new TokenSourceCredentialsProvider with the specified token source and auth type.

Parameters:

tokenSource - The token source responsible for token acquisition and management.

authType - The authentication type identifier.

Method Detail

configure

public OAuthHeaderFactory configure(DatabricksConfig config)

Configures the credentials provider and creates a HeaderFactory for generating authentication headers. This method validates token availability by attempting to obtain an access token before returning the HeaderFactory.

Specified by:

configure in interface CredentialsProvider

Parameters:

config - The Databricks configuration object.

Returns:

A HeaderFactory that generates "Bearer" token authorization headers, or null if token acquisition fails.

authType

public String authType()

Returns the authentication type identifier for this credentials provider. This is used to identify the authentication method being used.

Specified by:

authType in interface CredentialsProvider

Returns:

The authentication type string