Uses of Class
org.forgerock.oauth.OAuthException

Packages that use OAuthException

Package	Description
org.forgerock.oauth	Commons OAuth Framework API.
org.forgerock.oauth.clients.apple	Forgerock Apple Client implementation.
org.forgerock.oauth.clients.facebook	Forgerock Facebook Client Implementation.
org.forgerock.oauth.clients.linkedin	Forgerock LinkedIn Client Implementation.
org.forgerock.oauth.clients.oauth2	OAuth 2.0 ForgeRock Client Implementation.
org.forgerock.oauth.clients.oidc	OpenID Connect ForgeRock Client Implementation.

Uses of OAuthException in org.forgerock.oauth

Subclasses of OAuthException in org.forgerock.oauth

Modifier and Type	Class	Description
class	DataStoreException	Exception to be used when an error has occurred while interacting with the data store.
class	InvalidOAuthClientException	Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).
class	InvalidOAuthRequestException	Exception to be used when an OAuth Request cannot be handled due to known causes.
class	OAuthConfigException	Exception used when an error has occurred with an OAuth client's configuration.

Methods in org.forgerock.oauth that return types with arguments of type OAuthException

Modifier and Type	Method	Description
<V> Promise<V,OAuthException>	OAuthException.asPromise()	Return this OAuthException as a Promise.
Promise<URI,OAuthException>	OAuthClient.getAuthRedirect(DataStore dataStore, String data, URI landingPage)	Return the URI that the user agent should be redirected to, to authenticate and authorize access.
Promise<? extends SessionInfo,OAuthException>	OAuthClient.getSessionInfo(DataStore dataStore)	Validate whether an Auth Server session is still active and valid.
Promise<UserInfo,OAuthException>	OAuthClient.getUserInfo(DataStore dataStore)	Return the authenticated user's info from the external authentication server.
Promise<JsonValue,OAuthException>	OAuthClient.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)	Handle the data produced by the Auth Server as a result of a successful authentication and return the final redirect to the mobile device.
Promise<JsonValue,OAuthException>	OAuthClient.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)	Handle the data produced by the Auth Server as a result of a successful authentication and return the final redirect to the landing page specified in the OAuthClient.getAuthRedirect(DataStore, String, URI) call.
Promise<Void,OAuthException>	OAuthClient.refresh(DataStore dataStore)	Refreshes a token if it has expired.

Methods in org.forgerock.oauth that throw OAuthException

Modifier and Type	Method	Description
String	DataStore.getProvider()	Returns the provider that the associated DataStore implementation has been instantiated for.
JsonValue	UserInfo.getRawProfile()	Gets the user raw profile data without any modifications that was returned by the auth server.
String	UserInfo.getSubject()	The subject which identifies a user on a particular auth server.
JsonValue	DataStore.retrieveData()	Returns the stored data.
void	DataStore.storeData(JsonValue data)	Stores the data.

Uses of OAuthException in org.forgerock.oauth.clients.apple

Methods in org.forgerock.oauth.clients.apple that return types with arguments of type OAuthException

Modifier and Type	Method	Description
Promise<UserInfo,OAuthException>	AppleClient.getUserInfo(DataStore dataStore)
Promise<JsonValue,OAuthException>	AppleClient.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> requestParameters)
Promise<JsonValue,OAuthException>	AppleClient.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)

Uses of OAuthException in org.forgerock.oauth.clients.facebook

Methods in org.forgerock.oauth.clients.facebook that return types with arguments of type OAuthException

Modifier and Type	Method	Description
protected Promise<JsonValue,OAuthException>	FacebookClient.getAppAccessToken(Context context)	Retrieves the app access token from IDP.
protected AsyncFunction<JsonValue,JsonValue,OAuthException>	FacebookClient.getInputTokenInfo(Context context, String inputToken)	Retrieves the access token information as a JsonValue.
Promise<JsonValue,OAuthException>	FacebookClient.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
protected Function<JsonValue,JsonValue,OAuthException>	FacebookClient.validateClientId(DataStore dataStore, JsonValue storedData, String inputToken)

Methods in org.forgerock.oauth.clients.facebook that throw OAuthException

Modifier and Type	Method	Description
protected Promise<JsonValue,OAuthException>	FacebookClient.getAppAccessToken(Context context)	Retrieves the app access token from IDP.

Uses of OAuthException in org.forgerock.oauth.clients.linkedin

Methods in org.forgerock.oauth.clients.linkedin that return types with arguments of type OAuthException

Modifier and Type	Method	Description
Promise<UserInfo,OAuthException>	LinkedInClient.getUserInfo(DataStore dataStore)

Uses of OAuthException in org.forgerock.oauth.clients.oauth2

Fields in org.forgerock.oauth.clients.oauth2 with type parameters of type OAuthException

Modifier and Type	Field	Description
protected final Function<JsonValue,JsonValue,OAuthException>	OAuth2Client.addExpireTime	Adds the actual time the token expires.

Methods in org.forgerock.oauth.clients.oauth2 that return types with arguments of type OAuthException

