redis.clients.authentication.entraid

Class AzureTokenAuthConfigBuilder

java.lang.Object

redis.clients.authentication.core.TokenAuthConfig.Builder<AzureTokenAuthConfigBuilder>

redis.clients.authentication.entraid.AzureTokenAuthConfigBuilder

All Implemented Interfaces:

java.lang.AutoCloseable

public class AzureTokenAuthConfigBuilder
extends redis.clients.authentication.core.TokenAuthConfig.Builder<AzureTokenAuthConfigBuilder>
implements java.lang.AutoCloseable

Builder class for configuring Azure Token Authentication via a DefaultAzureCredential. It builds a TokenAuthConfig object which can be used to authenticate with Azure resources. This class extends TokenAuthConfig.Builder and implements AutoCloseable. It provides methods to configure various parameters for Azure Token Authentication.

Default values:

• DEFAULT_EXPIRATION_REFRESH_RATIO: 0.75F
• DEFAULT_LOWER_REFRESH_BOUND_MILLIS: 2 * 60 * 1000
• DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS: 1000
• DEFAULT_MAX_ATTEMPTS_TO_RETRY: 5
• DEFAULT_DELAY_IN_MS_TO_RETRY: 100
• DEFAULT_SCOPES: "https://redis.azure.com/.default"

Example usage:

 AzureTokenAuthConfigBuilder builder = AzureTokenAuthConfigBuilder.builder()
     .defaultAzureCredential(new DefaultAzureCredentialBuilder.build())
     .scopes(Collections.singleton("https://example.com/.default"))
     .tokenRequestExecTimeoutInMs(2000);
 TokenAuthConfig config = builder.build();
 

This class is also AutoCloseable, and resources can be cleaned up by calling close().

See Also:

TokenAuthConfig.Builder, DefaultAzureCredential

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DELAY_IN_MS_TO_RETRY
static float	DEFAULT_EXPIRATION_REFRESH_RATIO
static int	DEFAULT_LOWER_REFRESH_BOUND_MILLIS
static int	DEFAULT_MAX_ATTEMPTS_TO_RETRY
static java.util.Set<java.lang.String>	DEFAULT_SCOPES
static int	DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS

Constructor Summary

Constructors

Constructor and Description
AzureTokenAuthConfigBuilder()

Method Summary

Modifier and Type	Method and Description
redis.clients.authentication.core.TokenAuthConfig	build()
static AzureTokenAuthConfigBuilder	builder()
void	close()
AzureTokenAuthConfigBuilder	defaultAzureCredential(com.azure.identity.DefaultAzureCredential defaultAzureCredential)
static AzureTokenAuthConfigBuilder	from(AzureTokenAuthConfigBuilder sample)
AzureTokenAuthConfigBuilder	scopes(java.util.Set<java.lang.String> scopes)
AzureTokenAuthConfigBuilder	tokenRequestExecTimeoutInMs(int tokenRequestExecTimeoutInMs)

Methods inherited from class redis.clients.authentication.core.TokenAuthConfig.Builder

delayInMsToRetry, expirationRefreshRatio, from, identityProviderConfig, lowerRefreshBoundMillis, maxAttemptsToRetry

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPIRATION_REFRESH_RATIO

public static final float DEFAULT_EXPIRATION_REFRESH_RATIO

See Also:

Constant Field Values

DEFAULT_LOWER_REFRESH_BOUND_MILLIS

public static final int DEFAULT_LOWER_REFRESH_BOUND_MILLIS

See Also:

Constant Field Values

DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS

public static final int DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS

See Also:

Constant Field Values

DEFAULT_MAX_ATTEMPTS_TO_RETRY

public static final int DEFAULT_MAX_ATTEMPTS_TO_RETRY

See Also:

Constant Field Values

DEFAULT_DELAY_IN_MS_TO_RETRY

public static final int DEFAULT_DELAY_IN_MS_TO_RETRY

See Also:

Constant Field Values

DEFAULT_SCOPES

public static final java.util.Set<java.lang.String> DEFAULT_SCOPES

Constructor Detail

AzureTokenAuthConfigBuilder

public AzureTokenAuthConfigBuilder()

Method Detail

defaultAzureCredential

public AzureTokenAuthConfigBuilder defaultAzureCredential(com.azure.identity.DefaultAzureCredential defaultAzureCredential)

scopes

public AzureTokenAuthConfigBuilder scopes(java.util.Set<java.lang.String> scopes)

tokenRequestExecTimeoutInMs

public AzureTokenAuthConfigBuilder tokenRequestExecTimeoutInMs(int tokenRequestExecTimeoutInMs)

Overrides:

tokenRequestExecTimeoutInMs in class redis.clients.authentication.core.TokenAuthConfig.Builder<AzureTokenAuthConfigBuilder>

build

public redis.clients.authentication.core.TokenAuthConfig build()

Overrides:

build in class redis.clients.authentication.core.TokenAuthConfig.Builder<AzureTokenAuthConfigBuilder>

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

builder

public static AzureTokenAuthConfigBuilder builder()

from

public static AzureTokenAuthConfigBuilder from(AzureTokenAuthConfigBuilder sample)