# Package com.ansys.ingress.client.api

This package contains the interfaces used to communicate and interact with an EKM server.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  AdministrationManager | AdministrationManager provides the interface to perform administrative operations on an EKM server.
  Connection | Connection represents a connection to an EKM server.
  DataManager | DataManager defines the interface for performing data management operations on an EKM server.
  JobManager | JobManager defines the interface for performing job management operations on an EKM server.
  ModelObject | ModelObject represents an object in the EKM repository.
  ModelSpec | ModelSpec provides information about object types defined in EKM.
  Subscriptions | Subscriptions defines the events that a user can be notified about.

- Class Summary
  Class | Description
  --- | ---
  CacheStatus | CacheStatus provides status information about transfers that are using the EKM cache server.
  ConnectionDetails | ConnectionDetails provides information about a connection to an EKM server.
  ConnectionFactory | ConnectionFactory is used to open connections to an EKM server.
  Credentials | Credentials define the tokens used to authenticate with an EKM repository.
  ModelSpecUtils | ModelSpecUtils is used to get information about EKM object types.
  VersionHistoryItem | VersionHistoryItem provides information about a specific version of an object in the EKM repository.

- Enum Summary
  Enum | Description
  --- | ---
  AdministrationException.Reason | Reason defines the message keys for an `AdministrationException`.
  ConnectionException.Reason | Reason defines the reasons for a `ConnectionException`.
  ConnectionFactory.TokenUserType | TokenUserType defines the user types that can login to EKM using a special token.
  DataException.Reason | Reason defines the message keys for a `DataException`.
  EkmException.Reason | Reason defines the reasons for an `EkmException`.
  JobException.Reason | Reason defines the message keys for a `JobException`.
  PermissionAction | Action defines the actions that can be used to determine if a user has permission to perform an action on an object.

- Exception Summary
  Exception | Description
  --- | ---
  AdministrationException | AdministrationException is the exception thrown when operations defined in the `AdministrationManager` interface fail.
  ConnectionException | ConnectionException is the exception thrown due to problems communicating with an EKM server.
  DataException | DataException is the exception thrown by operations defined in the `DataManager` interface.
  EkmException | EkmException is the generic exception thrown by methods defined in the EKM Client API.
  InvalidCredentialsException | InvalidCredentialsException indicates a user provided bad credentials when logging into EKM.
  InvalidWorkspaceException | InvalidWorkspaceException indicates an invalid workspace was given when opening a connection to an EKM server.
  JobException | JobException is the exception thrown by operations defined in the `JobManager` interface.
  NoLicenseAvailableException | NoLicenseAvailableException indicates not licenses are available for a user when logging into EKM.
  TooManySessionsException | TooManySessionsException indicates a user has too many sessions open with EKM.

## Package com.ansys.ingress.client.api Description

This package contains the interfaces used to communicate and interact with an EKM server.