com.databricks.sdk.core.oauth

Class CachedTokenSource

java.lang.Object

com.databricks.sdk.core.oauth.CachedTokenSource

All Implemented Interfaces:

TokenSource

public class CachedTokenSource
extends Object
implements TokenSource

An OAuth TokenSource which can be refreshed.

This class supports both synchronous and asynchronous token refresh. When async is enabled, stale tokens will trigger a background refresh, while expired tokens will block until a new token is fetched.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CachedTokenSource.Builder Builder for creating instances of CachedTokenSource.

Field Summary

Fields

Modifier and Type	Field and Description
protected Token	token

Method Summary

Modifier and Type	Method and Description
Token	getToken() Gets the current token, refreshing if necessary.
protected Token	getTokenAsync() Get the current token, possibly triggering an async refresh if stale.
protected Token	getTokenBlocking() Get the current token, blocking to refresh if expired.
protected com.databricks.sdk.core.oauth.CachedTokenSource.TokenState	getTokenState(Token t) Determine the state of the current token (fresh, stale, or expired).

Methods inherited from class java.lang.Object

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

Field Detail

token

protected volatile Token token

Method Detail

getToken

public Token getToken()

Gets the current token, refreshing if necessary. If async refresh is enabled, may return a stale token while a refresh is in progress.

This method may throw an exception if the token cannot be refreshed, depending on the implementation of #refresh().

Specified by:

getToken in interface TokenSource

Returns:

The current valid token

getTokenState

protected com.databricks.sdk.core.oauth.CachedTokenSource.TokenState getTokenState(Token t)

Determine the state of the current token (fresh, stale, or expired).

Returns:

The token state

getTokenBlocking

protected Token getTokenBlocking()

Get the current token, blocking to refresh if expired.

This method may throw an exception if the token cannot be refreshed, depending on the implementation of #refresh().

Returns:

The current valid token

getTokenAsync

protected Token getTokenAsync()

Get the current token, possibly triggering an async refresh if stale. If the token is expired, blocks to refresh.

This method may throw an exception if the token cannot be refreshed, depending on the implementation of #refresh().

Returns:

The current valid or stale token