com.microsoft.identity.client.exception

Class MsalClientException

java.lang.Object

BaseException

com.microsoft.identity.client.exception.MsalException

com.microsoft.identity.client.exception.MsalClientException

public final class MsalClientException
extends MsalException

This exception class represents general errors that are local to the library. Below is the table of proposed codes and a short description of each.

Set of error codes that could be returned from this exception:

• multiple_matching_tokens_detected: There are multiple cache entries found and the sdk cannot identify the correct access or refresh token from the cache. This usually indicates a bug in the sdk for storing tokens or the authority is not provided in the silent request and multiple matching tokens found.
• device_network_not_available: No active network is available on the device.
• json_parse_failure: The sdk failed to parse the JSON format.
• io_error: IOException happened, could be the device/network errors.
• malformed_url: The url is malformed. Likely caused when constructing the auth request, authority, or redirect URI.
• unsupported_encoding: The encoding is not supported by the device.
• no_such_algorithm: The algorithm used to generate pkce challenge is not supported.
• invalid_jwt: JWT returned by the server is not valid, empty or malformed.
• state_mismatch: State from authorization response did not match the state in the authorization request. For authorization requests, the sdk will verify the state returned from redirect and the one sent in the request.
• unsupported_url: Unsupported url, cannot perform ADFS authority validation.
• authority_validation_not_supported: The authority is not supported for authority validation. The sdk supports b2c authorities, but doesn't support b2c authority validation. Only well-known host will be supported.
• chrome_not_installed: Chrome is not installed on the device. The sdk uses chrome custom tab for authorization requests if available, and will fall back to chrome browser.
• user_mismatch: The user provided in the acquire token request doesn't match the user returned from server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_MANIFEST_VALIDATION_ERROR Developer error.
static java.lang.String	AUTHORITY_VALIDATION_NOT_SUPPORTED The authority is not supported for authority validation.
static java.lang.String	BROKER_BIND_FAILURE Failed to bind the service in broker app.
static java.lang.String	BROKER_NOT_INSTALLED Broker app is not installed.
static java.lang.String	CHROME_NOT_INSTALLED Note: after MSAL 0.2.0 this error is no longer relevant.
static java.lang.String	CURRENT_ACCOUNT_MISMATCH The account that is being signed in does not match with the provided account.
static java.lang.String	CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE
static java.lang.String	DEVICE_NETWORK_NOT_AVAILABLE No active network is available on the device.
static java.lang.String	DUPLICATE_COMMAND Duplicate command.
static java.lang.String	DUPLICATE_QUERY_PARAMETER Extra query parameters set by the client app is already sent by the sdk.
static java.lang.String	INVALID_JWT JWT returned by the server is not valid, empty or malformed.
static java.lang.String	INVALID_PARAMETER The parameter provided by the user is invalid.
static java.lang.String	IO_ERROR IOException happened, could be the device/network errors.
static java.lang.String	JSON_PARSE_FAILURE The sdk failed to parse the Json format.
static java.lang.String	MALFORMED_URL The url is malformed.
static java.lang.String	MULTIPLE_MATCHING_TOKENS_DETECTED There are multiple cache entries found, the sdk cannot pick the correct access token or refresh token from the cache.
static java.lang.String	NO_CURRENT_ACCOUNT No account currently signed in to SingleAccountPublicClientApplication
static java.lang.String	NO_CURRENT_ACCOUNT_ERROR_MESSAGE
static java.lang.String	NO_SUCH_ALGORITHM The algorithm used to generate pkce challenge is not supported.
static java.lang.String	NOT_ELIGIBLE_TO_USE_BROKER Not eligible to use Broker.
static java.lang.String	REDIRECT_URI_VALIDATION_ERROR Developer error.
static java.lang.String	SCOPE_EMPTY_OR_NULL A scope is required when making a token request
static java.lang.String	STATE_MISMATCH State from authorization response did not match the state in the authorization request.
static java.lang.String	UNKNOWN_AUTHORITY The authority is unknown.
static java.lang.String	UNKNOWN_ERROR Extra query parameters set by the client app is already sent by the sdk.
static java.lang.String	UNSUPPORTED_ENCODING The encoding is not supported by the device.
static java.lang.String	UNSUPPORTED_URL Unsupported url, cannot perform adfs authority validation.
static java.lang.String	USER_MISMATCH The user provided in the acquire token request doesn't match the user returned from server.

Constructor Summary

Constructors

Constructor and Description
MsalClientException(java.lang.String errorCode)
MsalClientException(java.lang.String errorCode, java.lang.String errorMessage)
MsalClientException(java.lang.String errorCode, java.lang.String errorMessage, java.lang.Throwable throwable)

Method Summary

Methods inherited from class com.microsoft.identity.client.exception.MsalException

getErrorCode, getMessage

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_PARAMETER

public static final java.lang.String INVALID_PARAMETER

The parameter provided by the user is invalid.

See Also:

Constant Field Values

MULTIPLE_MATCHING_TOKENS_DETECTED

public static final java.lang.String MULTIPLE_MATCHING_TOKENS_DETECTED

