com.microsoft.identity.client.exception

Class MsalServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.microsoft.identity.client.exception.MsalException

com.microsoft.identity.client.exception.MsalServiceException

All Implemented Interfaces:

java.io.Serializable

public final class MsalServiceException
extends MsalException

This exception class represents errors when communicating to the service, can be from the authorize or token endpoints. MSAL reads the error and error_description from the server response. Generally, these errors are resolved by fixing app configurations either in code or in the app registration portal.

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

• invalid_request: This request is missing a required parameter, includes an invalid parameter, includes a parameter more than once, or is otherwise malformed.
• unauthorized_client: The client is not authorized to request an authorization code.
• access_denied: The resource owner or authorization server denied the request.
• invalid_scope: The request scope is invalid, unknown or malformed.
• service_not_available: Represents 500/503/504 error codes.
• request_timeout: Represents SocketTimeoutException.
• invalid_instance: AuthorityMetadata validation failed.
• unknown_error: Request to server failed, but no error and error_description was returned from the service.

Note: MsalServiceException provides one extra API:

• getHttpStatusCode() : indicates the http status code for the failed request.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_DENIED The resource owner or authorization server denied the request.
static int	DEFAULT_STATUS_CODE When SocketTimeoutException is thrown, no status code will be caught.
static java.lang.String	INVALID_INSTANCE AuthorityMetadata validation failed.
static java.lang.String	INVALID_REQUEST This request is missing a required parameter, includes an invalid parameter, includes a parameter more than once, or is otherwise malformed.
static java.lang.String	INVALID_SCOPE The request scope is invalid, unknown or malformed.
static java.lang.String	REQUEST_TIMEOUT Represents SocketTimeoutException.
static java.lang.String	SERVICE_NOT_AVAILABLE Represents 500/503/504 error codes.
static java.lang.String	UNAUTHORIZED_CLIENT The client is not authorized to request an authorization code.
static java.lang.String	UNKNOWN_ERROR Request to server failed, but no error and error_description is returned back from the service.

Constructor Summary

Constructors

Constructor and Description
MsalServiceException(java.lang.String errorCode, java.lang.String errorMessage, int httpStatusCode, java.lang.Throwable throwable)
MsalServiceException(java.lang.String errorCode, java.lang.String errorMessage, java.lang.Throwable throwable)

Method Summary

Modifier and Type	Method and Description
int	getHttpStatusCode()

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

getErrorCode, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_REQUEST

public static final java.lang.String INVALID_REQUEST

This request is missing a required parameter, includes an invalid parameter, includes a parameter more than once, or is otherwise malformed.

See Also:

Constant Field Values

UNAUTHORIZED_CLIENT

public static final java.lang.String UNAUTHORIZED_CLIENT

The client is not authorized to request an authorization code.

See Also:

Constant Field Values

ACCESS_DENIED

public static final java.lang.String ACCESS_DENIED

The resource owner or authorization server denied the request.

See Also:

Constant Field Values

INVALID_SCOPE

public static final java.lang.String INVALID_SCOPE

The request scope is invalid, unknown or malformed.

See Also:

Constant Field Values

SERVICE_NOT_AVAILABLE

public static final java.lang.String SERVICE_NOT_AVAILABLE

Represents 500/503/504 error codes.

See Also:

Constant Field Values

REQUEST_TIMEOUT

public static final java.lang.String REQUEST_TIMEOUT

Represents SocketTimeoutException.

See Also:

Constant Field Values

INVALID_INSTANCE

public static final java.lang.String INVALID_INSTANCE

AuthorityMetadata validation failed.

See Also:

Constant Field Values

UNKNOWN_ERROR

public static final java.lang.String UNKNOWN_ERROR

Request to server failed, but no error and error_description is returned back from the service.

See Also:

Constant Field Values

DEFAULT_STATUS_CODE

public static final int DEFAULT_STATUS_CODE

When SocketTimeoutException is thrown, no status code will be caught. Will use 0 instead.

See Also:

Constant Field Values

Constructor Detail

MsalServiceException

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

MsalServiceException

public MsalServiceException(java.lang.String errorCode,
                            java.lang.String errorMessage,
                            int httpStatusCode,
                            java.lang.Throwable throwable)

Method Detail

getHttpStatusCode

public int getHttpStatusCode()

Returns:

The http status code for the request sent to the service.