Class OAuth2FailureContext
- java.lang.Object
-
- org.forgerock.services.context.AbstractContext
-
- org.forgerock.openig.filter.oauth2.OAuth2FailureContext
-
- All Implemented Interfaces:
Context
public final class OAuth2FailureContext extends AbstractContext
Context
implementation to hold OAuth2 error details, should a failure occur during OAuth2 scenarios.- See Also:
- RFC 6749 - OAuth2 Error Responses
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME
TheOAuth2FailureContext
's name.-
Fields inherited from class org.forgerock.services.context.AbstractContext
data
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Get a description of the failure that occurred, if known, for example as provided by AM.String
getError()
Get the error that occurred, if known, for example as provided by AM.OAuth2ErrorException
getException()
Get anyOAuth2ErrorException
associated with the failure that occurred.-
Methods inherited from class org.forgerock.services.context.AbstractContext
as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString
-
-
-
-
Field Detail
-
NAME
public static final String NAME
TheOAuth2FailureContext
's name.- See Also:
- Constant Field Values
-
-
Method Detail
-
getError
public String getError()
Get the error that occurred, if known, for example as provided by AM.- Returns:
- the OAuth2 error
-
getDescription
public String getDescription()
Get a description of the failure that occurred, if known, for example as provided by AM.- Returns:
- the error description
-
getException
public OAuth2ErrorException getException()
Get anyOAuth2ErrorException
associated with the failure that occurred.- Returns:
- the
OAuth2ErrorException
associated with the failure
-
-