EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Static Public Member Functions
com::ansys::ingress::client::api::ConnectionFactory Class Reference

ConnectionFactory is used to open connections to an EKM server. These can be transient connections or persistent connections that were previously saved. More...

List of all members.

## Static Public Member Functions

static void | ConnectionClosed (string name)
| Notifies the ConnectionFactory that a connection was closed.
static void | DeleteConnection (string name)
| Deletes the connection with the given name.
static ConnectionDetails | FindConnection (string url, string workspace)
| Finds a connection based on a URL and workspace.
static ConnectionDetails | FindConnection (string url, string username, string password)
| Finds a connection based on a URL and credentials.
static Connection | GetConnection (string name)
| Gets the connection with the given name.
static ConnectionDetails | GetConnectionDetails (string name)
| Get details about a connection.
static List< string > | GetConnectionNames ()
| Get a dictionary of information about each saved connection.
static Dictionary< string, ConnectionDetails > | GetConnections ()
| Get a dictionary of information about each saved connection.
static bool | HasConnection (string name)
| Determines if a connection exists with the given name.
static Connection | Load (string name)
| Opens a persisted connection to an EKM server using the user's saved credentials. Users will be logged into the workspace last accessed by this connection.
static Connection | Load (string name, bool closeExisting)
| Opens a persisted connection to an EKM server using the user's saved credentials. Users will be logged into the workspace last accessed by this connection.
static Connection | Load (string name, string username, string password)
| Opens a persisted connection to an EKM server. Users will be logged into the workspace last accessed by this connection.
static Connection | Load (string name, string username, string password, bool closeExisting)
| Opens a persisted connection to an EKM server. Users will be logged into the workspace last accessed by this connection.
static Connection | Load (string name, TokenUserType userType, string token)
| Opens a persisted connection to an EKM server. Users will be logged into the workspace last accessed by this connection.
static Connection | Open (string host, string username, string password)
| Opens a connection to an EKM server. Users will be logged into the default workspace assigned to them.
static Connection | Open (string host, string username, string password, string workspace)
| Opens a connection to an EKM server. Users will be logged into the specified workspace if permitted.
static Connection | Open (string host, string username, string password, string workspace, bool closeExisting)
| Opens a connection to an EKM server. Users will be logged into the specified workspace if permitted.
static Connection | Open (string host, TokenUserType userType, string token, string workspace)
| Opens a connection to an EKM server. Users will be logged into their default workspace.
static Connection | Connect (string host, string userId, string token, string workspace)
| Connects to an EKM server using the user's archive ID and an authentication token from a previously established session.
static void | Shutdown ()
| Shuts down any processes started by the EKM client API.

## Detailed Description

ConnectionFactory is used to open connections to an EKM server. These can be transient connections or persistent connections that were previously saved.

## Member Function Documentation

static Connection com::ansys::ingress::client::api::ConnectionFactory::Connect | ( | string | host,
|  | string | userId,
|  | string | token,
|  | string | workspace
| ) |  | `[inline, static]`

Connects to an EKM server using the user's archive ID and an authentication token from a previously established session.

Parameters:

  host | the URL of the EKM server
  userId | the user's archive ID
  token | the user's authentication token
  workspace | the workspace to which the user is connecting

Returns:
  Returns the connection to the server.

static void com::ansys::ingress::client::api::ConnectionFactory::ConnectionClosed | ( | string | name | ) | `[inline, static]`

Notifies the ConnectionFactory that a connection was closed.

Parameters:

  name | the name of the connection

static void com::ansys::ingress::client::api::ConnectionFactory::DeleteConnection | ( | string | name | ) | `[inline, static]`

Deletes the connection with the given name.

Parameters:

  name | the name of the connection to delete

static ConnectionDetails com::ansys::ingress::client::api::ConnectionFactory::FindConnection | ( | string | url,
|  | string | username,
|  | string | password
| ) |  | `[inline, static]`

Finds a connection based on a URL and credentials.

Parameters:

  url | the URL of the connection
  username | the username
  password | the password

Returns:
  Returns the connection details or null if no connection matches the URL and credentials. Since multiple connections could have the same URL and credentials, this method will simply return the first one it finds.

static ConnectionDetails com::ansys::ingress::client::api::ConnectionFactory::FindConnection | ( | string | url,
|  | string | workspace
| ) |  | `[inline, static]`

Finds a connection based on a URL and workspace.

Parameters:

  url | the URL of the connection
  workspace | the workspace of the connection

Returns:
  Returns the connection details or null if no connection matches the URL and workspace. Since multiple connections could have the same URL and workspace, this method will simply return the first one it finds.

static Connection com::ansys::ingress::client::api::ConnectionFactory::GetConnection | ( | string | name | ) | `[inline, static]`

Gets the connection with the given name.

Parameters:

  name | the name of the connection to get

Returns:
  Returns the connection or null if no connection exists with the given name.

static ConnectionDetails com::ansys::ingress::client::api::ConnectionFactory::GetConnectionDetails | ( | string | name | ) | `[inline, static]`

Get details about a connection.

Parameters:

  name | the name of the connection

Returns:
  Returns the details about the connection or null if no connection exists with the given name.

static List<string> com::ansys::ingress::client::api::ConnectionFactory::GetConnectionNames | ( |  | ) | `[inline, static]`

Get a dictionary of information about each saved connection.

Returns:
  Returns a dictionary of ConnectionDetails.

static Dictionary<string, ConnectionDetails> com::ansys::ingress::client::api::ConnectionFactory::GetConnections | ( |  | ) | `[inline, static]`

Get a dictionary of information about each saved connection.

Returns:
  Returns a dictionary of ConnectionDetails.

static bool com::ansys::ingress::client::api::ConnectionFactory::HasConnection | ( | string | name | ) | `[inline, static]`

Determines if a connection exists with the given name.

Parameters:

  name | the name of the connection to check

Returns:
  Returns true if the connection exists.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Load | ( | string | name | ) | `[inline, static]`

Opens a persisted connection to an EKM server using the user's saved credentials. Users will be logged into the workspace last accessed by this connection.

Parameters:

  name | The name of the connection to open

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Load | ( | string | name,
|  | bool | closeExisting
| ) |  | `[inline, static]`

Opens a persisted connection to an EKM server using the user's saved credentials. Users will be logged into the workspace last accessed by this connection.

Parameters:

  name | The name of the connection to open
  closeExisting | If a user's existing session should be closed or not

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Load | ( | string | name,
|  | string | username,
|  | string | password
| ) |  | `[inline, static]`

Opens a persisted connection to an EKM server. Users will be logged into the workspace last accessed by this connection.

Parameters:

  name | The name of the connection to open
  username | The EKM user
  password | The EKM user's password

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Load | ( | string | name,
|  | string | username,
|  | string | password,
|  | bool | closeExisting
| ) |  | `[inline, static]`

Opens a persisted connection to an EKM server. Users will be logged into the workspace last accessed by this connection.

Parameters:

  name | The name of the connection to open
  username | The EKM user
  password | The EKM user's password
  closeExisting | If a user's existing session should be closed or not

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Load | ( | string | name,
|  | TokenUserType | userType,
|  | string | token
| ) |  | `[inline, static]`

Opens a persisted connection to an EKM server. Users will be logged into the workspace last accessed by this connection.

Parameters:

  name | The name of the connection to open
  userType | The type of user logging in
  token | The token for the type of user logging in

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Open | ( | string | host,
|  | TokenUserType | userType,
|  | string | token,
|  | string | workspace
| ) |  | `[inline, static]`

Opens a connection to an EKM server. Users will be logged into their default workspace.

Parameters:

  host | The address of the EKM server (e.g. http://localhost:8080)
  userType | The type of user logging in
  token | The token for the type of user logging in
  workspace | The EKM workspace to use

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Open | ( | string | host,
|  | string | username,
|  | string | password,
|  | string | workspace,
|  | bool | closeExisting
| ) |  | `[inline, static]`

Opens a connection to an EKM server. Users will be logged into the specified workspace if permitted.

Parameters:

  host | The address of the EKM server (e.g. http://localhost:8080)
  username | The EKM user
  password | The EKM user's password
  workspace | The EKM workspace to use
  closeExisting | If a user's existing session should be closed or not

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Open | ( | string | host,
|  | string | username,
|  | string | password
| ) |  | `[inline, static]`

Opens a connection to an EKM server. Users will be logged into the default workspace assigned to them.

Parameters:

  host | The address of the EKM server (e.g. http://localhost:8080)
  username | The EKM user
  password | The EKM user's password

Returns:
  Returns a Connection instance.

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static Connection com::ansys::ingress::client::api::ConnectionFactory::Open | ( | string | host,
|  | string | username,
|  | string | password,
|  | string | workspace
| ) |  | `[inline, static]`

Opens a connection to an EKM server. Users will be logged into the specified workspace if permitted.

Parameters:

  host | The address of the EKM server (e.g. http://localhost:8080)
  username | The EKM user
  password | The EKM user's password
  workspace | The EKM workspace to use

Exceptions:

  ConnectionException | Thrown if the connection could not be opened.

static void com::ansys::ingress::client::api::ConnectionFactory::Shutdown | ( |  | ) | `[inline, static]`

Shuts down any processes started by the EKM client API.

The documentation for this class was generated from the following file:

- ConnectionFactory.cs

All Classes Namespaces Functions Variables Enumerations Properties