adding java docs

Author: atakavci

core/src/main/java/redis/clients/authentication/core/Dispatcher.java

@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.core;
 

core/src/main/java/redis/clients/authentication/core/RenewalScheduler.java

@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.core;
 

core/src/main/java/redis/clients/authentication/core/TokenManager.java

@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.core;
 

entraid/src/main/java/redis/clients/authentication/entraid/AzureIdentityProvider.java

@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.entraid;
 
@@ -14,6 +17,38 @@
 import redis.clients.authentication.core.IdentityProvider;
 import redis.clients.authentication.core.Token;
 
+/**
+ * AzureIdentityProvider is an implementation of the IdentityProvider interface
+ * that uses Azure's DefaultAzureCredential to obtain access tokens.
+ * 
+ * <p>This class is designed to work with Azure's identity platform to provide
+ * authentication tokens for accessing Azure resources. It uses a 
+ * DefaultAzureCredential to request tokens with specified scopes and a timeout(in milliseconds). 
+ * For most cases you will not need to use it directly since AzureTokenAuthConfigBuilder 
+ * will do the work for you as shown in the example below:
+ * <pre>
+ * {@code
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder()
+ *          .defaultAzureCredential(new DefaultAzureCredential()).build();
+ * }
+ * </pre>
+ * <p>In you case you need your own implementation for relevant reasons, you can use it as follows:
+ * <pre>
+ * {@code
+ * Set<String> scopes = new HashSet<>(Arrays.asList("https://redis.azure.com/.default"));
+ * AzureIdentityProvider provider = new AzureIdentityProvider(
+ *      new DefaultAzureCredentialBuilder().build(), scopes, 5000);
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder().identityProviderConfig(()-> provider)).build();
+ * }
+ * </pre>
+ * 
+ * <p>Thread Safety: This class is thread-safe as long as the provided 
+ * DefaultAzureCredential is thread-safe.
+ * 
+ * @see redis.clients.authentication.entraid.AzureTokenAuthConfigBuilder
+ * @see com.azure.identity.DefaultAzureCredentialBuilder
+ */
+
 public final class AzureIdentityProvider implements IdentityProvider {
 
     private Supplier<AccessToken> accessTokenSupplier;

entraid/src/main/java/redis/clients/authentication/entraid/AzureIdentityProviderConfig.java

@@ -14,6 +14,39 @@
 import redis.clients.authentication.core.IdentityProvider;
 import redis.clients.authentication.core.IdentityProviderConfig;
 
+/**
+ * Configuration class for Azure Identity Provider.
+ * This class implements the {@link IdentityProviderConfig} interface and provides
+ * a configuration for creating an {@link AzureIdentityProvider} instance.
+ * 
+ * <p>This class uses {@link DefaultAzureCredential} for authentication and allows
+ * specifying scopes and a timeout(in milliseconds) for the identity provider.</p>
+ * For most cases you will not need to use it directly since AzureTokenAuthConfigBuilder 
+ * will do the work for you as shown in the example below:
+ * <pre>
+ * {@code
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder()
+ *          .defaultAzureCredential(new DefaultAzureCredentialBuilder()).build();
+ * } 
+ * </pre>
+ * <p>In you case you need your own implementation for relevant reasons, you can use it as follows:
+ * <pre>
+ * {@code
+ * DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
+ * Set<String> scopes = Set.of("https://redis.azure.com/.default");
+ * AzureIdentityProviderConfig azureIDPConfig = new AzureIdentityProviderConfig(credential, scopes, 5000);
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder().identityProviderConfig(azureIDPConfig).build();
+ * }
+ * </pre>
+ * 
+ * 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 IdentityProviderConfig
+ * @see AzureIdentityProvider
+ * @see DefaultAzureCredentialBuilder
+ */
 public final class AzureIdentityProviderConfig implements IdentityProviderConfig {
 
     private final Supplier<IdentityProvider> providerSupplier;

entraid/src/main/java/redis/clients/authentication/entraid/AzureTokenAuthConfigBuilder.java

@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.entraid;
 
@@ -11,6 +14,38 @@
 import redis.clients.authentication.core.TokenAuthConfig;
 import redis.clients.authentication.core.TokenManagerConfig;
 
+/**
+ * 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 {@link TokenAuthConfig.Builder} and implements {@link AutoCloseable}.
+ * It provides methods to configure various parameters for Azure Token Authentication.
+ * 
+ * <p>Default values:</p>
+ * <ul>
+ *   <li>{@code DEFAULT_EXPIRATION_REFRESH_RATIO}: 0.75F</li>
+ *   <li>{@code DEFAULT_LOWER_REFRESH_BOUND_MILLIS}: 2 * 60 * 1000</li>
+ *   <li>{@code DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS}: 1000</li>
+ *   <li>{@code DEFAULT_MAX_ATTEMPTS_TO_RETRY}: 5</li>
+ *   <li>{@code DEFAULT_DELAY_IN_MS_TO_RETRY}: 100</li>
+ *   <li>{@code DEFAULT_SCOPES}: "https://redis.azure.com/.default"</li>
+ * </ul>
+ * 
+ * <p>Example usage:</p>
+ * <pre>{@code
+ * AzureTokenAuthConfigBuilder builder = AzureTokenAuthConfigBuilder.builder()
+ *     .defaultAzureCredential(new DefaultAzureCredentialBuilder.build())
+ *     .scopes(Collections.singleton("https://example.com/.default"))
+ *     .tokenRequestExecTimeoutInMs(2000);
+ * TokenAuthConfig config = builder.build();
+ * }</pre>
+ * 
+ * <p>This class is also {@link AutoCloseable}, and resources can be cleaned
+ * up by calling {@link #close()}.</p>
+ * 
+ * @see TokenAuthConfig.Builder
+ * @see DefaultAzureCredentialBuilder
+ * @see DefaultAzureCredential
+ */
 public class AzureTokenAuthConfigBuilder
         extends TokenAuthConfig.Builder<AzureTokenAuthConfigBuilder> implements AutoCloseable {
     public static final float DEFAULT_EXPIRATION_REFRESH_RATIO = 0.75F;

entraid/src/main/java/redis/clients/authentication/entraid/EntraIDTokenAuthConfigBuilder.java

@@ -18,6 +18,60 @@
 import redis.clients.authentication.entraid.ManagedIdentityInfo.UserManagedIdentityType;
 import redis.clients.authentication.entraid.ServicePrincipalInfo.ServicePrincipalAccess;
 
+/**
+ * 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.
+ * 
+ * <p>Default values:</p>
+ * <ul>
+ *   <li>DEFAULT_EXPIRATION_REFRESH_RATIO: 0.75F</li>
+ *   <li>DEFAULT_LOWER_REFRESH_BOUND_MILLIS: 120000 (2 minutes)</li>
+ *   <li>DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS: 1000 (1 second)</li>
+ *   <li>DEFAULT_MAX_ATTEMPTS_TO_RETRY: 5</li>
+ *   <li>DEFAULT_DELAY_IN_MS_TO_RETRY: 100 (0.1 second)</li>
+ * </ul>
+ * 
+ * <p>Configuration options:</p>
+ * <ul>
+ *   <li>{@link #clientId(String)}: Sets the client ID.</li>
+ *   <li>{@link #secret(String)}: Sets the client secret and configures access with secret.</li>
+ *   <li>{@link #key(PrivateKey, X509Certificate)}: Sets the private key and certificate, 
+ *      and configures access with certificate.</li>
+ *   <li>{@link #authority(String)}: Sets the authority URL.</li>
+ *   <li>{@link #systemAssignedManagedIdentity()}: Configures system-assigned managed identity.</li>
+ *   <li>{@link #userAssignedManagedIdentity(UserManagedIdentityType, String)}: 
+ *      Configures user-assigned managed identity.</li>
+ *   <li>{@link #customEntraIdAuthenticationSupplier(Supplier)}: Sets a custom authentication supplier.</li>
+ *   <li>{@link #scopes(Set)}: Sets the scopes for the token request.</li>
+ *   <li>{@link #tokenRequestExecTimeoutInMs(int)}: Sets the token request execution timeout in milliseconds.</li>
+ * </ul>
+ * 
+ * <p>Usage:</p>
+ * <pre>
+ * {@code
+ * 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();
+ * }
+ * </pre>
+ * 
+ * <p>Note:</p>
+ * <ul>
+ *   <li>Only one of ServicePrincipal, ManagedIdentity or customEntraIdAuthenticationSupplier can be configured.</li>
+ *   <li>Throws RedisEntraIDException if conflicting configurations are provided.</li>
+ * </ul>
+ * For more information and details on how to use, please see:
+ * <p>https://github.com/redis/jedis/blob/master/docs/advanced-usage.md#token-based-authentication
+ * <p>https://github.com/redis/lettuce/blob/main/docs/user-guide/connecting-redis.md#microsoft-entra-id-authentication
+ * 
+ * @see TokenAuthConfig.Builder
+ * @see AutoCloseable
+ * 
+ */
 public class EntraIDTokenAuthConfigBuilder
         extends TokenAuthConfig.Builder<EntraIDTokenAuthConfigBuilder> implements AutoCloseable {
     public static final float DEFAULT_EXPIRATION_REFRESH_RATIO = 0.75F;

entraid/src/test/java/redis/clients/authentication/AzureIdentityProviderIntegrationTests.java

@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication;