OAuth2Exception 25.11.0 API

All Implemented Interfaces:

java.io.Serializable
```
public class OAuth2Exception
extends IOException
                    
```
Indicates a OAuth2 error response during the authorization.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public String`	`code`
`public String`	`description`
`public String`	`uri`
`public String`	`state`

Constructor Summary

Constructors
Constructor	Description
`OAuth2Exception(String code, String description, String uri, String state)`	Creates a OAuth2Exception with the specified error information.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getCode()`	The error code as specified by the error parameter in the OAuth error response.
`String`	`getDescription()`	Text providing additional information about the error that occurred.
`String`	`getUri()`	A URI identifying a human-readable web page with information about the error.
`String`	`getState()`	The state parameter that was present in the client authorization request.

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OAuth2Exception
```
OAuth2Exception(String code, String description, String uri, String state)
```
    Creates a OAuth2Exception with the specified error information.
    
    Parameters:
    
    code - The error code.
    
    description - The error description.
    
    uri - The error URI.
    
    state - The state for the authorization request.
- Method Detail
  - getCode
```
@NonNull() String getCode()
```
    The error code as specified by the error parameter in the OAuth error response.
    
    Returns:
    
    The error code.
  - getDescription
```
@Nullable() String getDescription()
```
    Text providing additional information about the error that occurred. This field maps to the error_description parameter in the returned OAuth error response.
    
    Returns:
    
    The error description.
  - getUri
```
@Nullable() String getUri()
```
    A URI identifying a human-readable web page with information about the error. This field maps to the error_uri parameter in the returned OAuth error response.
    
    Returns:
    
    The URI.
  - getState
```
@Nullable() String getState()
```
    The state parameter that was present in the client authorization request.
    
    Returns:
    
    The state parameter.