com.databricks.sdk.core.oauth

Class EndpointTokenSource

java.lang.Object

com.databricks.sdk.core.oauth.RefreshableTokenSource

com.databricks.sdk.core.oauth.EndpointTokenSource

All Implemented Interfaces:

TokenSource

public class EndpointTokenSource
extends RefreshableTokenSource

Represents a token source that exchanges a control plane token for an endpoint-specific dataplane token. It utilizes an underlying TokenSource to obtain the initial control plane token.

Field Summary

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

token

Constructor Summary

Constructors

Constructor and Description
EndpointTokenSource(TokenSource cpTokenSource, String authDetails, HttpClient httpClient, String host) Constructs a new EndpointTokenSource.

Method Summary

Modifier and Type	Method and Description
protected Token	refresh() Fetches an endpoint-specific dataplane token by exchanging a control plane token.

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

getToken, retrieveToken

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointTokenSource

public EndpointTokenSource(TokenSource cpTokenSource,
                           String authDetails,
                           HttpClient httpClient,
                           String host)

Constructs a new EndpointTokenSource.

Parameters:

cpTokenSource - The TokenSource used to obtain the control plane token.

authDetails - The authorization details required for the token exchange.

httpClient - The HttpClient used to make the token exchange request.

host - The host for the token exchange request.

Throws:

IllegalArgumentException - if authDetails is empty or host is empty.

NullPointerException - if any of the parameters are null.

Method Detail

refresh

protected Token refresh()

Fetches an endpoint-specific dataplane token by exchanging a control plane token.

This method first obtains a control plane token from the configured cpTokenSource. It then uses this token as an assertion along with the provided authDetails to request a new, more scoped dataplane token from the Databricks OAuth token endpoint ().

Specified by:

refresh in class RefreshableTokenSource

Returns:

A new Token containing the exchanged dataplane access token, its type, any accompanying refresh token, and its expiry time.

Throws:

DatabricksException - if the token exchange with the OAuth endpoint fails.

IllegalArgumentException - if the token endpoint url is empty.

NullPointerException - if any of the parameters are null.