Package com.microstrategy.web.objects.admin.serverconfig

Class ServerControlException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.microstrategy.utils.MSTRCheckedException

com.microstrategy.web.objects.admin.serverconfig.ServerConfigException

com.microstrategy.web.objects.admin.serverconfig.ServerControlException

All Implemented Interfaces:

LocalizableException, java.io.Serializable

public class ServerControlException
extends ServerConfigException

The class ServerControlException is a subclass of java.lang.Exception. This is an exception class for all errors thrown by the underlying Server Control API. This class extends the standard ServerConfigException class by providing a method to return an error code associated with the exception. In addition, this class separates out part of the error message thrown from the underlying API.

Since:

MicroStrategy Web 7.5.0

See Also:

Serialized Form

Nested Class Summary

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

MSTRCheckedException.ExceptionXMLHandler

Constructor Summary

Constructors

Constructor	Description
ServerControlException(int code, java.lang.Object[] params, java.lang.Throwable e, java.util.Locale locale)	Deprecated. use other constructor instead
ServerControlException(int code, java.lang.Object[] params, java.util.Locale locale)	Deprecated. use other constructor instead
ServerControlException(LocalizableMessage errorMsg)	Constructor.
ServerControlException(LocalizableMessage errorMsg, java.lang.Throwable e)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDetailedErrorMsg()
java.lang.String	getMessage()	Returns the error message.

Methods inherited from class com.microstrategy.utils.MSTRCheckedException

getAuditInfo, getCause, getDefaultLocale, getErrorCode, getLocalizableMessage, getMessage, getMessage, getRootCause, getRootCause, setAuditInfo, 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

ServerControlException

public ServerControlException(LocalizableMessage errorMsg)

Constructor.

Parameters:

errorMsg - The error message for this exception.

Since:

MicroStrategy Web 8.0.0

ServerControlException

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

Constructor.

Parameters:

errorMsg - The error message for this exception.

e - The embedded error object.

Since:

MicroStrategy Web 8.0.0

ServerControlException

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

Deprecated.

use other constructor instead

Constructor.

Parameters:

code - error code.

locale - The locale to localize this exception.

params - The parameters required to constructing the error message based on error code.

Since:

MicroStrategy Web 8.0.0

ServerControlException

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

Deprecated.

use other constructor instead

Constructor.

Parameters:

code - error code.

locale - The locale to localize this exception.

params - The parameters required to constructing the error message based on error code.

e - The embedded error object.

Since:

MicroStrategy Web 8.0.0

Method Detail

getDetailedErrorMsg

public java.lang.String getDetailedErrorMsg()

getMessage

public java.lang.String getMessage()

Description copied from class: MSTRCheckedException

Returns the error message. If this is null and the error code is 0, it will first examine if there is an embedded exception MSTRCheckedException.getCause(), if so and it is either a MSTRCheckedException or MSTRUncheckedException, it will attempt to return their error message instead (recursively searching). If the message is not null or the error code is non-zero, the message of this exception is returned.

Specified by:

getMessage in interface LocalizableException

Overrides:

getMessage in class MSTRCheckedException

Returns:

The error message.