WebFailedServerException (Web API 2021)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.microstrategy.utils.MSTRCheckedException
    - - com.microstrategy.web.objects.WebFailedServerException

All Implemented Interfaces:

LocalizableException, java.io.Serializable
```
public class WebFailedServerException
extends MSTRCheckedException
```
The class WebFailedServerException is a subclass of MSTRCheckedException. This is an exception class for errors involving multiple server failures within a cluster. This class extends the MSTRCheckedException by providing a method to return a SimpleList of WebFailedServer objects and a method to parse an xml string and create a collection of WebFailedServers

Since:

MicroStrategy Web 9.0.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
`WebFailedServerException()`	Default constructor that will create an empty `WebFailedServerException`
`WebFailedServerException(LocalizableMessage errorMsg)`
`WebFailedServerException(LocalizableMessage errorMsg, java.lang.Throwable e)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SimpleList`	`getFailedServers()`	Retrieve the list of `WebFailedServer` objects associated with this exception
`void`	`populate(java.lang.String xml)`	Populate the list of `WebFailedServer` objects from the provided XML

Methods inherited from class com.microstrategy.utils.MSTRCheckedException
getAuditInfo, getCause, getDefaultLocale, getErrorCode, getLocalizableMessage, getMessage, 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
  - WebFailedServerException
```
public WebFailedServerException(LocalizableMessage errorMsg)
```
    Parameters:
    
    errorMsg - LocalizableMessage used to notify the user of what error has occurred
  - WebFailedServerException
```
public WebFailedServerException(LocalizableMessage errorMsg,
                                java.lang.Throwable e)
```
    Parameters:
    
    errorMsg - LocalizableMessage used to notify the user of what error has occurred
    
    e - Throwable that this object will wrap
  - WebFailedServerException
```
public WebFailedServerException()
```
    Default constructor that will create an empty WebFailedServerException
- Method Detail
  - getFailedServers
```
public SimpleList getFailedServers()
```
    Retrieve the list of WebFailedServer objects associated with this exception
    
    Returns:
    
    SimpleList of WebFailedServer objects
  - populate
```
public void populate(java.lang.String xml)
              throws WebObjectsException
```
    Populate the list of WebFailedServer objects from the provided XML
    
    Parameters:
    
    xml - String containing XML for failed servers
    
    Throws:
    
    WebObjectsException - if parsing XML fails