EKM Client API

- Main Page
- Namespaces
- Classes

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

Public Member Functions
com::ansys::ingress::client::api::Connection Interface Reference

Connection represents a connection to an EKM server. It provides access to the managers used to perform various operations on the server. It also defines the methods used to manage persistent connections. More...

List of all members.

## Public Member Functions

string | Close (bool save=false, bool force=false)
| Closes this connection.
void | Close (string name, bool force=false)
| Closes the connection and saves it using the given name.
void | Delete ()
| Deletes this connection. If the connection is currently open, the connection is closed first.
AdministrationManager | GetAdministrationManager ()
| Gets the object for this connection that provides access to administration operations. This includes managing users and groups.
DataManager | GetDataManager ()
| Gets the object for this connection that provides access to data management operations. This includes C.R.U.D., version control, locking, and file transfers.
Uri | GetLocation ()
| Gets the location of the EKM server associated with this connection.
RsmJobManager | GetRsmJobManager ()
| Gets the object for this connection that provides access to job management operations. This includes TODO.
string | GetName ()
| Gets the name of this connection if it has been previously saved.
string | GetUsername ()
| Gets the EKM username associated with this connection.
string | GetWorkspace ()
| Gets the current EKM workspace being used by this connection.
List< string > | GetWorkspaces ()
| Gets the list of EKM workspaces available to the current user.
bool | HasSavedCredentials ()
| Determines if this connection has saved credentials or not.
bool | IsAdminUser ()
| Determines if the user associated with the connection is an admin user.
bool | IsLoggedIn ()
| Determines if the user of this connection is currently logged in or not.
bool | IsOpen ()
| Determines if this connection is opened or not.
bool | IsSaved ()
| Determines if this is a persisted connection or not.
bool | IsSessionValid ()
| Determines if the EKM session associated with this connection is still valid or not.
string | Save (bool saveCredentials=false)
| Saves this connection so that it can be opened at a later time. The workspace currently used by the connection is the one that will be used the next time the connection is opened. If this connection was not previously saved, a name is generated for the connection. The format of the generated name is workspace@hostname[n] where workspace is the EKM workspace currently being used, hostname is the EKM server, and n is a unique number (e.g. Default@localhost1)
void | Save (string name, bool saveCredentials=false)
| Saves this connection so that it can be opened at a later time. The workspace currently used by the connection is the one that will be used the next time the connection is opened. The credentials used to open the connection are stored in an encrypted format on the local machine.
void | SetWorkspace (string workspace)
| Sets the EKM workspace to be used by this connection.

## Detailed Description

Connection represents a connection to an EKM server. It provides access to the managers used to perform various operations on the server. It also defines the methods used to manage persistent connections.

## Member Function Documentation

string com::ansys::ingress::client::api::Connection::Close | ( | bool | save = `false`,
|  | bool | force = `false`
| ) |  |

Closes this connection.

Parameters:

  save | If the connection should be saved or not. This is false by default.
  force | If the connection should be forced close or not. This is false by default.

Returns:
  Returns the name fo the connection if directed to save it.

void com::ansys::ingress::client::api::Connection::Close | ( | string | name,
|  | bool | force = `false`
| ) |  |

Closes the connection and saves it using the given name.

Parameters:

  name | the name for the connection
  force | If the connection should be forced close or not. This is false by default.

void com::ansys::ingress::client::api::Connection::Delete | ( |  | ) |

Deletes this connection. If the connection is currently open, the connection is closed first.

AdministrationManager com::ansys::ingress::client::api::Connection::GetAdministrationManager | ( |  | ) |

Gets the object for this connection that provides access to administration operations. This includes managing users and groups.

Returns:
  Returns an AdministrationManager instance.

Exceptions:

  ConnectionException | Thrown if the connection is not open.

DataManager com::ansys::ingress::client::api::Connection::GetDataManager | ( |  | ) |

Gets the object for this connection that provides access to data management operations. This includes C.R.U.D., version control, locking, and file transfers.

