org.restlet.ext.oauth

Class OAuthException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.restlet.ext.oauth.OAuthException

All Implemented Interfaces:

java.io.Serializable

Deprecated.

Will be removed in next minor release.

@Deprecated
public class OAuthException
extends java.lang.Exception

Exception that represents OAuth 2.0 (RFC6749) Errors.

Author:

Shotaro Uchida

See Also:

The OAuth 2.0 Authorization Framework (RFC6749), Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuthException(OAuthError error, java.lang.String description, java.lang.String errorUri) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	createErrorDocument() Deprecated. Returns a JSON representation of the current object as a JSONObject.
OAuthError	getError() Deprecated. Returns the kind of OAuth error.
java.lang.String	getErrorDescription() Deprecated. Returns the description of the error.
java.lang.String	getErrorUri() Deprecated. Returns the URI of the resource that gives more details about the error.
java.lang.String	getErrorURI() Deprecated. use getErrorUri() instead.
void	setError(OAuthError error) Deprecated. Sets the kind of OAuth error.
void	setErrorDescription(java.lang.String errorDescription) Deprecated. Sets the description of the error.
void	setErrorUri(java.lang.String errorUri) Deprecated. Sets the URI of the resource that gives more details about the error.
static OAuthException	toOAuthException(Form parameters) Deprecated. Returns a new OAuthException based on the given parameters.
static OAuthException	toOAuthException(org.json.JSONObject json) Deprecated. Returns a new OAuthException based on the JSON payload.
static OAuthException	toOAuthException(java.lang.Throwable exception) Deprecated. Returns a new OAuthException based on the given exception.

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

OAuthException

public OAuthException(OAuthError error,
                      java.lang.String description,
                      java.lang.String errorUri)

Deprecated.

Constructor.

Parameters:

error - The OAuth error.

description - The description of the exception.

errorUri - The URI of the resource that gives more details about the error.

Method Detail

toOAuthException

public static OAuthException toOAuthException(Form parameters)

Deprecated.

Returns a new OAuthException based on the given parameters. It especially looks for the given parameters:
OAuthResourceDefs.ERROR for the kind of Exception (see OAuthError for the supported values),
OAuthResourceDefs.ERROR_DESC for the description,
OAuthResourceDefs.ERROR_URI for the URI of a documentation resource.

Parameters:

parameters - The parameters used to set up the OAuthException.

Returns:

A new instance of OAuthException.

toOAuthException

public static OAuthException toOAuthException(org.json.JSONObject json)
                                       throws org.json.JSONException

Deprecated.

Returns a new OAuthException based on the JSON payload. It especially looks for the given parameters:
OAuthResourceDefs.ERROR for the kind of Exception (see OAuthError for the supported values),
OAuthResourceDefs.ERROR_DESC for the description,
OAuthResourceDefs.ERROR_URI for the URI of a documentation resource.

Parameters:

json - The JSON object used to set up the OAuthException.

Returns:

A new instance of OAuthException.

Throws:

org.json.JSONException

toOAuthException

public static OAuthException toOAuthException(java.lang.Throwable exception)

Deprecated.

Returns a new OAuthException based on the given exception.

Parameters:

exception - The exception.

Returns:

A new instance OAuthException.

createErrorDocument

public org.json.JSONObject createErrorDocument()
                                        throws org.json.JSONException

Deprecated.

Returns a JSON representation of the current object as a JSONObject.

Returns:

A JSON representation of the current object as a JSONObject.

Throws:

org.json.JSONException

getError

public OAuthError getError()

Deprecated.

Returns the kind of OAuth error.

Returns:

The kind of OAuth error.

getErrorDescription

public java.lang.String getErrorDescription()

Deprecated.

Returns the description of the error.

Returns:

The description of the error.

getErrorUri

public java.lang.String getErrorUri()

Deprecated.

Returns the URI of the resource that gives more details about the error.

Returns:

The URI of the resource that gives more details about the error.

getErrorURI

@Deprecated
public java.lang.String getErrorURI()

Deprecated. use getErrorUri() instead.

Returns:

setError

public void setError(OAuthError error)

Deprecated.

Sets the kind of OAuth error.

Parameters:

error - The kind of OAuth error.

setErrorDescription

public void setErrorDescription(java.lang.String errorDescription)

Deprecated.

Sets the description of the error.

Parameters:

errorDescription - The description of the error.

setErrorUri

public void setErrorUri(java.lang.String errorUri)

Deprecated.

Sets the URI of the resource that gives more details about the error.

Parameters:

errorUri - The URI of the resource that gives more details about the error.