com.databricks.sdk.core

Class NotebookNativeCredentialsProvider

java.lang.Object

com.databricks.sdk.core.NotebookNativeCredentialsProvider

All Implemented Interfaces:

CredentialsProvider

@InternalApi
public class NotebookNativeCredentialsProvider
extends Object
implements CredentialsProvider

A CredentialsProvider that uses the API token from the command context to authenticate.

The token and hostname are read from the command context, which can be retrieved through the dbutils API. As the Java SDK does not depend on DBUtils directly, reflection is used to retrieve the token. This token should be available wherever the DBUtils API is accessible (i.e. in the Spark driver).

Constructor Summary

Constructors

Constructor and Description
NotebookNativeCredentialsProvider()

Method Summary

Modifier and Type	Method and Description
String	authType() Returns the authentication type identifier for this credentials provider.
HeaderFactory	configure(DatabricksConfig config) Creates and returns a new HeaderFactory to authenticate requests to the Databricks API.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotebookNativeCredentialsProvider

public NotebookNativeCredentialsProvider()

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 HeaderFactory 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