There are multiple cache entries found, the sdk cannot pick the correct access token or refresh token from the cache. Likely it's a bug in the sdk when caching tokens or authority is not proviced in the silent request and multiple tokens were found.

DEVICE_NETWORK_NOT_AVAILABLE

public static final java.lang.String DEVICE_NETWORK_NOT_AVAILABLE

No active network is available on the device.

SCOPE_EMPTY_OR_NULL

public static final java.lang.String SCOPE_EMPTY_OR_NULL

A scope is required when making a token request

JSON_PARSE_FAILURE

public static final java.lang.String JSON_PARSE_FAILURE

The sdk failed to parse the Json format.

IO_ERROR

public static final java.lang.String IO_ERROR

IOException happened, could be the device/network errors.

MALFORMED_URL

public static final java.lang.String MALFORMED_URL

The url is malformed. Likely caused when constructing the auth request, authority, or redirect URI.

UNKNOWN_AUTHORITY

public static final java.lang.String UNKNOWN_AUTHORITY

The authority is unknown. Occurs when the authority is not part of configuration or the authority host is not recognized by Microsoft.

UNSUPPORTED_ENCODING

public static final java.lang.String UNSUPPORTED_ENCODING

The encoding is not supported by the device.

NO_SUCH_ALGORITHM

public static final java.lang.String NO_SUCH_ALGORITHM

The algorithm used to generate pkce challenge is not supported.

INVALID_JWT

public static final java.lang.String INVALID_JWT

JWT returned by the server is not valid, empty or malformed.

STATE_MISMATCH

public static final java.lang.String STATE_MISMATCH

State from authorization response did not match the state in the authorization request. For authorization requests, the sdk will verify the state returned from redirect and the one sent in the request.

UNSUPPORTED_URL

public static final java.lang.String UNSUPPORTED_URL

Unsupported url, cannot perform adfs authority validation.

AUTHORITY_VALIDATION_NOT_SUPPORTED

public static final java.lang.String AUTHORITY_VALIDATION_NOT_SUPPORTED

The authority is not supported for authority validation. The sdk supports b2c authority, but we don't support b2c authority validation yet. Only well-known host will be supported.

CHROME_NOT_INSTALLED

public static final java.lang.String CHROME_NOT_INSTALLED

Note: after MSAL 0.2.0 this error is no longer relevant. chrome_not_installed: Chrome is not installed on the device. The sdk uses chrome custom tab for authorization requests if available, and will fall back to chrome browser.

See Also:

Constant Field Values

USER_MISMATCH

public static final java.lang.String USER_MISMATCH

The user provided in the acquire token request doesn't match the user returned from server.

DUPLICATE_QUERY_PARAMETER

public static final java.lang.String DUPLICATE_QUERY_PARAMETER

Extra query parameters set by the client app is already sent by the sdk.

BROKER_BIND_FAILURE

public static final java.lang.String BROKER_BIND_FAILURE

Failed to bind the service in broker app.

UNKNOWN_ERROR

public static final java.lang.String UNKNOWN_ERROR

Extra query parameters set by the client app is already sent by the sdk.

BROKER_NOT_INSTALLED

public static final java.lang.String BROKER_NOT_INSTALLED

Broker app is not installed.

See Also:

Constant Field Values

NOT_ELIGIBLE_TO_USE_BROKER

public static final java.lang.String NOT_ELIGIBLE_TO_USE_BROKER

Not eligible to use Broker.

See Also:

Constant Field Values

NO_CURRENT_ACCOUNT

public static final java.lang.String NO_CURRENT_ACCOUNT

No account currently signed in to SingleAccountPublicClientApplication

See Also:

Constant Field Values

NO_CURRENT_ACCOUNT_ERROR_MESSAGE

public static final java.lang.String NO_CURRENT_ACCOUNT_ERROR_MESSAGE

See Also:

Constant Field Values

CURRENT_ACCOUNT_MISMATCH

public static final java.lang.String CURRENT_ACCOUNT_MISMATCH

The account that is being signed in does not match with the provided account.

See Also:

Constant Field Values

CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE

public static final java.lang.String CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE

See Also:

Constant Field Values

DUPLICATE_COMMAND

public static final java.lang.String DUPLICATE_COMMAND

Duplicate command. The same command is already be processed.

See Also:

Constant Field Values

APP_MANIFEST_VALIDATION_ERROR

public static final java.lang.String APP_MANIFEST_VALIDATION_ERROR

Developer error. Application manifest is not properly configured to support MSAL.

See Also:

Constant Field Values

REDIRECT_URI_VALIDATION_ERROR

public static final java.lang.String REDIRECT_URI_VALIDATION_ERROR

Developer error. The redirect URI in the configuration file doesn't match with the one generated with package name and signature hash.

See Also:

Constant Field Values

Constructor Detail

MsalClientException

public MsalClientException(java.lang.String errorCode)

MsalClientException

public MsalClientException(java.lang.String errorCode,
                           java.lang.String errorMessage)

MsalClientException

public MsalClientException(java.lang.String errorCode,
                           java.lang.String errorMessage,
                           java.lang.Throwable throwable)