Package com.microstrategy.webapi

Class MSTRWebAPIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.microstrategy.utils.MSTRCheckedException

com.microstrategy.webapi.MSTRWebAPIException

All Implemented Interfaces:

LocalizableException, java.io.Serializable

Direct Known Subclasses:

ACMException, MSTRDocumentException, MSTRRestAPIException

public class MSTRWebAPIException
extends MSTRCheckedException

Exception class for all errors thrown from the WebAPI. Field for error code and another exception added to regular exception's implementation. All functions in the Web API throw this object if an error occurs. In that case, the message field(which can be seen via getMessage()) will have the error message in text format, and the error code can be acquired by getErrorCode. The symbolic constants for each error code are in the class WebAPIErrorCodes. Finally, for exceptions where there was another exception thrown, this exception can be acquired by getWrappedException.

Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.MSTRCheckedException

MSTRCheckedException.ExceptionXMLHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MSTRWebAPIException()
protected	MSTRWebAPIException(int errorCode)
	MSTRWebAPIException(int code, java.lang.Object[] params, java.lang.Throwable e, java.util.Locale locale)	Constructor.
	MSTRWebAPIException(int code, java.lang.Object[] params, java.util.Locale locale)	Constructor.
	MSTRWebAPIException(LocalizableMessage errorMsg)	Constructor.
	MSTRWebAPIException(LocalizableMessage errorMsg, java.lang.Throwable e)	Constructor.
protected	MSTRWebAPIException(java.lang.String errorMsg)
protected	MSTRWebAPIException(java.lang.String errorMsg, int errorCode)
protected	MSTRWebAPIException(java.lang.String errorMsg, int errorCode, java.lang.Throwable e)
protected	MSTRWebAPIException(java.lang.String errorMsg, java.lang.Throwable e)
protected	MSTRWebAPIException(java.lang.Throwable e)

Method Summary

Modifier and Type	Method	Description
protected boolean	canRetry()
protected boolean	isRetryable()	isRetryable returns true if this particular error is a retryable exception. Retryable exceptions include: missing session (maybe it timed out) dead IServer (maybe it was shut down or is hanging) missing project (maybe it was just unloaded).
protected void	setIsRetryable(boolean iIsRetryable)	setIsRetyable sets whether or not this particular error is retryable. Retryable exceptions include: missing session (maybe it timed out) dead IServer (maybe it was shut down or is hanging) missing project (maybe it was just unloaded).
protected void	setNoRetry(boolean value)

Methods inherited from class com.microstrategy.utils.MSTRCheckedException

getCause, getDefaultLocale, getErrorCode, getLocalizableMessage, getMessage, getMessage, getMessage, getRootCause, getRootCause, setCause, setDefaultLocale, setXMLHandler

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, 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

MSTRWebAPIException

public MSTRWebAPIException(LocalizableMessage errorMsg)

Constructor.

Parameters:

errorMsg - error message

Since:

MicroStrategy Web 8.0.0

MSTRWebAPIException

public MSTRWebAPIException(LocalizableMessage errorMsg,
                           java.lang.Throwable e)

Constructor.

Parameters:

errorMsg - error message

e - Embedded error

Since:

MicroStrategy Web 8.0.0

MSTRWebAPIException

public MSTRWebAPIException(int code,
                           java.lang.Object[] params,
                           java.util.Locale locale)

Constructor.

Parameters:

code - error code

params - parameters required to generate error message based on error code

locale - default locale for this exception

Since:

MicroStrategy Web 8.0.0

MSTRWebAPIException

public MSTRWebAPIException(int code,
                           java.lang.Object[] params,
                           java.lang.Throwable e,
                           java.util.Locale locale)

Constructor.

Parameters:

code - error code

params - parameters required to generate error message based on error code

locale - default locale for this exception

e - embedded error

Since:

MicroStrategy Web 8.0.0

MSTRWebAPIException

protected MSTRWebAPIException()

MSTRWebAPIException

protected MSTRWebAPIException(java.lang.String errorMsg)

MSTRWebAPIException

protected MSTRWebAPIException(java.lang.Throwable e)

MSTRWebAPIException

protected MSTRWebAPIException(java.lang.String errorMsg,
                              java.lang.Throwable e)

MSTRWebAPIException

protected MSTRWebAPIException(int errorCode)

MSTRWebAPIException

protected MSTRWebAPIException(java.lang.String errorMsg,
                              int errorCode)

MSTRWebAPIException

protected MSTRWebAPIException(java.lang.String errorMsg,
                              int errorCode,
                              java.lang.Throwable e)

Method Detail

setNoRetry

protected void setNoRetry(boolean value)

Since:

MicroStrategy Web 9.0.0

canRetry

protected boolean canRetry()

Since:

MicroStrategy Web 9.0.0

isRetryable

protected boolean isRetryable()

isRetryable returns true if this particular error is a retryable exception.
Retryable exceptions include:

• missing session (maybe it timed out)
• dead IServer (maybe it was shut down or is hanging)
• missing project (maybe it was just unloaded).

Returns:

setIsRetryable

protected void setIsRetryable(boolean iIsRetryable)

setIsRetyable sets whether or not this particular error is retryable.
Retryable exceptions include:

• missing session (maybe it timed out)
• dead IServer (maybe it was shut down or is hanging)
• missing project (maybe it was just unloaded).

Parameters:

iIsRetryable -