redis.clients.authentication.entraid

Class EntraIDTokenAuthConfigBuilder

java.lang.Object

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

redis.clients.authentication.entraid.EntraIDTokenAuthConfigBuilder

All Implemented Interfaces:

java.lang.AutoCloseable

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

Builder class for configuring EntraID token authentication. This class provides methods to set various configuration options for EntraID token authentication. It extends the TokenAuthConfig.Builder class and implements AutoCloseable.

Default values:

• DEFAULT_EXPIRATION_REFRESH_RATIO: 0.75F
• DEFAULT_LOWER_REFRESH_BOUND_MILLIS: 120000 (2 minutes)
• DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS: 1000 (1 second)
• DEFAULT_MAX_ATTEMPTS_TO_RETRY: 5
• DEFAULT_DELAY_IN_MS_TO_RETRY: 100 (0.1 second)

Configuration options:

• clientId(String): Sets the client ID.
• secret(String): Sets the client secret and configures access with secret.
• key(PrivateKey, X509Certificate): Sets the private key and certificate, and configures access with certificate.
• authority(String): Sets the authority URL.
• systemAssignedManagedIdentity(): Configures system-assigned managed identity.
• #userAssignedManagedIdentity(UserManagedIdentityType, String): Configures user-assigned managed identity.
• customEntraIdAuthenticationSupplier(Supplier): Sets a custom authentication supplier.
• scopes(Set): Sets the scopes for the token request.
• tokenRequestExecTimeoutInMs(int): Sets the token request execution timeout in milliseconds.

Usage:

 
 EntraIDTokenAuthConfigBuilder builder = EntraIDTokenAuthConfigBuilder.builder()
     .clientId("your-client-id")
     .secret("your-secret")
     .authority("https://login.microsoftonline.com/your-tenant-id")
     .scopes(Set.of("https://redis.azure.com/.default"))
     .build();
 
 

Note:

• Only one of ServicePrincipal, ManagedIdentity or customEntraIdAuthenticationSupplier can be configured.
• Throws RedisEntraIDException if conflicting configurations are provided.

For more information and details on how to use, please see:

https://github.com/redis/jedis/blob/master/docs/advanced-usage.md#token-based-authentication

https://github.com/redis/lettuce/blob/main/docs/user-guide/connecting-redis.md#microsoft-entra-id-authentication

See Also:

TokenAuthConfig.Builder, AutoCloseable

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 int	DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS

Constructor Summary

Constructors

Constructor and Description
EntraIDTokenAuthConfigBuilder()

Method Summary

Modifier and Type	Method and Description
EntraIDTokenAuthConfigBuilder	authority(java.lang.String authority)
redis.clients.authentication.core.TokenAuthConfig	build()
static EntraIDTokenAuthConfigBuilder	builder()
EntraIDTokenAuthConfigBuilder	clientId(java.lang.String clientId)
void	close()
EntraIDTokenAuthConfigBuilder	customEntraIdAuthenticationSupplier(java.util.function.Supplier<com.microsoft.aad.msal4j.IAuthenticationResult> customEntraIdAuthenticationSupplier)
static EntraIDTokenAuthConfigBuilder	from(EntraIDTokenAuthConfigBuilder sample)
EntraIDTokenAuthConfigBuilder	key(java.security.PrivateKey key, java.security.cert.X509Certificate cert)
EntraIDTokenAuthConfigBuilder	scopes(java.util.Set<java.lang.String> scopes)
EntraIDTokenAuthConfigBuilder	secret(java.lang.String secret)
EntraIDTokenAuthConfigBuilder	systemAssignedManagedIdentity()
EntraIDTokenAuthConfigBuilder	tokenRequestExecTimeoutInMs(int tokenRequestExecTimeoutInMs)
EntraIDTokenAuthConfigBuilder	userAssignedManagedIdentity(ManagedIdentityInfo.UserManagedIdentityType userManagedType, java.lang.String id)

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

Constructor Detail

EntraIDTokenAuthConfigBuilder

public EntraIDTokenAuthConfigBuilder()

Method Detail

clientId

public EntraIDTokenAuthConfigBuilder clientId(java.lang.String clientId)

secret

public EntraIDTokenAuthConfigBuilder secret(java.lang.String secret)

key

public EntraIDTokenAuthConfigBuilder key(java.security.PrivateKey key,
                                         java.security.cert.X509Certificate cert)

authority

public EntraIDTokenAuthConfigBuilder authority(java.lang.String authority)

systemAssignedManagedIdentity

public EntraIDTokenAuthConfigBuilder systemAssignedManagedIdentity()

userAssignedManagedIdentity

public EntraIDTokenAuthConfigBuilder userAssignedManagedIdentity(ManagedIdentityInfo.UserManagedIdentityType userManagedType,
                                                                 java.lang.String id)

customEntraIdAuthenticationSupplier

public EntraIDTokenAuthConfigBuilder customEntraIdAuthenticationSupplier(java.util.function.Supplier<com.microsoft.aad.msal4j.IAuthenticationResult> customEntraIdAuthenticationSupplier)

scopes

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

tokenRequestExecTimeoutInMs

public EntraIDTokenAuthConfigBuilder tokenRequestExecTimeoutInMs(int tokenRequestExecTimeoutInMs)

Overrides:

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

build

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

Overrides:

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

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

builder

public static EntraIDTokenAuthConfigBuilder builder()

from

public static EntraIDTokenAuthConfigBuilder from(EntraIDTokenAuthConfigBuilder sample)