AuthState (AppAuth)

java.lang.Object
- net.openid.appauth.AuthState

```
public class AuthState
extends Object
```
Collects authorization state from authorization requests and responses. This facilitates the creation of subsequent requests based on this state, and allows for this state to be persisted easily.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AuthState.AuthStateAction
Interface for actions executed in the context of fresh (non-expired) tokens.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AuthState.AuthStateAction` Interface for actions executed in the context of fresh (non-expired) tokens.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EXPIRY_TIME_TOLERANCE_MS` Tokens which have less time than this value left before expiry will be considered to be expired for the purposes of calls to `performActionWithFreshTokens`.

Constructor Summary

Constructors
Constructor and Description
`AuthState()` Creates an empty, unauthenticated `AuthState`.
`AuthState(AuthorizationResponse authResponse, Exception authError)` Creates an `AuthState` based on an authorization exchange.
`AuthState(AuthorizationResponse authResponse, TokenResponse tokenResponse)` Creates an `AuthState` based on an authorization exchange and subsequent token exchange.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TokenRequest`	`createTokenRefreshRequest()` Creates a token request for new tokens using the current refresh token.
`TokenRequest`	`createTokenRefreshRequest(Map<String,String> additionalParameters)` Creates a token request for new tokens using the current refresh token, adding the specified additional parameters.
`static AuthState`	`fromJson(JSONObject json)` Restores authorization state from JSON produced by `toJson()`.
`static AuthState`	`fromJson(String jsonStr)` Restored authorization state from a JSON string produced by `toJsonString()`.
`String`	`getAccessToken()` The current access token, if available.
`Long`	`getAccessTokenExpirationTime()` The expiration time of the current access token (if available), as milliseconds from the UNIX epoch (consistent with `System.currentTimeMillis()`).
`AuthorizationServiceConfiguration`	`getAuthorizationServiceConfiguration()` The configuration of the authorization service associated with this authorization state.
`String`	`getIdToken()` The current ID token, if available.
`AuthorizationResponse`	`getLastAuthorizationResponse()` The most recent authorization response used to update the authorization state.
`TokenResponse`	`getLastTokenResponse()` The most recent token response used to update this authorization state.
`boolean`	`getNeedsTokenRefresh()` Determines whether the access token is considered to have expired.
`String`	`getRefreshToken()` The most recent refresh token received from the server, if available.
`String`	`getScope()` The scope of the current authorization grant.
`Set<String>`	`getScopeSet()` A set representation of `getScope()`, for convenience.
`boolean`	`isAuthorized()` Determines whether the current state represents a successful authorization, from which at least either an access token or an ID token have been retrieved.
`void`	`performActionWithFreshTokens(AuthorizationService service, AuthState.AuthStateAction action)` Ensures that a non-expired access token is available before invoking the provided action.
`void`	`performActionWithFreshTokens(AuthorizationService service, Map<String,String> refreshTokenAdditionalParams, AuthState.AuthStateAction action)` Ensures that a non-expired access token is available before invoking the provided action.
`void`	`setNeedsTokenRefresh(boolean needsTokenRefresh)` Sets whether to force an access token refresh, irrespective of the expiration time.
`JSONObject`	`toJson()` Converts the authorization state to a JSON object for storage or transmission.
`String`	`toJsonString()` Converts the authorization state to a JSON string for storage or transmission.
`void`	`update(AuthorizationResponse authResponse, Exception authError)` Updates the authorization state based on a new authorization response.
`void`	`update(TokenResponse tokenResponse, Exception authError)` Updates the authorization state based on a new token response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXPIRY_TIME_TOLERANCE_MS
```
public static final int EXPIRY_TIME_TOLERANCE_MS
```
    Tokens which have less time than this value left before expiry will be considered to be expired for the purposes of calls to performActionWithFreshTokens.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AuthState
```
public AuthState()
```
    Creates an empty, unauthenticated AuthState.
  - AuthState
```
public AuthState(@Nullable
                 AuthorizationResponse authResponse,
                 @Nullable
                 Exception authError)
```
    Creates an AuthState based on an authorization exchange.
  - AuthState
```
public AuthState(@NonNull
                 AuthorizationResponse authResponse,
                 @NonNull
                 TokenResponse tokenResponse)
