Rename exceptions. Add MsalInteractionRequiredException.

Author: sgonzalezMSFT

src/main/java/com/microsoft/aad/msal4j/AadInstanceDiscovery.java

@@ -87,7 +87,7 @@ private static String getInstanceDiscoveryEndpoint(String host) {
 
     private static void validate(InstanceDiscoveryResponse instanceDiscoveryResponse) {
         if (StringHelper.isBlank(instanceDiscoveryResponse.tenantDiscoveryEndpoint())) {
-            throw new AuthenticationServiceException(instanceDiscoveryResponse);
+            throw new MsalServiceException(instanceDiscoveryResponse);
         }
     }
 

src/main/java/com/microsoft/aad/msal4j/AcquireTokenByAuthorizationGrantSupplier.java

@@ -153,10 +153,14 @@ private AuthorizationGrant getAuthorizationGrantIntegrated(String userName) thro
             updatedGrant = getSAMLAuthorizationGrant(wsTrustResponse);
         }
         else if (userRealmResponse.isAccountManaged()) {
-            throw new AuthenticationException("Password is required for managed user");
+            throw new MsalClientException(
+                    "Password is required for managed user",
+                    AuthenticationErrorCode.PASSWORD_REQUIRED_FOR_MANAGED_USER);
         }
         else{
-            throw new AuthenticationException("Unknown User Type");
+            throw new MsalClientException(
+                    "User Realm request failed",
+                    AuthenticationErrorCode.USER_REALM_DISCOVERY_FAILED);
         }
 
         return updatedGrant;

src/main/java/com/microsoft/aad/msal4j/AcquireTokenByDeviceCodeFlowSupplier.java

@@ -77,15 +77,15 @@ private AuthenticationResult acquireTokenWithDeviceCode(DeviceCode deviceCode,
             }
             try {
                 return acquireTokenByAuthorisationGrantSupplier.execute();
-            } catch (AuthenticationServiceException ex) {
+            } catch (MsalServiceException ex) {
                 if (ex.errorCode().equals(AUTHORIZATION_PENDING)) {
                     TimeUnit.SECONDS.sleep(deviceCode.interval());
                 } else {
                     throw ex;
                 }
             }
         }
