com.databricks.sdk.core.oauth

Class SessionCredentials

java.lang.Object

com.databricks.sdk.core.oauth.RefreshableTokenSource

com.databricks.sdk.core.oauth.SessionCredentials

All Implemented Interfaces:

CredentialsProvider, TokenSource, Serializable

public class SessionCredentials
extends RefreshableTokenSource
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

Nested Class Summary

Nested classes/interfaces inherited from class com.databricks.sdk.core.oauth.RefreshableTokenSource

RefreshableTokenSource.TokenState

Field Summary

Fields inherited from class com.databricks.sdk.core.oauth.RefreshableTokenSource

token

Method Summary

Modifier and Type	Method and Description
String	authType()
OAuthHeaderFactory	configure(DatabricksConfig config)
protected Token	refresh() Refresh the OAuth token.

Methods inherited from class com.databricks.sdk.core.oauth.RefreshableTokenSource

getToken, getTokenAsync, getTokenBlocking, getTokenState, retrieveToken, withAsyncRefresh, withClockSupplier, withExpiryBuffer

Methods inherited from class java.lang.Object

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

Method Detail

authType

public String authType()

Specified by:

authType in interface CredentialsProvider

configure

public OAuthHeaderFactory configure(DatabricksConfig config)

Specified by:

configure in interface CredentialsProvider

refresh

protected Token refresh()

Description copied from class: RefreshableTokenSource

Refresh the OAuth token. Subclasses must implement this to define how the token is refreshed.

This method may throw an exception if the token cannot be refreshed. The specific exception type depends on the implementation.

Specified by:

refresh in class RefreshableTokenSource

Returns:

The newly refreshed Token.