```
    Creates an AuthState based on an authorization exchange and subsequent token exchange.
- Method Detail
  - getRefreshToken
```
@Nullable
public String getRefreshToken()
```
    The most recent refresh token received from the server, if available. Rather than using this property directly as part of any request depending on authorization state, it is recommended to call performActionWithFreshTokens to ensure that fresh tokens are available.
  - getScope
```
@Nullable
public String getScope()
```
    The scope of the current authorization grant. This represents the latest scope returned by the server and may be a subset of the scope that was initially granted.
  - getScopeSet
```
@Nullable
public Set<String> getScopeSet()
```
    A set representation of getScope(), for convenience.
  - getLastAuthorizationResponse
```
@Nullable
public AuthorizationResponse getLastAuthorizationResponse()
```
    The most recent authorization response used to update the authorization state. For the implicit flow, this will contain the latest access token. It is rarely necessary to directly use the response; instead convenience methods are provided to retrieve the access token, access token expiration, ID token and scope regardless of the flow used to retrieve them.
  - getLastTokenResponse
```
@Nullable
public TokenResponse getLastTokenResponse()
```
    The most recent token response used to update this authorization state. For the authorization code flow, this will contain the latest access token. It is rarely necessary to directly use the response; instead convenience methods are provided to retrieve the access token, access token expiration, ID token and scope regardless of the flow used to retrieve them.
  - getAuthorizationServiceConfiguration
```
@Nullable
public AuthorizationServiceConfiguration getAuthorizationServiceConfiguration()
```
    The configuration of the authorization service associated with this authorization state.
  - getAccessToken
```
@Nullable
public String getAccessToken()
```
    The current access token, if available. Rather than using this property directly as part of any request depending on authorization state, it s recommended to call performActionWithFreshTokens to ensure that fresh tokens are available.
  - getAccessTokenExpirationTime
```
@Nullable
public Long getAccessTokenExpirationTime()
```
    The expiration time of the current access token (if available), as milliseconds from the UNIX epoch (consistent with System.currentTimeMillis()).
  - getIdToken
```
@Nullable
public String getIdToken()
```
    The current ID token, if available.
  - isAuthorized
```
public boolean isAuthorized()
```
    Determines whether the current state represents a successful authorization, from which at least either an access token or an ID token have been retrieved.
  - getNeedsTokenRefresh
```
public boolean getNeedsTokenRefresh()
```
    Determines whether the access token is considered to have expired.
  - setNeedsTokenRefresh
```
public void setNeedsTokenRefresh(boolean needsTokenRefresh)
```
    Sets whether to force an access token refresh, irrespective of the expiration time.
  - update
```
public void update(@Nullable
                   AuthorizationResponse authResponse,
                   @Nullable
                   Exception authError)
```
    Updates the authorization state based on a new authorization response.
  - update
```
public void update(@Nullable
                   TokenResponse tokenResponse,
                   @Nullable
                   Exception authError)
```
    Updates the authorization state based on a new token response.
  - performActionWithFreshTokens
```
public void performActionWithFreshTokens(@NonNull
                                         AuthorizationService service,
                                         @NonNull
                                         AuthState.AuthStateAction action)
```
    Ensures that a non-expired access token is available before invoking the provided action.
  - performActionWithFreshTokens
```
public void performActionWithFreshTokens(@NonNull
                                         AuthorizationService service,
                                         @NonNull
                                         Map<String,String> refreshTokenAdditionalParams,
                                         @NonNull
                                         AuthState.AuthStateAction action)
```
    Ensures that a non-expired access token is available before invoking the provided action. If a token refresh is required, the provided additional parameters will be included in this refresh request.
  - createTokenRefreshRequest
```
public TokenRequest createTokenRefreshRequest()
```
    Creates a token request for new tokens using the current refresh token.
  - createTokenRefreshRequest
```
public TokenRequest createTokenRefreshRequest(@NonNull
                                              Map<String,String> additionalParameters)
```
    Creates a token request for new tokens using the current refresh token, adding the specified additional parameters.
  - toJson
```
public JSONObject toJson()
```
    Converts the authorization state to a JSON object for storage or transmission.
  - toJsonString
```
public String toJsonString()
```
    Converts the authorization state to a JSON string for storage or transmission.
  - fromJson
```
public static AuthState fromJson(@NonNull
                                 JSONObject json)
                          throws JSONException
```
    Restores authorization state from JSON produced by toJson().
    
    Throws:
    
    JSONException - if the JSON is malformed or missing required fields.
  - fromJson
```
public static AuthState fromJson(@NonNull
                                 String jsonStr)
                          throws JSONException
```
    Restored authorization state from a JSON string produced by toJsonString().
    
    Throws:
    
    JSONException - if the JSON is malformed or missing required fields.

Class AuthState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXPIRY_TIME_TOLERANCE_MS

Constructor Detail

AuthState

AuthState

AuthState

Method Detail

getRefreshToken

getScope

getScopeSet

getLastAuthorizationResponse

getLastTokenResponse

getAuthorizationServiceConfiguration

getAccessToken

getAccessTokenExpirationTime

getIdToken

isAuthorized

getNeedsTokenRefresh

setNeedsTokenRefresh

update

update

performActionWithFreshTokens

performActionWithFreshTokens

createTokenRefreshRequest

createTokenRefreshRequest

toJson

toJsonString

fromJson

fromJson