com.ansys.ingress.client.api

## Class EkmException

- java.lang.Object
- - java.lang.Throwable
  - - java.lang.Exception
    - - com.ansys.ingress.commons.IngressException
      - - com.ansys.ingress.client.api.EkmException

- All Implemented Interfaces:
    com.ansys.ingress.commons.IngressExceptionDetails, java.io.Serializable
  Direct Known Subclasses:
    AdministrationException, ConnectionException, DataException, JobException

      public class EkmException
      extends com.ansys.ingress.commons.IngressException

  EkmException is the generic exception thrown by methods defined in the EKM Client API.
  See Also:
    Serialized Form

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `EkmException.Reason` Reason defines the reasons for an `EkmException`.

  - ### Field Summary

    - ### Fields inherited from class com.ansys.ingress.commons.IngressException

      `DISABLE_USER_FAILED, ENABLE_USER_FAILED`

    - ### Fields inherited from interface com.ansys.ingress.commons.IngressExceptionDetails

      `RESOURCE_NAME`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `EkmException(EkmException.Reason reason, java.lang.Exception rootCause, java.lang.Object... params)` Creates a new instance of EkmException.
    `EkmException(EkmException.Reason reason, java.lang.Object... params)` Creates a new instance of EkmException.
    `EkmException(java.lang.String msg)` Creates a new instance of EkmException.
    `EkmException(java.lang.String key, java.lang.Exception rootCause, java.lang.Object... params)` Creates a new instance of EkmException.
    `EkmException(java.lang.String key, java.lang.Object... params)` Creates a new instance of EkmException.
    `EkmException(java.lang.Throwable e)` Creates a new instance of EkmException.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected java.lang.String` | `getBundlePackage()`
    `java.lang.String` | `getMessage()`
    `java.lang.String` | `getServerErrorDetails()` Dumps out error information from the server.
    `java.lang.String` | `getServerErrorMessage()` Returns the value of the serverErrorMessage.
    `java.lang.String` | `getServerException()` Returns the value of the serverException.
    `java.lang.String` | `getServerRootCause()` Returns the value of the serverRootCause.
    `java.lang.String` | `getServerRootCauseMessage()` Returns the value of the serverRootCauseMessage.
    `java.lang.String` | `getServerStackTrace()` Returns the value of the serverStackTrace.
    `int` | `getStatusCode()` Returns the value of the statusCode.
    `void` | `setServerErrorMessage(java.lang.String serverErrorMessage)` Sets the error message received from the server.
    `void` | `setServerException(java.lang.String serverException)` Sets the class name of the exception that occurred on the server.
    `void` | `setServerRootCause(java.lang.String serverRootCause)` Sets the class name of the root cause exception that caused the error on the server.
    `void` | `setServerRootCauseMessage(java.lang.String serverRootCauseMessage)` Sets the error message of the root cause.
    `void` | `setServerStackTrace(java.lang.String serverStackTrace)` Sets the stack trace of the error from the server.
    `void` | `setStatusCode(int statusCode)` Sets the HTTP status code associated with this error.
    `java.lang.String` | `toString()`

    - ### Methods inherited from class com.ansys.ingress.commons.IngressException

      `getBundleBasename, getDetailKey, getKey, getLocalizedMessage, getLocalizedMessage, getParams, messageFromKey, setKey, setParams`

    - ### Methods inherited from class java.lang.Throwable

      `addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface com.ansys.ingress.commons.IngressExceptionDetails

      `getCause`

- - ### Constructor Detail

    - #### EkmException

          public EkmException(java.lang.String msg)

      Creates a new instance of EkmException.
      Parameters:
        `msg` - error message

    - #### EkmException

          public EkmException(java.lang.Throwable e)

      Creates a new instance of EkmException.
      Parameters:
        `e` - root cause

    - #### EkmException

          public EkmException(java.lang.String key,
                              java.lang.Exception rootCause,
                              java.lang.Object... params)

      Creates a new instance of EkmException.
      Parameters:
        `key` - message key
        `rootCause` - root cause of the exception
        `params` - optional message parameters

    - #### EkmException

          public EkmException(java.lang.String key,
                              java.lang.Object... params)

      Creates a new instance of EkmException.
      Parameters:
        `key` - message key
        `params` - optional message parameters

    - #### EkmException

          public EkmException(EkmException.Reason reason,
                              java.lang.Object... params)

      Creates a new instance of EkmException.
      Parameters:
        `reason` - message key
        `params` - optional message parameters

    - #### EkmException

          public EkmException(EkmException.Reason reason,
                              java.lang.Exception rootCause,
                              java.lang.Object... params)

      Creates a new instance of EkmException.
      Parameters:
        `reason` - message key
        `rootCause` - root cause of the exception
        `params` - optional message parameters

  - ### Method Detail

    - #### getMessage

          public java.lang.String getMessage()

      Overrides:
        `getMessage` in class `com.ansys.ingress.commons.IngressException`

    - #### getServerException

          public java.lang.String getServerException()

      Returns the value of the serverException.
      Returns:
        Returns the value.

    - #### getStatusCode

          public int getStatusCode()

      Returns the value of the statusCode.
      Returns:
        Returns the value.

    - #### getServerErrorMessage

          public java.lang.String getServerErrorMessage()

      Returns the value of the serverErrorMessage.
      Returns:
        Returns the value.

    - #### getServerRootCause

          public java.lang.String getServerRootCause()

      Returns the value of the serverRootCause.
      Returns:
        Returns the value.

    - #### getServerRootCauseMessage

          public java.lang.String getServerRootCauseMessage()

      Returns the value of the serverRootCauseMessage.
      Returns:
        Returns the value.

    - #### getServerStackTrace

          public java.lang.String getServerStackTrace()

      Returns the value of the serverStackTrace.
      Returns:
        Returns the value.

    - #### setServerException

          public void setServerException(java.lang.String serverException)

      Sets the class name of the exception that occurred on the server.
      Parameters:
        `serverException` - the class name

    - #### setStatusCode

          public void setStatusCode(int statusCode)

      Sets the HTTP status code associated with this error.
      Parameters:
        `statusCode` - the HTTP status code

    - #### setServerErrorMessage

          public void setServerErrorMessage(java.lang.String serverErrorMessage)

      Sets the error message received from the server.
      Parameters:
        `serverErrorMessage` - the error message

    - #### setServerRootCause

          public void setServerRootCause(java.lang.String serverRootCause)

      Sets the class name of the root cause exception that caused the error on the server.
      Parameters:
        `serverRootCause` - the class name

    - #### setServerRootCauseMessage

          public void setServerRootCauseMessage(java.lang.String serverRootCauseMessage)

      Sets the error message of the root cause.
      Parameters:
        `serverRootCauseMessage` - the error message.

    - #### setServerStackTrace

          public void setServerStackTrace(java.lang.String serverStackTrace)

      Sets the stack trace of the error from the server.
      Parameters:
        `serverStackTrace` - the stack trace

    - #### getServerErrorDetails

          public java.lang.String getServerErrorDetails()

      Dumps out error information from the server.
      Returns:
        Returns the error details from the server.

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `java.lang.Throwable`

    - #### getBundlePackage

          protected java.lang.String getBundlePackage()

      Specified by:
        `getBundlePackage` in class `com.ansys.ingress.commons.IngressException`