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

Class OAuth20Exception

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidGrantException, OAuth20AccessDeniedException, OAuth20AuthorizationCodeInvalidClientException, OAuth20BadParameterFormatException, OAuth20DuplicateParameterException, OAuth20InternalException, OAuth20InvalidClientException, OAuth20InvalidClientSecretException, OAuth20InvalidGrantTypeException, OAuth20InvalidRedirectUriException, OAuth20InvalidResponseTypeException, OAuth20InvalidScopeException, OAuth20InvalidTokenException, OAuth20InvalidTokenRequestMethodException, OAuth20MediatorException, OAuth20MismatchedClientAuthenticationException, OAuth20MismatchedRedirectUriException, OAuth20MissingParameterException, OAuth20PublicClientCredentialsException, OAuth20PublicClientForbiddenException, OAuth20RefreshTokenInvalidClientException, OidcServerException

public class OAuth20Exception
extends OAuthException

Represents an exception while processing OAuth 2.0 request and response. This class is the base class for all OAuth 2.0 component exceptions.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_DENIED
static final String	INSUFFICIENT_SCOPE
static final String	INVALID_CLIENT
static final String	INVALID_GRANT
static final String	INVALID_REQUEST
static final String	INVALID_SCOPE
static final String	INVALID_TOKEN
static final String	SERVER_ERROR
static final String	TEMPORARILY_UNAVAILABLE
static final String	UNAUTHORIZED_CLIENT
static final String	UNSUPPORED_GRANT_TPE
static final String	UNSUPPORTED_RESPONSE_TPE

Constructor Summary

Constructors

Constructor	Description
OAuth20Exception(String error, String message, Throwable cause)	Creates a OAuth20Exception.

Method Summary

Modifier and Type	Method	Description
String	formatSelf(Locale locale, String encoding)
String	getError()	Gets error type for this OAuth exception

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

Field Details

INVALID_REQUEST

public static final String INVALID_REQUEST

See Also:

• Constant Field Values

UNAUTHORIZED_CLIENT

public static final String UNAUTHORIZED_CLIENT

See Also:

• Constant Field Values

ACCESS_DENIED

public static final String ACCESS_DENIED

See Also:

• Constant Field Values

UNSUPPORTED_RESPONSE_TPE

public static final String UNSUPPORTED_RESPONSE_TPE

See Also:

• Constant Field Values

INVALID_SCOPE

public static final String INVALID_SCOPE

See Also:

• Constant Field Values

SERVER_ERROR

public static final String SERVER_ERROR

See Also:

• Constant Field Values

TEMPORARILY_UNAVAILABLE

public static final String TEMPORARILY_UNAVAILABLE

See Also:

• Constant Field Values

INVALID_CLIENT

public static final String INVALID_CLIENT

See Also:

• Constant Field Values

INVALID_GRANT

public static final String INVALID_GRANT

See Also:

• Constant Field Values

UNSUPPORED_GRANT_TPE

public static final String UNSUPPORED_GRANT_TPE

See Also:

• Constant Field Values

INVALID_TOKEN

public static final String INVALID_TOKEN

See Also:

• Constant Field Values

INSUFFICIENT_SCOPE

public static final String INSUFFICIENT_SCOPE

See Also:

• Constant Field Values

Constructor Details

OAuth20Exception

public OAuth20Exception(String error,
 String message,
 Throwable cause)

Creates a OAuth20Exception.

Parameters:

error - A message for the OAuth 2.0 error.

message - A message for the general OAuth error.

cause - A root exception.

Method Details

getError

public String getError()

Description copied from class: OAuthException

Gets error type for this OAuth exception

Specified by:

getError in class OAuthException

Returns:

the error response associated with this OAuth 2.0 exception. These errors correspond to the mandated error field in OAuth 2.0 protocol.

formatSelf

public String formatSelf(Locale locale,
 String encoding)

Specified by:

formatSelf in class OAuthException