Returns:
  Returns a DataManager instance.

Exceptions:

  ConnectionException | Thrown if the connection is not open.

Uri com::ansys::ingress::client::api::Connection::GetLocation | ( |  | ) |

Gets the location of the EKM server associated with this connection.

Returns:
  Returns the EKM server's location.

string com::ansys::ingress::client::api::Connection::GetName | ( |  | ) |

Gets the name of this connection if it has been previously saved.

Returns:
  Returns the name of this connection if it has been saved. Otherwise, it will return null.

RsmJobManager com::ansys::ingress::client::api::Connection::GetRsmJobManager | ( |  | ) |

Gets the object for this connection that provides access to job management operations. This includes TODO.

Returns:
  Returns a JobManager instance.

Exceptions:

  ConnectionException | Thrown if the connection is not open.

string com::ansys::ingress::client::api::Connection::GetUsername | ( |  | ) |

Gets the EKM username associated with this connection.

Returns:
  Returns the username.

string com::ansys::ingress::client::api::Connection::GetWorkspace | ( |  | ) |

Gets the current EKM workspace being used by this connection.

Returns:
  Returns the EKM workspace.

List<string> com::ansys::ingress::client::api::Connection::GetWorkspaces | ( |  | ) |

Gets the list of EKM workspaces available to the current user.

Returns:
  Returns the list of available EKM workspaces.

Exceptions:

  ConnectionException | Thrown if the connection is not open.

bool com::ansys::ingress::client::api::Connection::HasSavedCredentials | ( |  | ) |

Determines if this connection has saved credentials or not.

Returns:
  Returns true if the connection has saved credentials.

bool com::ansys::ingress::client::api::Connection::IsAdminUser | ( |  | ) |

Determines if the user associated with the connection is an admin user.

Returns:
  Returns true if the user is an admin user.

bool com::ansys::ingress::client::api::Connection::IsLoggedIn | ( |  | ) |

Determines if the user of this connection is currently logged in or not.

Returns:
  Returns true if the user is logged in.

bool com::ansys::ingress::client::api::Connection::IsOpen | ( |  | ) |

Determines if this connection is opened or not.

Returns:
  Returns true if the connection is open.

bool com::ansys::ingress::client::api::Connection::IsSaved | ( |  | ) |

Determines if this is a persisted connection or not.

Returns:
  Returns true if this connection has been previously saved.

bool com::ansys::ingress::client::api::Connection::IsSessionValid | ( |  | ) |

Determines if the EKM session associated with this connection is still valid or not.

Returns:
  Returns true if the session is valid.

string com::ansys::ingress::client::api::Connection::Save | ( | bool | saveCredentials = `false` | ) |

Saves this connection so that it can be opened at a later time. The workspace currently used by the connection is the one that will be used the next time the connection is opened. If this connection was not previously saved, a name is generated for the connection. The format of the generated name is workspace@hostname[n] where workspace is the EKM workspace currently being used, hostname is the EKM server, and n is a unique number (e.g. Default@localhost1)

Parameters:

  saveCredentials | Whether credentials should be saved or not

Returns:
  Returns the name of the saved connection.

void com::ansys::ingress::client::api::Connection::Save | ( | string | name,
|  | bool | saveCredentials = `false`
| ) |  |

Saves this connection so that it can be opened at a later time. The workspace currently used by the connection is the one that will be used the next time the connection is opened. The credentials used to open the connection are stored in an encrypted format on the local machine.

Parameters:

  name | The name of the connection
  saveCredentials | Whether credentials should be saved or not

void com::ansys::ingress::client::api::Connection::SetWorkspace | ( | string | workspace | ) |

Sets the EKM workspace to be used by this connection.

Parameters:

  workspace | The EKM workspace to use

This is false by default.

Exceptions:

  EkmException | Thrown if the user does not have access to the given workspace.
  ConnectionException | Thrown if the connection is not open.

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

- Connection.cs

All Classes Namespaces Functions Variables Enumerations Properties