com.databricks.sdk.core.oauth

Class CachedTokenSource.Builder

java.lang.Object

com.databricks.sdk.core.oauth.CachedTokenSource.Builder

Enclosing class:

CachedTokenSource

public static class CachedTokenSource.Builder
extends Object

Builder for creating instances of CachedTokenSource.

This builder allows configuration of various aspects of token caching behavior, including asynchronous refresh, timing parameters, and initial token state.

Constructor Summary

Constructors

Constructor and Description
Builder(TokenSource tokenSource) Creates a new builder with the specified token source.

Method Summary

Modifier and Type	Method and Description
CachedTokenSource	build() Builds and returns a new CachedTokenSource instance with the configured parameters.
CachedTokenSource.Builder	setAsyncDisabled(boolean asyncDisabled) Enables or disables asynchronous token refresh.
CachedTokenSource.Builder	setClockSupplier(ClockSupplier clockSupplier) Sets the clock supplier to use for time-based operations.
CachedTokenSource.Builder	setExpiryBuffer(Duration expiryBuffer) Sets the buffer duration before token expiry at which the token is considered expired.
CachedTokenSource.Builder	setStaleDuration(Duration staleDuration) Sets the duration before token expiry at which the token is considered stale.
CachedTokenSource.Builder	setToken(Token token) Sets an initial token to use in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(TokenSource tokenSource)

Creates a new builder with the specified token source.

Parameters:

tokenSource - The underlying token source to use for refreshing tokens.

Throws:

NullPointerException - If the token source is null.

Method Detail

setToken

public CachedTokenSource.Builder setToken(Token token)

Sets an initial token to use in the cache.

If provided, this token will be used immediately without requiring an initial refresh from the underlying token source.

Parameters:

token - The initial token to cache.

Returns:

This builder instance for method chaining.

setAsyncDisabled

public CachedTokenSource.Builder setAsyncDisabled(boolean asyncDisabled)

Enables or disables asynchronous token refresh.

When enabled, stale tokens will trigger a background refresh while continuing to serve the current token. When disabled, all refreshes are performed synchronously and will block the calling thread.

Parameters:

asyncDisabled - True to disable asynchronous refresh, false to enable.

Returns:

This builder instance for method chaining.

setStaleDuration

public CachedTokenSource.Builder setStaleDuration(Duration staleDuration)

Sets the duration before token expiry at which the token is considered stale.

When asynchronous refresh is enabled, tokens that are stale but not yet expired will trigger a background refresh while continuing to serve the current token.

Parameters:

staleDuration - The duration before expiry to consider a token stale. Must be greater than the expiry buffer duration.

Returns:

This builder instance for method chaining.

setExpiryBuffer

public CachedTokenSource.Builder setExpiryBuffer(Duration expiryBuffer)

Sets the buffer duration before token expiry at which the token is considered expired.

Tokens within this buffer of their expiry time will be considered expired and require synchronous refresh.

Parameters:

expiryBuffer - The buffer duration before expiry to consider a token expired. Must be less than the stale duration.

Returns:

This builder instance for method chaining.

setClockSupplier

public CachedTokenSource.Builder setClockSupplier(ClockSupplier clockSupplier)

Sets the clock supplier to use for time-based operations.

This is primarily useful for testing scenarios where you need to control the current time. In production, the default UTC clock supplier should be used.

Parameters:

clockSupplier - The clock supplier to use for determining current time.

Returns:

This builder instance for method chaining.

build

public CachedTokenSource build()

Builds and returns a new CachedTokenSource instance with the configured parameters.

Returns:

A new CachedTokenSource instance.