edmiDefineServerContextEx
EdmiError edmiDefineServerContextEx (SdaiString serverContextName, SdaiOptions options, SdaiString userName, SdaiString groupName, SdaiString password, SdaiString communicationType, SdaiString edmServerPortNumber, SdaiString edmServerHostName, SdaiString edmiTunnelName, SdaiString edmiTunnelPortNumber, SdaiString edmiTunnelHostName, SdaiString proxyServerPortNumber, SdaiString proxyServerName, SdaiServerContext *serverContextId);
Creates a detailed specification of the EDMInterface communication parameters for communication between an EDMclient and an EDMserver. A defined server context is identified by its unique numeric server context id. A server context id is a mandatory input parameter to all edmiRemote API function calls. Any number of server contexts may be defined in an EDMclient session at the same time, thereby allowing simultaneous access to any number of remote EDMdatabase located anywhere in the world by TCP or HTTP communication. SSO logon is enabled when the option USE_SINGLE_SIGN_ON is set in the "option" argument. The arguments "userName" and "password" have no effect (can be NULL or empty string) in an SSO enabled EDMserverContext. However these arguments have to be defined if wanting to use SINGLE_SIGN_ON_AND_OPTIONAL_EDM_DEFAULT_LOGON as the EDM_LOGON_METHOD
Arguments
1 | Type | Name | Comment |
2 | SdaiString | serverContextName | Optional name of the server context. Server context names must start with a character followed by any combination of alphanumeric characters and underscore. |
3 | SdaiOptions | options | |
4 | SdaiString | userName | The name of the edmUser to connect to the EDMserver. The edmUser name is case insensitive and mandatory. |
5 | SdaiString | groupName | The name of the edmGroup to connect to the EDMserver. The edmGroup name is case insensitive and optional. |
6 | SdaiString | password | The password of the edmUser specified by <userName>. The password parameter is mandatory. ( |
7 | SdaiString | communicationType | The nature of the communication with an EDMserver. Valid communication types are;
|
8 | SdaiString | edmServerPortNumber | The service port number used for remote communication with an EDMserver. Valid for <communicationType> “TCP” and “HTTP”. |
9 | SdaiString | edmServerHostName | The name or IP-address of the machine hosting the EDMserver to communicate with. Valid for <communicationType> “TCP” and “HTTP”. |
10 | SdaiString | edmiTunnelName | The name and full path of the HTTP Tunnel. Valid only for <communicationType> “HTTP”. |
11 | SdaiString | edmiTunnelPortNumber | The tunnel service port number used by the machine hosting the HTTP Tunnel. Used by the HTTP tunnel for controlling remote communication between an EDMserver and a thin EDMClient. Valid only for <communicationType> “HTTP”. |
12 | SdaiString | edmiTunnelHostName | The name or IP-address of the machine hosting the HTTP Tunnel. Valid only for <communicationType> “HTTP”. |
13 | SdaiString | proxyServerPortNumber | The service port number used for communication by the proxy server. Valid for <communicationType> “TCP” and “HTTP”. |
14 | SdaiString | proxyServerName | The name or IP-address of the machine hosting the proxy service. Valid for <communicationType> “TCP” and “HTTP” |
15 | SdaiServerContext | serverContextId | Variable that will receive the unique numeric identifier of the defined server context. |
Return Value
Options
Option | Comment |
USE_SSO | clients can only logon EDMserver by using SSO |
USE_KEYSTONE | clients can only logon EDMserver by using a keystone key |
Example
See also
Filter by label
There are no items with the selected labels at this time.