public class

ServerControlException

extends ServerConfigException
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

Class Overview

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.

Summary

Public Constructors
ServerControlException(LocalizableMessage errorMsg)
Constructor.
ServerControlException(LocalizableMessage errorMsg, Throwable e)
Constructor.
ServerControlException(int code, Object[] params, Locale locale)
This constructor is deprecated. use other constructor instead
ServerControlException(int code, Object[] params, Throwable e, Locale locale)
This constructor is deprecated. use other constructor instead
Public Methods
String getDetailedErrorMsg()
String getMessage()
Returns the error message.
[Expand]
Inherited Methods
From class com.microstrategy.utils.MSTRCheckedException
From class java.lang.Throwable
From class java.lang.Object
From interface com.microstrategy.utils.LocalizableException

Public Constructors

public ServerControlException (LocalizableMessage errorMsg)

Constructor.

Parameters
errorMsg The error message for this exception.

public ServerControlException (LocalizableMessage errorMsg, Throwable e)

Constructor.

Parameters
errorMsg The error message for this exception.
e The embedded error object.

public ServerControlException (int code, Object[] params, Locale locale)

This constructor is deprecated.
use other constructor instead

Constructor.

Parameters
code error code.
params The parameters required to constructing the error message based on error code.
locale The locale to localize this exception.

public ServerControlException (int code, Object[] params, Throwable e, Locale locale)

This constructor is deprecated.
use other constructor instead

Constructor.

Parameters
code error code.
params The parameters required to constructing the error message based on error code.
e The embedded error object.
locale The locale to localize this exception.

Public Methods

public String getDetailedErrorMsg ()

public String getMessage ()

Returns the error message. If this is null and the error code is 0, it will first examine if there is an embedded exception 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.

Returns
  • The error message.