com.databricks.sdk.core.oauth

Class SessionCredentials

java.lang.Object

com.databricks.sdk.core.oauth.SessionCredentials

All Implemented Interfaces:

CredentialsProvider, Serializable

@InternalApi
public class SessionCredentials
extends Object
implements CredentialsProvider, Serializable

An implementation of RefreshableTokenSource implementing the refresh_token OAuth grant type.

SessionCredentials are OAuth credentials with a short-lived access token, used to make requests to an API, and a long-lived refresh token, which can be used to fetch new access tokens. Calling refresh() uses the refresh token to retrieve a new access token to authenticate to APIs.

See Also:

Serialized Form

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.

Methods inherited from class java.lang.Object

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

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