Package org.forgerock.oauth2.core.exceptions

Class InvalidScopeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.forgerock.oauth2.core.exceptions.OAuth2Exception

org.forgerock.oauth2.core.exceptions.InvalidScopeException

All Implemented Interfaces:

Serializable

public class InvalidScopeException
extends OAuth2Exception

Thrown when the requested scope is invalid, unknown, or malformed.

Since:

12.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidScopeException()	Constructs a new InvalidScopeException with the default message.
InvalidScopeException(String message)	Constructs a new InvalidScopeException with the specified message.
InvalidScopeException(String message, OAuth2Constants.UrlLocation parameterLocation)	Constructs a new InvalidScopeException with the specified message.

Method Summary

Modifier and Type	Method	Description
static InvalidScopeException	create(String message, OAuth2Request request)	Creates a new InvalidScopeException by deducing the UrlLocation from the OAuth2Request.

Methods inherited from class org.forgerock.oauth2.core.exceptions.OAuth2Exception

getError, getParameterLocation, getStatusCode

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

InvalidScopeException

public InvalidScopeException()

Constructs a new InvalidScopeException with the default message.

InvalidScopeException

public InvalidScopeException(String message)

Constructs a new InvalidScopeException with the specified message. The OAuth2Constants.UrlLocation for the parameters are defaulted to QUERY.

Parameters:

message - The reason for the exception.

InvalidScopeException

public InvalidScopeException(String message,
                             OAuth2Constants.UrlLocation parameterLocation)

Constructs a new InvalidScopeException with the specified message.

Parameters:

message - The reason for the exception.

parameterLocation - Indicates the location of the parameters in the URL.

Method Detail

create

public static InvalidScopeException create(String message,
                                           OAuth2Request request)

Creates a new InvalidScopeException by deducing the UrlLocation from the OAuth2Request.

Parameters:

message - The reason for the exception.

request - The request from which we can work out what UrlLocation is needed.

Returns:

The created exception.