Uses of Class
org.forgerock.oauth.OAuthException

Packages that use OAuthException

Package	Description
org.forgerock.oauth	Commons OAuth Framework API.
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 and 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 and 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.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 and 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.oauth2

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

Modifier and Type	Field and Description
protected 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 and Description
protected Function<Void,JsonValue,OAuthException>	OAuth2Client.createPostAuthResponse(JsonValue storedData) Creates the post auth response.
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.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)
protected static Function<Response,JsonValue,OAuthException>	OAuth2Client.mapToJsonValue() A Function 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).
protected Function<JsonValue,UserInfo,OAuthException>	OAuth2Client.mapToUserInfo() Creates a OAuth2UserInfo using a users raw profile.
Promise<Void,OAuthException>	OAuth2Client.refresh(DataStore dataStore)
protected Function<JsonValue,Void,OAuthException>	OAuth2Client.storeResponse(DataStore dataStore) Stores all the information received from an authentication or authorization server.

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

Modifier and Type	Method and Description
protected static String	OAuth2Client.getAccessToken(JsonValue data) Retrieves an access token from a JsonValue.

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

Constructor and Description
OAuth2SessionInfo(TimeService timeService, 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 and 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.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)
protected Function<JsonValue,UserInfo,OAuthException>	OpenIDConnectClient.mapToUserInfo(JwtClaimsSet jwtClaims) Maps a retrieved raw profile from the user info endpoint to an OpenIDConnectUserInfo object.
protected Function<JsonValue,JsonValue,OAuthException>	OpenIDConnectClient.validateNonce(JsonValue storedData) Validates the nonce.
protected 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 and Description
protected UserInfo	OpenIDConnectClient.createUserInfoFromIdTokenJwtClaims(JwtClaimsSet jwtClaims) Creates an OpenIDConnectUserInfo object from id_token jwt Claims.
protected static String	OpenIDConnectClient.getIdToken(DataStore dataStore) Retrieves an id token from the data store.
protected JwtClaimsSet	OpenIDConnectClient.getJwtClaimsSet(String idToken) Retrieves the claims associated with an id token while enforcing authenticity.
static SignedJwt	OpenIDConnectClient.idTokenAsSignedJwt(String idToken) Returns the id_token as a SignedJwt.
protected static JsonValue	OpenIDConnectClient.jwtClaimsAsJsonValue(JwtClaimsSet jwtClaims) Returns the jwt claims as a JsonValue.

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

Constructor and Description
OpenIDConnectSessionInfo(TimeService timeService, DataStore dataStore, JwtClaimsSet jwtClaimsSet) Constructs a OpenIDConnectSessionInfo object.