API Changes, deprecating all methods not using TokenParameters

msal/build.gradle

@@ -198,6 +198,9 @@ dependencies {
     implementation "cz.msebera.android:httpclient:$rootProject.ext.mseberaApacheHttpClientVersion"
     implementation "androidx.constraintlayout:constraintlayout:$rootProject.ext.constraintLayoutVersion"
 
+    compileOnly "org.projectlombok:lombok:$rootProject.ext.lombokVersion"
+    annotationProcessor "org.projectlombok:lombok:$rootProject.ext.lombokVersion"
+
     // test dependencies
     testImplementation "junit:junit:$rootProject.ext.junitVersion"
     //mockito-inline was introduced in mockito 2.7.6

msal/src/main/java/com/microsoft/identity/client/IPublicClientApplication.java

@@ -36,20 +36,10 @@
 public interface IPublicClientApplication {
 
     /**
-     * Acquire token interactively, will pop-up webUI. Interactive flow will skip the cache lookup.
-     * Default value for {@link Prompt} is {@link Prompt#SELECT_ACCOUNT}.
-     *
-     * @param activity Non-null {@link Activity} that is used as the parent activity for launching the {@link com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity}.
-     * @param scopes   The non-null array of scopes to be requested for the access token.
-     *                 MSAL always sends the scopes 'openid profile offline_access'.  Do not include any of these scopes in the scope parameter.
-     * @param callback The {@link AuthenticationCallback} to receive the result back.
-     *                 1) If user cancels the flow by pressing the device back button, the result will be sent
-     *                 back via {@link AuthenticationCallback#onCancel()}.
-     *                 2) If the sdk successfully receives the token back, result will be sent back via
-     *                 {@link AuthenticationCallback#onSuccess(IAuthenticationResult)}
-     *                 3) All the other errors will be sent back via
-     *                 {@link AuthenticationCallback#onError(MsalException)}.
+     * @deprecated  This method is now deprecated. The library is moving towards standardizing the use of TokenParameter subclasses as the
+     *              parameters for the API. Use {@link IPublicClientApplication#acquireToken(AcquireTokenParameters)} instead.
      */
+    @Deprecated
     void acquireToken(@NonNull final Activity activity,
                       @NonNull final String[] scopes,
                       @NonNull final AuthenticationCallback callback
@@ -92,6 +82,16 @@ void acquireToken(@NonNull final Activity activity,
      * @param scopes   the desired access scopes
      * @param callback callback object used to communicate with the API throughout the protocol
      */
+    void acquireTokenWithDeviceCode(@NonNull List<String> scopes, @NonNull final DeviceCodeFlowCallback callback);
+
+    /**
+     * @deprecated  This method is now deprecated. The library is moving away from using an array for scopes.
+     *              Use {@link IPublicClientApplication#acquireTokenWithDeviceCode(List, DeviceCodeFlowCallback)} instead.
+     *
+     * @param scopes   the desired access scopes
+     * @param callback callback object used to communicate with the API throughout the protocol
+     */
+    @Deprecated
     void acquireTokenWithDeviceCode(@NonNull String[] scopes, @NonNull final DeviceCodeFlowCallback callback);
 
     /**
@@ -235,7 +235,7 @@ interface IMultipleAccountApplicationCreatedListener {
      * 3). Receiving an exception detailing what went wrong in the protocol
      * via {@link DeviceCodeFlowCallback#onError(MsalException)}.
      * <p>
-     * Refer to {@link PublicClientApplication#acquireTokenWithDeviceCode(String[], DeviceCodeFlowCallback)}.
+     * Refer to {@link PublicClientApplication#acquireTokenWithDeviceCode(List, DeviceCodeFlowCallback)}.
      */
     interface DeviceCodeFlowCallback {
         /**

msal/src/main/java/com/microsoft/identity/client/ISingleAccountPublicClientApplication.java

@@ -66,50 +66,32 @@ public interface ISingleAccountPublicClientApplication extends IPublicClientAppl
      * Allows a user to sign in to your application with one of their accounts. This method may only
      * be called once: once a user is signed in, they must first be signed out before another user
      * may sign in. If you wish to prompt the existing user for credentials use
-     * {@link #signInAgain(Activity, String[], Prompt, AuthenticationCallback)} or
+     * {@link #signInAgain(SignInParameters)} or
      * {@link #acquireToken(AcquireTokenParameters)}.
      * <p>
      * Note: The authority used to make the sign in request will be either the MSAL default: https://login.microsoftonline.com/common
-     * or the default authority specified by you in your configuration
+     * or the default authority specified by you in your configuration.
      *
-     * @param activity  Non-null {@link Activity} that is used as the parent activity for launching the {@link com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity}.
-     * @param loginHint Optional. If provided, will be used as the query parameter sent for authenticating the user,
-     *                  which will have the UPN pre-populated.
-     * @param scopes    The non-null array of scopes to be consented to during sign in.
-     *                  MSAL always sends the scopes 'openid profile offline_access'.  Do not include any of these scopes in the scope parameter.
-     *                  The access token returned is for MS Graph and will allow you to query for additional information about the signed in account.
-     * @param callback  {@link AuthenticationCallback} that is used to send the result back. The success result will be
-     *                  sent back via {@link AuthenticationCallback#onSuccess(IAuthenticationResult)}.
-     *                  Failure case will be sent back via {
-     * @link AuthenticationCallback#onError(MsalException)}.
+     * @param signInParameters the {@link SignInParameters} containing the needed fields for signIn flow.
      */
+    void signIn(@NonNull final SignInParameters signInParameters);
+
+    /**
+     * @deprecated  This method is now deprecated. The library is moving towards standardizing the use of TokenParameter subclasses as the
+     *              parameters for the API. Use {@link ISingleAccountPublicClientApplication#signIn(SignInParameters)} instead.
+     */
+    @Deprecated
     void signIn(@NonNull final Activity activity,
                 @Nullable final String loginHint,
                 @NonNull final String[] scopes,
                 @NonNull final AuthenticationCallback callback
     );
 
     /**
-     * Allows a user to sign in to your application with one of their accounts. This method may only
-     * be called once: once a user is signed in, they must first be signed out before another user
-     * may sign in. If you wish to prompt the existing user for credentials use
-     * {@link #signInAgain(Activity, String[], Prompt, AuthenticationCallback)} or
-     * {@link #acquireToken(AcquireTokenParameters)}.
-     * <p>
-     * Note: The authority used to make the sign in request will be either the MSAL default: https://login.microsoftonline.com/common
-     * or the default authority specified by you in your configuration
-     *
-     * @param activity  Non-null {@link Activity} that is used as the parent activity for launching the {@link com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity}.
-     * @param loginHint Optional. If provided, will be used as the query parameter sent for authenticating the user,
-     *                  which will have the UPN pre-populated.
-     * @param scopes    The non-null array of scopes to be consented to during sign in.
-     *                  MSAL always sends the scopes 'openid profile offline_access'.  Do not include any of these scopes in the scope parameter.
-     *                  The access token returned is for MS Graph and will allow you to query for additional information about the signed in account.
-     * @param callback  {@link AuthenticationCallback} that is used to send the result back. The success result will be
-     *                  sent back via {@link AuthenticationCallback#onSuccess(IAuthenticationResult)}.
-     *                  Failure case will be sent back via {
-     * @link AuthenticationCallback#onError(MsalException)}.
+     * @deprecated  This method is now deprecated. The library is moving towards standardizing the use of TokenParameter subclasses as the
+     *              parameters for the API. Use {@link ISingleAccountPublicClientApplication#signIn(SignInParameters)} instead.
      */
+    @Deprecated
     void signIn(@NonNull final Activity activity,
                 @Nullable final String loginHint,
                 @NonNull final String[] scopes,
@@ -122,22 +104,17 @@ void signIn(@NonNull final Activity activity,
      * <p>
      * Note: The authority used to make the sign in request will be either the MSAL default:
      * https://login.microsoftonline.com/common or the default authority specified by you in your
-     * configuration.
+     * configuration. This flow requires activity, scopes, and callback. Prompt is optional.
      *
-     * @param activity Non-null {@link Activity} that is used as the parent activity for
-     *                 launching the {@link com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity}.
-     * @param scopes   The non-null array of scopes to be consented to during sign in.
-     *                 MSAL always sends the scopes 'openid profile offline_access'. Do
-     *                 not include any of these scopes in the scope parameter. The access
-     *                 token returned is for MS Graph and will allow you to query for
-     *                 additional information about the signed in account.
-     * @param prompt   Nullable. Indicates the type of user interaction that is required.
-     *                 If no argument is supplied the default behavior will be used.
-     * @param callback {@link AuthenticationCallback} that is used to send the result back.
-     *                 The success result will be sent back via
-     *                 {@link AuthenticationCallback#onSuccess(IAuthenticationResult)}.
-     *                 Failure case will be sent back via {@link AuthenticationCallback#onError(MsalException)}.
+     * @param signInParameters the {@link SignInParameters} containing the needed fields for signIn flow.
      */
+    void signInAgain(@NonNull final SignInParameters signInParameters);
+
+    /**
+     * @deprecated  This method is now deprecated. The library is moving towards standardizing the use of TokenParameter subclasses as the
+     *              parameters for the API. Use {@link ISingleAccountPublicClientApplication#signInAgain(SignInParameters)} instead.
+     */
+    @Deprecated
     void signInAgain(@NonNull final Activity activity,
                      @NonNull final String[] scopes,
                      @Nullable final Prompt prompt,
@@ -166,14 +143,15 @@ void signInAgain(@NonNull final Activity activity,
      * no valid access token exists, the sdk will try to find a refresh token and use the refresh token to get a new access token. If refresh token does not exist
      * or it fails the refresh, exception will be sent back via callback.
      *
-     * @param scopes    The non-null array of scopes to be requested for the access token.
-     *                  MSAL always sends the scopes 'openid profile offline_access'.  Do not include any of these scopes in the scope parameter.
-     * @param authority Authority to issue the token.
-     * @param callback  {@link SilentAuthenticationCallback} that is used to send the result back. The success result will be
-     *                  sent back via {@link SilentAuthenticationCallback#onSuccess(IAuthenticationResult)}.
-     *                  Failure case will be sent back via {
-     * @link AuthenticationCallback#onError(MsalException)}.
+     * @param acquireTokenSilentParameters the {@link AcquireTokenSilentParameters} containing the needed fields for acquireTokenSilent flow.
+     */
+    void acquireTokenSilentAsync(@NonNull final AcquireTokenSilentParameters acquireTokenSilentParameters);
+
+    /**
+     * @deprecated  This method is now deprecated. The library is moving towards standardizing the use of TokenParameter subclasses as the
+     *              parameters for the API. Use {@link ISingleAccountPublicClientApplication#acquireTokenSilentAsync(AcquireTokenSilentParameters)} instead.
      */
+    @Deprecated
     void acquireTokenSilentAsync(@NonNull final String[] scopes,
                                  @NonNull final String authority,
                                  @NonNull final SilentAuthenticationCallback callback
@@ -184,11 +162,17 @@ void acquireTokenSilentAsync(@NonNull final String[] scopes,
      * no valid access token exists, the sdk will try to find a refresh token and use the refresh token to get a new access token. If refresh token does not exist
      * or it fails the refresh, exception will be sent back via callback.
      *
-     * @param scopes    The non-null array of scopes to be requested for the access token.
-     *                  MSAL always sends the scopes 'openid profile offline_access'.  Do not include any of these scopes in the scope parameter.
-     * @param authority Authority to issue the token.
+     * @param acquireTokenSilentParameters the {@link AcquireTokenSilentParameters} containing the needed parameters for acquireTokenSilent flow.
+     */
+    @WorkerThread
+    IAuthenticationResult acquireTokenSilent(@NonNull final AcquireTokenSilentParameters acquireTokenSilentParameters) throws InterruptedException, MsalException;
+
+    /**
+     * @deprecated  This method is now deprecated. The library is moving towards standardizing the use of TokenParameter subclasses as the
+     *              parameters for the API. Use {@link ISingleAccountPublicClientApplication#acquireTokenSilent(AcquireTokenSilentParameters)} instead.
      */
     @WorkerThread
+    @Deprecated
     IAuthenticationResult acquireTokenSilent(@NonNull final String[] scopes,
                                              @NonNull final String authority) throws MsalException, InterruptedException;
 

msal/src/main/java/com/microsoft/identity/client/MultipleAccountPublicClientApplication.java

@@ -50,6 +50,7 @@
 import com.microsoft.identity.common.java.util.ResultFuture;
 import com.microsoft.identity.common.logging.Logger;
 
+import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.ExecutionException;
 
@@ -65,11 +66,17 @@ protected MultipleAccountPublicClientApplication(@NonNull PublicClientApplicatio
         super(config);
     }
 
+    //TODO: Add acquireTokenSilent(AcquireTokenSilentParameters)
+
+    //TODO: Deprecate
     @Override
     public IAuthenticationResult acquireTokenSilent(@NonNull String[] scopes, @NonNull IAccount account, @NonNull String authority) throws MsalException, InterruptedException {
         return acquireTokenSilentSyncInternal(scopes, authority, account, false, PublicApiId.MULTIPLE_ACCOUNT_PCA_ACQUIRE_TOKEN_SILENT_WITH_SCOPES_ACCOUNT_AUTHORITY);
     }
 
+    //TODO: Add acquireTokenSilentAsync(AcquireTokenSilentParameters)
+
+    //TODO: Deprecate
     @Override
     public void acquireTokenSilentAsync(@NonNull final String[] scopes,
                                         @NonNull final IAccount account,
@@ -431,6 +438,9 @@ public void onError(@NonNull MsalException exception) {
         }
     }
 
+    //TODO: Add acquireToken(AcquireTokenParameters)
+
+    //TODO: Deprecate
     @Override
     public void acquireToken(@NonNull final Activity activity,
                              @NonNull final String[] scopes,
@@ -439,7 +449,7 @@ public void acquireToken(@NonNull final Activity activity,
         final AcquireTokenParameters acquireTokenParameters = buildAcquireTokenParameters(
                 activity,
                 null,
-                scopes,
+                Arrays.asList(scopes),
                 null, // account
                 null, // uiBehavior
                 null, // extraQueryParams