com.databricks.sdk.core.oauth

Class ExternalBrowserCredentialsProvider

java.lang.Object

com.databricks.sdk.core.oauth.ExternalBrowserCredentialsProvider

All Implemented Interfaces:

CredentialsProvider

@InternalApi
public class ExternalBrowserCredentialsProvider
extends Object
implements CredentialsProvider

A CredentialsProvider which implements the Authorization Code + PKCE flow by opening a browser for the user to authorize the application. Uses a specified TokenCache or creates a default one if none is provided.

Constructor Summary

Constructors

Constructor and Description
ExternalBrowserCredentialsProvider() Creates a new ExternalBrowserCredentialsProvider with a default TokenCache.
ExternalBrowserCredentialsProvider(TokenCache tokenCache) Creates a new ExternalBrowserCredentialsProvider with the specified TokenCache.

Method Summary

Modifier and Type	Method and Description
String	authType() Returns the authentication type identifier for this credentials provider.
OAuthHeaderFactory	configure(DatabricksConfig config) Creates and returns a new HeaderFactory to authenticate requests to the Databricks API.
protected List<String>	getScopes(DatabricksConfig config, OpenIDConnectEndpoints oidcEndpoints)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalBrowserCredentialsProvider

public ExternalBrowserCredentialsProvider(TokenCache tokenCache)

Creates a new ExternalBrowserCredentialsProvider with the specified TokenCache.

Parameters:

tokenCache - the TokenCache to use for caching tokens

ExternalBrowserCredentialsProvider

public ExternalBrowserCredentialsProvider()

Creates a new ExternalBrowserCredentialsProvider with a default TokenCache. A FileTokenCache will be created when credentials are configured.

Method Detail

authType

public String authType()

Description copied from interface: CredentialsProvider

Returns the authentication type identifier for this credentials provider.

This method is called internally by the SDK and should not be invoked directly by users. It is used for logging and user-agent identification purposes.

Specified by:

authType in interface CredentialsProvider

Returns:

the authentication type as a string

configure

public OAuthHeaderFactory configure(DatabricksConfig config)

Description copied from interface: CredentialsProvider

Creates and returns a new HeaderFactory to authenticate requests to the Databricks API.

Note: A new HeaderFactory instance is returned on each invocation.

This method is called internally by the SDK during client initialization and should not be invoked directly by users. The SDK will call this method to obtain a HeaderFactory that will be used to add authentication headers to each API request.

Specified by:

configure in interface CredentialsProvider

Parameters:

config - the Databricks configuration to use for authentication

Returns:

a new HeaderFactory configured for authenticating API requests

getScopes

protected List<String> getScopes(DatabricksConfig config,
                                 OpenIDConnectEndpoints oidcEndpoints)