Modifier and Type	Method	Description
protected final Function<Void,JsonValue,OAuthException>	OAuth2Client.createPostAuthResponse(JsonValue storedData)	Creates the post auth response.
protected Promise<JsonValue,OAuthException>	OAuth2Client.createPostResponse(DataStore dataStore, JsonValue storedData)	Creates the post response.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForIntrospectEndpoint(String accessToken)	Creates a Request for the introspect endpoint of an identity provider.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenEndpoint(String code)	Deprecated. Use OAuth2Client.createAuthRedirectUri(String, String) and specify a PKCE verifier.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenEndpoint(String code, String pkceVerifier)	Creates a Request for the token endpoint of an identity provider.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenRefresh(JsonValue storedData)	Creates a Request for the token refresh endpoint of an identity provider.
protected Promise<JsonValue,OAuthException>	OAuth2Client.getAccessTokenInfo(Context context, String accessToken)	Retrieves the access token information as a JsonValue.
Promise<URI,OAuthException>	OAuth2Client.getAuthRedirect(DataStore dataStore, String data, URI landingPage)
Promise<? extends OAuth2SessionInfo,OAuthException>	OAuth2Client.getSessionInfo(DataStore dataStore)
Promise<UserInfo,OAuthException>	OAuth2Client.getUserInfo(DataStore dataStore)
Promise<JsonValue,OAuthException>	OAuth2Client.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
Promise<JsonValue,OAuthException>	OAuth2Client.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)
protected static AsyncFunction<Response,JsonValue,OAuthException>	OAuth2Client.mapToJsonValue()	An AsyncFunction that handles a Response from an Auth Server that returns the HTTP entity content as JsonValue, and throws an OAuthException if the response is not successful (200 family status code), or if the content is not a valid JSON.
protected final Function<JsonValue,UserInfo,OAuthException>	OAuth2Client.mapToUserInfo()	Creates a OAuth2UserInfo using a users raw profile.
Promise<Void,OAuthException>	OAuth2Client.refresh(DataStore dataStore)
protected final Function<JsonValue,Void,OAuthException>	OAuth2Client.storeResponse(DataStore dataStore)	Stores all the information received from an authentication or authorization server.
protected static <T> Function<NoSuchSecretException,T,OAuthException>	OAuth2Client.throwIfNoClientSecret()	Handles a missing client secret.
protected Function<JsonValue,JsonValue,OAuthException>	OAuth2Client.validateClientId(DataStore dataStore, JsonValue storedData, String inputToken)	Compare client_id from access token associated data with configured client_id.

Methods in org.forgerock.oauth.clients.oauth2 that throw OAuthException

Modifier and Type	Method	Description
protected Promise<JsonValue,OAuthException>	OAuth2Client.createPostResponse(DataStore dataStore, JsonValue storedData)	Creates the post response.
protected static final String	OAuth2Client.getAccessToken(JsonValue data)	Retrieves an access token from a JsonValue.

Constructors in org.forgerock.oauth.clients.oauth2 that throw OAuthException

Modifier	Constructor	Description
protected	OAuth2SessionInfo(Clock clock, DataStore dataStore)	Constructs a OAuth2SessionInfo object.

Uses of OAuthException in org.forgerock.oauth.clients.oidc

Methods in org.forgerock.oauth.clients.oidc that return types with arguments of type OAuthException

Modifier and Type	Method	Description
Promise<URI,OAuthException>	OpenIDConnectClient.getAuthRedirect(DataStore dataStore, String data, URI landingPage)
Promise<? extends OAuth2SessionInfo,OAuthException>	OpenIDConnectClient.getSessionInfo(DataStore dataStore)
Promise<UserInfo,OAuthException>	OpenIDConnectClient.getUserInfo(DataStore dataStore)
Promise<JsonValue,OAuthException>	OpenIDConnectClient.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
Promise<JsonValue,OAuthException>	OpenIDConnectClient.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)
protected final Function<JsonValue,UserInfo,OAuthException>	OpenIDConnectClient.mapToUserInfo(JwtClaimsSet jwtClaims)	Maps a retrieved raw profile from the user info endpoint to an OpenIDConnectUserInfo object.
protected final Function<JsonValue,JsonValue,OAuthException>	OpenIDConnectClient.validateSub(DataStore dataStore)	Validates the sub Claim in the UserInfo Response is an exact match to the sub Claim in the ID Token.

Methods in org.forgerock.oauth.clients.oidc that throw OAuthException

Modifier and Type	Method	Description
protected URI	OpenIDConnectClient.createAuthRedirectUri(String state, String pkceChallenge, String nonce, DataStore dataStore)	Creates a URI that the user agent will be redirected to for authentication and authorization.
protected final UserInfo	OpenIDConnectClient.createUserInfoFromIdTokenJwtClaims(JwtClaimsSet jwtClaims)	Creates an OpenIDConnectUserInfo object from id_token jwt Claims.
protected final JwtClaimsSet	OpenIDConnectClient.getJwtClaimsSet(DataStore dataStore)	Retrieves the claims set from the data store.
protected static final JsonValue	OpenIDConnectClient.jwtClaimsAsJsonValue(JwtClaimsSet jwtClaims)	Returns the jwt claims as a JsonValue.

Constructors in org.forgerock.oauth.clients.oidc that throw OAuthException

Modifier	Constructor	Description
	OpenIDConnectSessionInfo(Clock clock, DataStore dataStore, JwtClaimsSet jwtClaimsSet)	Constructs a OpenIDConnectSessionInfo object.