org.springframework.security.oauth2.client.resource

Class UserApprovalRequiredException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.oauth2.client.resource.UserApprovalRequiredException

All Implemented Interfaces:

Serializable

public class UserApprovalRequiredException
extends RuntimeException

Exception indicating that user approval is required, with some indication of how to signal the approval.

Author:

Dave Syer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserApprovalRequiredException(String approvalUri, Map<String,String> parameters, String clientId, List<String> scope)

Method Summary

Methods

Modifier and Type	Method and Description
String	getApprovalUri()
String	getClientId()
Map<String,String>	getParameters() Description of the parameters required to be submitted for approval.
List<String>	getScope()

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

UserApprovalRequiredException

public UserApprovalRequiredException(String approvalUri,
                             Map<String,String> parameters,
                             String clientId,
                             List<String> scope)

Method Detail

getApprovalUri

public String getApprovalUri()

Returns:

the approvalUri the uri to which the user should submit for approval

getParameters

public Map<String,String> getParameters()

Description of the parameters required to be submitted for approval. Map from the name of the parameter to its description.

Returns:

the parameters the parameters required for approval

getClientId

public String getClientId()

Returns:

the clientId the client that is requesting approval

getScope

public List<String> getScope()

Returns:

the scope the scope that has been requested for the token grant