148 строки
10 KiB
YAML
148 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
constructors:
|
|
- fullName: com.microsoft.identity.client.exception.MsalServiceException.MsalServiceException(final String errorCode, final String errorMessage, final int httpStatusCode, final Throwable throwable)
|
|
name: MsalServiceException(final String errorCode, final String errorMessage, final int httpStatusCode, final Throwable throwable)
|
|
nameWithType: MsalServiceException.MsalServiceException(final String errorCode, final String errorMessage, final int httpStatusCode, final Throwable throwable)
|
|
parameters:
|
|
- name: errorCode
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
- name: errorMessage
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
- name: httpStatusCode
|
|
type: <xref href="final+int?alt=final+int&text=final+int" data-throw-if-not-resolved="False"/>
|
|
- name: throwable
|
|
type: <xref href="final+Throwable?alt=final+Throwable&text=final+Throwable" data-throw-if-not-resolved="False"/>
|
|
syntax: public MsalServiceException(final String errorCode, final String errorMessage, final int httpStatusCode, final Throwable throwable)
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.MsalServiceException(final String,final String,final int,final Throwable)
|
|
- fullName: com.microsoft.identity.client.exception.MsalServiceException.MsalServiceException(final String errorCode, final String errorMessage, final Throwable throwable)
|
|
name: MsalServiceException(final String errorCode, final String errorMessage, final Throwable throwable)
|
|
nameWithType: MsalServiceException.MsalServiceException(final String errorCode, final String errorMessage, final Throwable throwable)
|
|
parameters:
|
|
- name: errorCode
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
- name: errorMessage
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
- name: throwable
|
|
type: <xref href="final+Throwable?alt=final+Throwable&text=final+Throwable" data-throw-if-not-resolved="False"/>
|
|
syntax: public MsalServiceException(final String errorCode, final String errorMessage, final Throwable throwable)
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.MsalServiceException(final String,final String,final Throwable)
|
|
fields:
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.ACCESS_DENIED
|
|
name: ACCESS_DENIED
|
|
nameWithType: MsalServiceException.ACCESS_DENIED
|
|
summary: <p>The resource owner or authorization server denied the request. </p>
|
|
syntax: public static final String ACCESS_DENIED= ServiceException.ACCESS_DENIED
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.ACCESS_DENIED
|
|
- field:
|
|
type: <xref href="final+int?alt=final+int&text=final+int" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.DEFAULT_STATUS_CODE
|
|
name: DEFAULT_STATUS_CODE
|
|
nameWithType: MsalServiceException.DEFAULT_STATUS_CODE
|
|
summary: <p>When <xref uid="" data-throw-if-not-resolved="false" data-raw-source="java.net.SocketTimeoutException"></xref> is thrown, no status code will be caught. Will use 0 instead. </p>
|
|
syntax: public static final int DEFAULT_STATUS_CODE= 0
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.DEFAULT_STATUS_CODE
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.INVALID_INSTANCE
|
|
name: INVALID_INSTANCE
|
|
nameWithType: MsalServiceException.INVALID_INSTANCE
|
|
summary: <p>AuthorityMetadata validation failed. </p>
|
|
syntax: public static final String INVALID_INSTANCE= ServiceException.INVALID_INSTANCE
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.INVALID_INSTANCE
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.INVALID_REQUEST
|
|
name: INVALID_REQUEST
|
|
nameWithType: MsalServiceException.INVALID_REQUEST
|
|
summary: <p>This request is missing a required parameter, includes an invalid parameter, includes a parameter more than once, or is otherwise malformed. </p>
|
|
syntax: public static final String INVALID_REQUEST= ServiceException.INVALID_REQUEST
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.INVALID_REQUEST
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.INVALID_SCOPE
|
|
name: INVALID_SCOPE
|
|
nameWithType: MsalServiceException.INVALID_SCOPE
|
|
summary: <p>The request scope is invalid, unknown or malformed. </p>
|
|
syntax: public static final String INVALID_SCOPE= ServiceException.INVALID_SCOPE
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.INVALID_SCOPE
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.REQUEST_TIMEOUT
|
|
name: REQUEST_TIMEOUT
|
|
nameWithType: MsalServiceException.REQUEST_TIMEOUT
|
|
summary: <p>Represents <xref uid="" data-throw-if-not-resolved="false" data-raw-source="java.net.SocketTimeoutException"></xref>. </p>
|
|
syntax: public static final String REQUEST_TIMEOUT= ServiceException.REQUEST_TIMEOUT
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.REQUEST_TIMEOUT
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.SERVICE_NOT_AVAILABLE
|
|
name: SERVICE_NOT_AVAILABLE
|
|
nameWithType: MsalServiceException.SERVICE_NOT_AVAILABLE
|
|
summary: <p>Represents 500/503/504 error codes. </p>
|
|
syntax: public static final String SERVICE_NOT_AVAILABLE= ServiceException.SERVICE_NOT_AVAILABLE
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.SERVICE_NOT_AVAILABLE
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.UNAUTHORIZED_CLIENT
|
|
name: UNAUTHORIZED_CLIENT
|
|
nameWithType: MsalServiceException.UNAUTHORIZED_CLIENT
|
|
summary: <p>The client is not authorized to request an authorization code. </p>
|
|
syntax: public static final String UNAUTHORIZED_CLIENT= ServiceException.UNAUTHORIZED_CLIENT
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.UNAUTHORIZED_CLIENT
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException.UNKNOWN_ERROR
|
|
name: UNKNOWN_ERROR
|
|
nameWithType: MsalServiceException.UNKNOWN_ERROR
|
|
summary: <p>Request to server failed, but no error and error_description is returned back from the service. </p>
|
|
syntax: public static final String UNKNOWN_ERROR= ServiceException.UNKNOWN_ERROR
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.UNKNOWN_ERROR
|
|
inheritances:
|
|
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
|
- <xref href="BaseException" data-throw-if-not-resolved="False"/>
|
|
- <xref href="com.microsoft.identity.client.exception.MsalException?alt=com.microsoft.identity.client.exception.MsalException&text=MsalException" data-throw-if-not-resolved="False"/>
|
|
inheritedMembers:
|
|
- com.microsoft.identity.client.exception.MsalException.getErrorCode()
|
|
- com.microsoft.identity.client.exception.MsalException.getMessage()
|
|
methods:
|
|
- fullName: com.microsoft.identity.client.exception.MsalServiceException.getHttpStatusCode()
|
|
name: getHttpStatusCode()
|
|
nameWithType: MsalServiceException.getHttpStatusCode()
|
|
returns:
|
|
description: <p>The http status code for the request sent to the service. </p>
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
syntax: public int getHttpStatusCode()
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException.getHttpStatusCode()
|
|
nameWithType: MsalServiceException
|
|
syntax: public class MsalServiceException extends MsalException
|
|
type: class
|
|
uid: com.microsoft.identity.client.exception.MsalServiceException
|
|
fullName: com.microsoft.identity.client.exception.MsalServiceException
|
|
name: MsalServiceException
|
|
package: com.microsoft.identity.client.exception
|
|
summary: >-
|
|
<p>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. </p>
|
|
|
|
<p>Set of error codes that could be returned from this exception: <ul><li><p>invalid_request: This request is missing a required parameter, includes an invalid parameter, includes a parameter more than once, or is otherwise malformed. </p></li><li><p>unauthorized_client: The client is not authorized to request an authorization code. </p></li><li><p>access_denied: The resource owner or authorization server denied the request. </p></li><li><p>invalid_scope: The request scope is invalid, unknown or malformed. </p></li><li><p>service_not_available: Represents 500/503/504 error codes. </p></li><li><p>request_timeout: Represents <xref uid="" data-throw-if-not-resolved="false" data-raw-source="java.net.SocketTimeoutException"></xref>. </p></li><li><p>invalid_instance: AuthorityMetadata validation failed. </p></li><li><p>unknown_error: Request to server failed, but no error and error_description was returned from the service. </p></li></ul></p>
|
|
|
|
<p>Note: <xref uid="com.microsoft.identity.client.exception.MsalServiceException" data-throw-if-not-resolved="false" data-raw-source="MsalServiceException"></xref> provides one extra API: </p>
|
|
|
|
<p>
|
|
|
|
<ul>
|
|
|
|
<li>
|
|
|
|
<p>
|
|
|
|
<xref uid="com.microsoft.identity.client.exception.MsalServiceException.getHttpStatusCode()" data-throw-if-not-resolved="false" data-raw-source="MsalServiceException#getHttpStatusCode()"></xref> : indicates the http status code for the failed request. </p>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</p>
|
|
metadata: {}
|