edu.ksu.canvas.exception

Class CanvasException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

edu.ksu.canvas.exception.CanvasException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidOauthTokenException, ObjectNotFoundException, RateLimitException, RetriableException, ThrottlingException, UnauthorizedException

public class CanvasException
extends RuntimeException

Base exception for errors arising while talking to Canvas. When thrown, it can optionally carry a string containing the human readable error message returned by Canvas, if any. Sometimes it may be appropriate to display this error message to the user.It can also carry the URL of the failed request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CanvasException()
CanvasException(String canvasErrorString, String url)
CanvasException(String canvasErrorString, String url, Object error)

Method Summary

Modifier and Type	Method and Description
String	getCanvasErrorMessage()
Object	getError()
String	getRequestUrl()

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

CanvasException

public CanvasException()

CanvasException

public CanvasException(String canvasErrorString,
                       String url)

CanvasException

public CanvasException(String canvasErrorString,
                       String url,
                       Object error)

Method Detail

getError

public Object getError()

getCanvasErrorMessage

public String getCanvasErrorMessage()

getRequestUrl

public String getRequestUrl()