Merge pull request #1001 from AzureAD/avdunn/extraqueryparams-deprecate

Deprecate extraQueryParameters

Author: Avery-Dunn

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthorizationCodeParameters.java

@@ -92,6 +92,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -173,7 +177,9 @@ public AuthorizationCodeParametersBuilder extraHttpHeaders(Map<String, String> e
 
         /**
          * Adds additional query parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public AuthorizationCodeParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthorizationRequestUrlParameters.java

@@ -234,6 +234,10 @@ public boolean instanceAware() {
         return this.instanceAware;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -419,7 +423,9 @@ public Builder instanceAware(boolean val) {
         /**
          * Query parameters that you can add to the request,
          * in addition to the list of parameters already provided.
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public Builder extraQueryParameters(Map<String, String> val) {
             this.extraQueryParameters = val;
             return self();

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/ClientCredentialParameters.java

@@ -71,6 +71,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -134,7 +138,9 @@ public ClientCredentialParametersBuilder extraHttpHeaders(Map<String, String> ex
 
         /**
          * Adds additional query parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public ClientCredentialParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/DeviceCodeFlowParameters.java

@@ -70,6 +70,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -135,7 +139,9 @@ public DeviceCodeFlowParametersBuilder extraHttpHeaders(Map<String, String> extr
 
         /**
          * Adds additional query parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public DeviceCodeFlowParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/IAcquireTokenParameters.java

@@ -62,6 +62,9 @@ interface IAcquireTokenParameters {
      * This can be useful for scenarios requiring custom parameters that aren't explicitly supported in the library.
      *
      * @return A map of additional query parameters to include with the token request, or null if no extra parameters are needed.
+     *
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
      */
+    @Deprecated
     Map<String, String> extraQueryParameters();
 }

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/IntegratedWindowsAuthenticationParameters.java

@@ -72,6 +72,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -129,7 +133,9 @@ public IntegratedWindowsAuthenticationParametersBuilder extraHttpHeaders(Map<Str
 
         /**
          * Adds additional parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public IntegratedWindowsAuthenticationParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/InteractiveRequestParameters.java

@@ -113,6 +113,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -262,7 +266,9 @@ public InteractiveRequestParametersBuilder extraHttpHeaders(Map<String, String>
 
         /**
          * Adds additional query parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public InteractiveRequestParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/OnBehalfOfParameters.java

@@ -76,6 +76,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -136,7 +140,9 @@ public OnBehalfOfParametersBuilder extraHttpHeaders(Map<String, String> extraHtt
 
         /**
          * Adds additional parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public OnBehalfOfParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/RefreshTokenParameters.java

@@ -72,6 +72,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -133,7 +137,9 @@ public RefreshTokenParametersBuilder extraHttpHeaders(Map<String, String> extraH
 
         /**
          * Adds additional parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public RefreshTokenParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/SilentParameters.java

@@ -119,6 +119,10 @@ public Map<String, String> extraHttpHeaders() {
         return this.extraHttpHeaders;
     }
 
+    /**
+     * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
+     */
+    @Deprecated
     public Map<String, String> extraQueryParameters() {
         return this.extraQueryParameters;
     }
@@ -215,7 +219,9 @@ public SilentParametersBuilder extraHttpHeaders(Map<String, String> extraHttpHea
 
         /**
          * Adds additional query parameters to the token request
+         * @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
          */
+        @Deprecated
         public SilentParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
             this.extraQueryParameters = extraQueryParameters;
             return this;