com.ansys.ingress.client.api

## Class ConnectionException

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

- All Implemented Interfaces:
    com.ansys.ingress.commons.IngressExceptionDetails, java.io.Serializable
  Direct Known Subclasses:
    InvalidCredentialsException, InvalidWorkspaceException, NoLicenseAvailableException, TooManySessionsException

      public class ConnectionException
      extends EkmException

  ConnectionException is the exception thrown due to problems communicating with an EKM server. These can be due to actual network errors.
  See Also:
    Serialized Form

- - ### Nested Class Summary

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

  - ### 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
    `ConnectionException(ConnectionException.Reason reason)` Creates a new instance of ConnectionException.
    `ConnectionException(ConnectionException.Reason reason, java.lang.Exception rootCause, java.lang.Object... params)` Creates a new instance of ConnectionException.
    `ConnectionException(ConnectionException.Reason reason, java.lang.Object... params)` Creates a new instance of ConnectionException.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getWorkspace()`
    `void` | `setWorkspace(java.lang.String workspace)` Sets the workspace associated with this exception.

    - ### Methods inherited from class com.ansys.ingress.client.api.EkmException

      `getBundlePackage, getMessage, getServerErrorDetails, getServerErrorMessage, getServerException, getServerRootCause, getServerRootCauseMessage, getServerStackTrace, getStatusCode, setServerErrorMessage, setServerException, setServerRootCause, setServerRootCauseMessage, setServerStackTrace, setStatusCode, 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

    - #### ConnectionException

          public ConnectionException(ConnectionException.Reason reason)

      Creates a new instance of ConnectionException.
      Parameters:
        `reason` - the reason for the exception

    - #### ConnectionException

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

      Creates a new instance of ConnectionException.
      Parameters:
        `reason` - Reason for the exception
        `rootCause` - The root cause of the exception
        `params` - Parameters for the error message

    - #### ConnectionException

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

      Creates a new instance of ConnectionException.
      Parameters:
        `reason` - Reason for the exception
        `params` - Parameters for the error message

  - ### Method Detail

    - #### getWorkspace

          public java.lang.String getWorkspace()

      Returns:
        Returns the workspace associated with the exception.

    - #### setWorkspace

          public void setWorkspace(java.lang.String workspace)

      Sets the workspace associated with this exception.
      Parameters:
        `workspace` - the workspace