com.microsoft.aad.msal4j

Class MsalServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.microsoft.aad.msal4j.MsalException

com.microsoft.aad.msal4j.MsalServiceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MsalInteractionRequiredException, MsalThrottlingException

public class MsalServiceException
extends MsalException

Exception type thrown when service returns an error response or other networking errors occur.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MsalServiceException(com.microsoft.aad.msal4j.AadInstanceDiscoveryResponse discoveryResponse) Initializes a new instance of the exception class
MsalServiceException(com.microsoft.aad.msal4j.ErrorResponse errorResponse, Map<String,List<String>> httpHeaders) Initializes a new instance of the exception class
MsalServiceException(String message, String error) Initializes a new instance of the exception class with a specified error message
MsalServiceException(String message, String error, com.microsoft.aad.msal4j.ManagedIdentitySourceType managedIdentitySource) Initializes a new instance of the exception class, with any extra properties for a Managed Identity error

Method Summary

Modifier and Type	Method and Description
String	claims() Claims included in the claims challenge
String	correlationId() An ID that can be used to piece up a single authentication flow.
Map<String,List<String>>	headers() Contains the http headers from the server response that indicated an error.
String	managedIdentitySource()
Integer	statusCode() Status code returned from http layer
String	statusMessage() Status message returned from the http layer

Methods inherited from class com.microsoft.aad.msal4j.MsalException

errorCode

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MsalServiceException

public MsalServiceException(String message,
                            String error)

Initializes a new instance of the exception class with a specified error message

Parameters:

message - the error message that explains the reason for the exception

error - a simplified error code from AuthenticationErrorCode and used for references in documentation

MsalServiceException

public MsalServiceException(com.microsoft.aad.msal4j.ErrorResponse errorResponse,
                            Map<String,List<String>> httpHeaders)

Initializes a new instance of the exception class

Parameters:

errorResponse - response object contain information about error returned by server

httpHeaders - http headers from the server response

MsalServiceException

public MsalServiceException(String message,
                            String error,
                            com.microsoft.aad.msal4j.ManagedIdentitySourceType managedIdentitySource)

Initializes a new instance of the exception class, with any extra properties for a Managed Identity error

Parameters:

message - the error message that explains the reason for the exception

managedIdentitySource - the Managed Identity service

MsalServiceException

public MsalServiceException(com.microsoft.aad.msal4j.AadInstanceDiscoveryResponse discoveryResponse)

Initializes a new instance of the exception class

Parameters:

discoveryResponse - response object from instance discovery network call

Method Detail

statusCode

public Integer statusCode()

Status code returned from http layer

statusMessage

public String statusMessage()

Status message returned from the http layer

correlationId

public String correlationId()

An ID that can be used to piece up a single authentication flow.

claims

public String claims()

Claims included in the claims challenge

headers

public Map<String,List<String>> headers()

Contains the http headers from the server response that indicated an error. When the server returns a 429 Too Many Requests error, a Retry-After should be set. It is important to read and respect the time specified in the Retry-After header

managedIdentitySource

public String managedIdentitySource()