Package com.ibm.oauth.core.api.error.oauth20

Class OAuth20InvalidScopeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.oauth.core.api.error.OAuthException

com.ibm.oauth.core.api.error.oauth20.OAuth20Exception

com.ibm.oauth.core.api.error.oauth20.OAuth20InvalidScopeException

All Implemented Interfaces:

Serializable

public class OAuth20InvalidScopeException
extends OAuth20Exception

Represents an invalid request scope exception in an OAuth request.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.ibm.oauth.core.api.error.oauth20.OAuth20Exception

ACCESS_DENIED, INSUFFICIENT_SCOPE, INVALID_CLIENT, INVALID_GRANT, INVALID_REQUEST, INVALID_SCOPE, INVALID_TOKEN, SERVER_ERROR, TEMPORARILY_UNAVAILABLE, UNAUTHORIZED_CLIENT, UNSUPPORED_GRANT_TPE, UNSUPPORTED_RESPONSE_TPE

Constructor Summary

Constructors

Constructor	Description
OAuth20InvalidScopeException(String[] requestedScope, String[] approvedScope)	Creates a OAuth20InvalidScopeException.
OAuth20InvalidScopeException(String msgKey, String requestType)
OAuth20InvalidScopeException(String msgKey, String[] requestedScope, String[] approvedScope)
OAuth20InvalidScopeException(String msgKey, String[] requestedScope, String[] approvedScope, String clientId)
OAuth20InvalidScopeException(String msgKey, String requestType, String clientId)

Method Summary

Modifier and Type	Method	Description
String	formatSelf(Locale locale, String encoding)
String[]	getApprovedScope()
String[]	getRequestedScope()

Methods inherited from class com.ibm.oauth.core.api.error.oauth20.OAuth20Exception

getError

Methods inherited from class com.ibm.oauth.core.api.error.OAuthException

getMsgKey, getObjects

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OAuth20InvalidScopeException

public OAuth20InvalidScopeException(String[] requestedScope,
 String[] approvedScope)

Creates a OAuth20InvalidScopeException.

Parameters:

requestedScope - An array of requested scopes in an OAuth request.

approvedScope - An array of authorized scopes for an OAuth request.

OAuth20InvalidScopeException

public OAuth20InvalidScopeException(String msgKey,
 String[] requestedScope,
 String[] approvedScope)

OAuth20InvalidScopeException

public OAuth20InvalidScopeException(String msgKey,
 String[] requestedScope,
 String[] approvedScope,
 String clientId)

OAuth20InvalidScopeException

public OAuth20InvalidScopeException(String msgKey,
 String requestType)

Parameters:

msgKey -

requestType -

OAuth20InvalidScopeException

public OAuth20InvalidScopeException(String msgKey,
 String requestType,
 String clientId)

Parameters:

msgKey -

requestType -

clientId -

Method Details

formatSelf

public String formatSelf(Locale locale,
 String encoding)

Overrides:

formatSelf in class OAuth20Exception

getRequestedScope

public String[] getRequestedScope()

Returns:

an array of requested scopes.

getApprovedScope

public String[] getApprovedScope()

Returns:

an array of approved scopes.