Package org.forgerock.openig.filter.oauth2

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 final String	NAME	The OAuth2FailureContext's name.

Fields inherited from class org.forgerock.services.context.AbstractContext

data

Method Summary

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 any OAuth2ErrorException associated with the failure that occurred.
static OAuth2FailureContext	oauth2FailureContext(Context parent, OAuth2ErrorException exception)	Create a new OAuth2FailureContext.

Methods inherited from class org.forgerock.services.context.AbstractContext

as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

The OAuth2FailureContext's name.

See Also:

• Constant Field Values

Method Details

oauth2FailureContext

public static OAuth2FailureContext oauth2FailureContext(Context parent,
 OAuth2ErrorException exception)

Create a new OAuth2FailureContext.

Parameters:

parent - the parent context.

exception - the cause of the failure.

Returns:

a new OAuth2Failure context.

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 any OAuth2ErrorException associated with the failure that occurred.

Returns:

the OAuth2ErrorException associated with the failure