-        throw new AuthenticationClientException("Expired Device code");
+        throw new MsalClientException("Expired Device code", AuthenticationErrorCode.CODE_EXPIRED);
     }
 
     private Long getCurrentSystemTimeInSeconds(){

src/main/java/com/microsoft/aad/msal4j/AuthenticationErrorCode.java

@@ -25,8 +25,42 @@
 
 public class AuthenticationErrorCode {
 
+    /**
+     * In the context of device code user has not yet authenticated via browser
+     */
     public final static String AUTHORIZATION_PENDING = "authorization_pending";
-    public final static String INTERACTION_REQUIRED = "interaction_required";
+
+    /**
+     * In the context of device code, this error happens when the device code has expired before
+     * the user signed-in on another device (this is usually after 15 min)
+     */
+    public final static String CODE_EXPIRED = "code_expired";
+
+    /**
+     * Standard Oauth2 protocol error code. It indicates that the application needs to expose
+     * the UI to the user so that user does an interactive action in order to get a new token
+     */
     public final static String INVALID_GRANT = "invalid_grant";
+
+    /**
+     * WS-Trust Endpoint not found in Metadata document
+     */
+    public final static String WSTRUST_ENDPOINT_NOT_FOUND_IN_METADATA_DOCUMENT = "wstrust_endpoint_not_found";
+
+    /**
+     * Password is required for managed user. Will typically happen when trying to do integrated windows authentication
+     * for managed users
+     */
+    public final static String PASSWORD_REQUIRED_FOR_MANAGED_USER = "password_required_for_managed_user";
+
+    /**
+     * User realm discovery failed
+     */
+    public final static String USER_REALM_DISCOVERY_FAILED = "user_realm_discovery_failed";
+
+    /**
+     * Unknown error occurred
+     */
     public final static String UNKNOWN = "unknown";
 }
+

src/main/java/com/microsoft/aad/msal4j/AuthenticationResultSupplier.java

@@ -31,7 +31,6 @@
 import java.net.URL;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
-import java.util.Set;
 import java.util.concurrent.CompletionException;
 import java.util.function.Supplier;
 
@@ -84,8 +83,8 @@ public IAuthenticationResult get() {
                 }
             } catch(Exception ex) {
 
-                if (ex instanceof AuthenticationServiceException) {
-                    apiEvent.setApiErrorCode(((AuthenticationServiceException) ex).errorCode());
+                if (ex instanceof MsalServiceException) {
+                    apiEvent.setApiErrorCode(((MsalServiceException) ex).errorCode());
                 }
 
                 clientApplication.log.error(

src/main/java/com/microsoft/aad/msal4j/ClientApplicationBase.java

@@ -409,7 +409,7 @@ private static Authority createDefaultAADAuthority() {
             try {
                 authority = new AADAuthority(new URL(DEFAULT_AUTHORITY));
             } catch(Exception e){
-                throw new AuthenticationClientException(e);
+                throw new MsalClientException(e);
             }
             return authority;
         }

src/main/java/com/microsoft/aad/msal4j/ConfidentialClientApplication.java

@@ -103,7 +103,7 @@ private ClientAuthentication createClientAuthFromClientAssertion(
             map.put("client_assertion", Collections.singletonList(clientAssertion.assertion()));
             return PrivateKeyJWT.parse(map);
         } catch (final ParseException e) {
-            throw new AuthenticationClientException(e);
+            throw new MsalClientException(e);
         }
     }
 

src/main/java/com/microsoft/aad/msal4j/HttpHelper.java

@@ -168,7 +168,7 @@ static void verifyReturnedCorrelationId(Logger log,
     }
 
     static String readResponseFromConnection(final HttpsURLConnection conn, HttpEvent httpEvent)
-            throws AuthenticationException, IOException {
+            throws MsalServiceException, IOException {
         InputStream is = null;
         try {
             int responseCode = conn.getResponseCode();
@@ -181,7 +181,7 @@ static String readResponseFromConnection(final HttpsURLConnection conn, HttpEven
                     msg = msg + ", Error details : " + inputStreamToString(is);
                 }
                 httpEvent.setOauthErrorCode(AuthenticationErrorCode.UNKNOWN);
-                throw new AuthenticationServiceException(msg);
+                throw new MsalServiceException(msg, AuthenticationErrorCode.UNKNOWN);
             }
 
             is = conn.getInputStream();

src/main/java/com/microsoft/aad/msal4j/IConfidentialClientApplication.java

@@ -48,7 +48,7 @@ public interface IConfidentialClientApplication extends IClientApplicationBase {
      * {@link IAuthenticationResult} of the call. It contains Access
      * Token and the Access Token's expiration time. Refresh Token
      * property will be null for this overload.
-     * @throws AuthenticationException {@link AuthenticationException}
+     * @throws MsalException {@link MsalException}
      */
     CompletableFuture<IAuthenticationResult> acquireToken(OnBehalfOfParameters parameters);
 }

src/main/java/com/microsoft/aad/msal4j/IPublicClientApplication.java

@@ -66,7 +66,7 @@ public interface IPublicClientApplication extends IClientApplicationBase {
      * @param parameters#deviceCodeConsumer
      * @return A {@link CompletableFuture} object representing the {@link IAuthenticationResult} of the call.
      * It contains AccessTokenCacheEntity, Refresh Token and the Access Token's expiration time.
-     * @throws AuthenticationException thrown if authorization is pending or another error occurred.
+     * @throws MsalException thrown if authorization is pending or another error occurred.
      *                                 If the errorCode of the exception is AuthenticationErrorCode.AUTHORIZATION_PENDING,
      *                                 the call needs to be retried until the AccessToken is returned.
      *                                 DeviceCode.interval - The minimum amount of time in seconds that the client