CredentialService Interface

This service allows access to user credentials that are collected during logon to the SIMULIA Execution Engine server. Usually this consists (only) of a single user name and password. It is, by definition, exactly the user name and password used to authenticate the user on the SIMULIA Execution Engine server (and, thus, has been validated with the back-end security system configured in the SIMULIA Execution Engine).

If the connection profile used for logon is configured for “extended grid credentials,” two additional sets of credentials are also collected. These are a set of credentials for Windows and another set for Linux. These credentials are used in the SIMULIA Execution Engine grid environment when stations do not share the same security domain as the SIMULIA Execution Engine server.

Each set of credentials (server, extended grid Windows, and extended grid Linux) are represented by a CredentialData object. Even if an extension has credential privileges, some (or all) of the credentials may, in fact, not be available. For example, if extended grid credentials are not entered at user logon time, they will not be available to privileged extensions. In this case the CredentialData.isAvailable() method method will return FALSE.

In some cases, even the server credentials will not be available; for example, if the user logged on using a web-based interface and a SSO (Single Sign-On) security system. In this case, no credentials will be available at all.

A reference to this interface can be obtained by using the @Privileged and @CredentialServiceReference annotation in the extension classes.

The CredentialService methods are described below. See the javadoc API reference documentation delivered with Isight for the latest class and method descriptions. The Isight API is documented in web pages accessible from the file main.html, which can be found in the following directory:

<Isight_install_directory>/Doc/docs/api/_index

boolean isPrivilegeGranted() throws CredentialException

The isPrivilegeGranted() method returns true if the extension has been granted the “credentials” privilege. However, this does not ensure that all (or any) credentials are actually available. The isAvailable() method of the CredentialData should be checked to verify that the required credentials exist.

If this method returns FALSE, the extension has not been granted the “credentials” privilege and no credentials will be available.

CredentialData getServerCreds() throws CredentialException

Returns the credentials that were used to authenticate with the SIMULIA Execution Engine server. This method always returns a non-null object reference, but the CredentialData.isAvailable() method should be used to verify that the credentials are available.

This method never returns null.

CredentialData getExtendedWinCreds() throws CredentialException

Returns the extended grid Windows credentials that may have been specified during logon to the SIMULIA Execution Engine server. If no extended credentials were collected during logon, this method will return a CredentialData object on which the isAvailable() method will return FALSE.

This method never returns null.

CredentialData getExtendedUnixCreds() throws CredentialException

Returns the extended grid Linux credentials that may have been specified during logon to the SIMULIA Execution Engine server. If no extended credentials were collected during logon, this method will return a CredentialData object on which the isAvailable() method will return FALSE.

This method never returns null.