Deprecate config methods for removed cache configuration. (#42437)

* Deprecate config methods for removed cache cnofiguration. In Identity 1.14 we removed support for very old versions of the Azure Toolkit for IntelliJ. These two methods configured the behavior of the old versions, and no longer do anything. * Update changelog to include PR link Fix readme to not point to deprecated method. * update changelog
Azure · Oct 17, 2024 · 97cd5bc · 97cd5bc
1 parent 5e1a8d7
commit 97cd5bc
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/sdk/identity/azure-identity/CHANGELOG.md b/sdk/identity/azure-identity/CHANGELOG.md
@@ -9,6 +9,7 @@
 ### Bugs Fixed
 
 ### Other Changes
+- `@Deprecated` methods `DefaultAzureCredential.setIntelliJKeePassDatabasePath` and `IntelliJCredentialBuilder.keePassDatabasePath`. [#42437](https://github.com/Azure/azure-sdk-for-java/pull/42437)
 
 ## 1.14.0 (2024-10-03)
 

diff --git a/sdk/identity/azure-identity/README.md b/sdk/identity/azure-identity/README.md
@@ -154,12 +154,10 @@ See more about how to configure your IntelliJ IDEA in [Sign in Azure Toolkit for
 
 ```java
 /**
- * DefaultAzureCredential uses the KeePass database path to find the user account in IntelliJ on Windows.
+ * DefaultAzureCredential uses the signed-in user from Azure Toolkit for Java.
  */
 public void createDefaultAzureCredentialForIntelliJ() {
     DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder()
-        // KeePass configuration required only for Windows. No configuration needed for Linux / Mac
-        .intelliJKeePassDatabasePath("C:\\Users\\user\\AppData\\Roaming\\JetBrains\\IdeaIC2020.1\\c.kdbx")
         .build();
 
     // Azure SDK client builders accept the credential as a parameter

diff --git a/...entity/azure-identity/src/main/java/com/azure/identity/DefaultAzureCredentialBuilder.java b/...entity/azure-identity/src/main/java/com/azure/identity/DefaultAzureCredentialBuilder.java
@@ -108,7 +108,10 @@ public DefaultAzureCredentialBuilder authorityHost(String authorityHost) {
      * @param databasePath the path to the KeePass database.
      * @throws IllegalArgumentException if {@code databasePath} is either not specified or is empty.
      * @return An updated instance of this builder with the KeePass database path set as specified.
+     * @deprecated Support for older Azure Toolkit for IntelliJ versions was
+     * <a href="https://aka.ms/azsdk/java/identity/intellij-credential-update">removed in 1.14.0.</a>
      */
+    @Deprecated
     public DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath) {
         if (CoreUtils.isNullOrEmpty(databasePath)) {
             throw LOGGER.logExceptionAsError(

diff --git a/sdk/identity/azure-identity/src/main/java/com/azure/identity/IntelliJCredentialBuilder.java b/sdk/identity/azure-identity/src/main/java/com/azure/identity/IntelliJCredentialBuilder.java
@@ -76,7 +76,10 @@ public IntelliJCredentialBuilder tenantId(String tenantId) {
      * @param databasePath the path to the KeePass database.
      * @throws IllegalArgumentException if {@code databasePath} is either not specified or is empty.
      * @return An updated instance of this builder with the KeePass database path set as specified.
+     * @deprecated Support for older Azure Toolkit for IntelliJ versions was
+     * <a href="https://aka.ms/azsdk/java/identity/intellij-credential-update">removed in 1.14.0.</a>
      */
+    @Deprecated
     public IntelliJCredentialBuilder keePassDatabasePath(String databasePath) {
         if (CoreUtils.isNullOrEmpty(databasePath)) {
             throw LOGGER.logExceptionAsError(