Package com.appliedolap.essbase

Class EssApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.appliedolap.essbase.EssApiException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DrillthroughColumnMismatchException, NoSuchEssbaseObjectException

public class EssApiException
extends RuntimeException

A general, unchecked exception that we can be used to wrap the ApiException checked exceptions that are all over the generated client code. This class will try and inspect the original exception in order to come up with the best and most informative error message possible, namely by extracting the errorMessage key from the response body in the original exception, if any.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EssApiException(String message)
EssApiException(String message, Throwable throwable)	For adding context a caller has and the cause does not - which part of an upload failed, say.
EssApiException(Throwable throwable)

Method Summary

Modifier and Type	Method	Description
protected static Map<String,String>	extractMessage(String message)
protected static String	getBestMessage(Throwable e)

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 Details

EssApiException

public EssApiException(String message)

EssApiException

public EssApiException(Throwable throwable)

EssApiException

public EssApiException(String message,
 Throwable throwable)

For adding context a caller has and the cause does not - which part of an upload failed, say.

Keeps the cause, deliberately. Anything reading these walks the chain to its root for the most specific frame, so throwing away the cause to add a sentence would trade the diagnosis for the commentary.

Parameters:

message - what was being attempted

throwable - what went wrong

Method Details

getBestMessage

protected static String getBestMessage(Throwable e)

extractMessage

protected static Map<String,String> extractMessage(String message)