Package org.forgerock.oauth2.core.exceptions

Class ResourceOwnerConsentRequired

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.forgerock.oauth2.core.exceptions.ResourceOwnerConsentRequired

All Implemented Interfaces:

Serializable

public class ResourceOwnerConsentRequired
extends Exception

Thrown when the resource owner's consent is required before the authorization can be granted to a OAuth2 client.

Since:

12.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResourceOwnerConsentRequired(String clientName, String clientDescription, Map<String,String> scopeDescriptions, Map<String,String> claimDescriptions, UserInfoClaims claims, String userDisplayName, boolean saveConsentEnabled)	Constructs a new ResourceOwnerConsentRequired instance with the specified client name, description and scope descriptions.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getClaimDescriptions()	Gets the claim descriptions.
UserInfoClaims	getClaims()	Gets the claim values.
String	getClientDescription()	Gets the client's description.
String	getClientName()	Gets the client's name.
Map<String,String>	getScopeDescriptions()	Gets the scope descriptions.
String	getUserDisplayName()	Gets the resource owner's display name.
boolean	isSaveConsentEnabled()	Is save consent enabled

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceOwnerConsentRequired

public ResourceOwnerConsentRequired(String clientName,
                                    String clientDescription,
                                    Map<String,String> scopeDescriptions,
                                    Map<String,String> claimDescriptions,
                                    UserInfoClaims claims,
                                    String userDisplayName,
                                    boolean saveConsentEnabled)

Constructs a new ResourceOwnerConsentRequired instance with the specified client name, description and scope descriptions.

Parameters:

clientName - The display name of the client.

clientDescription - The display description of the client.

scopeDescriptions - The display descriptions of the requested scopes.

claimDescriptions - The display descriptions of the provided claims.

claims - The claims being provided.

userDisplayName - The displayable name of the user, if it can be deduced.

saveConsentEnabled - true if we can save the consent

Method Detail

getClientName

public String getClientName()

Gets the client's name.

Returns:

The name of the client.

getUserDisplayName

public String getUserDisplayName()

Gets the resource owner's display name.

Returns:

The name of the resource owner.

getClientDescription

public String getClientDescription()

Gets the client's description.

Returns:

The description of the client.

getScopeDescriptions

public Map<String,String> getScopeDescriptions()

Gets the scope descriptions.

Returns:

The desciption of the scopes.

getClaimDescriptions

public Map<String,String> getClaimDescriptions()

Gets the claim descriptions.

Returns:

The desciption of the claims.

getClaims

public UserInfoClaims getClaims()

Gets the claim values.

Returns:

The values of the claims.

isSaveConsentEnabled

public boolean isSaveConsentEnabled()

Is save consent enabled

Returns:

true if you can save the consent