com.databricks.sdk.core.oauth

Class SessionCredentialsTokenSource

java.lang.Object

com.databricks.sdk.core.oauth.SessionCredentialsTokenSource

All Implemented Interfaces:

TokenSource

@InternalApi
public class SessionCredentialsTokenSource
extends Object
implements TokenSource

TokenSource that handles OAuth token refresh for SessionCredentials.

Implements the refresh_token OAuth grant type with optional token caching.

Constructor Summary

Constructors

Constructor and Description
SessionCredentialsTokenSource(Token token, HttpClient hc, String tokenUrl, String clientId, String clientSecret, Optional<String> redirectUrl, Optional<TokenCache> tokenCache) Constructs a new SessionCredentialsTokenSource.

Method Summary

Modifier and Type	Method and Description
Token	getToken() Refreshes the OAuth token using the refresh_token grant type.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionCredentialsTokenSource

public SessionCredentialsTokenSource(Token token,
                                     HttpClient hc,
                                     String tokenUrl,
                                     String clientId,
                                     String clientSecret,
                                     Optional<String> redirectUrl,
                                     Optional<TokenCache> tokenCache)

Constructs a new SessionCredentialsTokenSource.

Parameters:

token - The initial token to use

hc - The HTTP client for making token refresh requests

tokenUrl - The OAuth token endpoint URL

clientId - The OAuth client ID

clientSecret - The OAuth client secret

redirectUrl - The OAuth redirect URL (optional)

tokenCache - The token cache for persisting refreshed tokens (optional)

Method Detail

getToken

public Token getToken()

Refreshes the OAuth token using the refresh_token grant type.

This method attempts to refresh the current token using the refresh token. If successful, the new token is automatically saved to the token cache if one is configured. For Microsoft OAuth endpoints, it includes the Origin header.

Specified by:

getToken in interface TokenSource

Returns:

A new Token with updated access and refresh tokens.

Throws:

DatabricksException - if the token is not set, refresh token is missing, or the refresh request fails.