Connects to and associates a Web service instance with the specified server handle. The current application becomes a client application of the connected Web service.
Return type: LOGICAL
Applies to: Server object handle
The following table describes each Web service connection parameter you can include in this string. This method ignores any other strings included in this parameter.
| Parameter | Description |
|---|---|
| -WSDL wsdl-document | The location of the WSDL document. This
required parameter is the URL, UNC, or local file pathname to the WSDL file
that describes the Web service. The document can be local or remote. The
location can optionally contain a user's account name and password to use when
connecting to the Web Server. For more information, see -WSDL parameter security
options. If the protocol is not part of the wsdl-document's URL, the ‘file' protocol is assumed. Additionally, the ‘file' can be a relative pathname as it is relative to the current working directory. |
| -WSDLUserid user-id | Optional user account name to use in connecting to the Web service that hosts the WSDL document. If -WSDLUserid is specified and -WSDLPassword is not, the AVM uses a blank password. |
| -WSDLPassword password | Optional password to use with -WSDLUserid. This attribute is ignored if -WSDLUserid is not specified. |
| -WSDLAuth Authentication-type | Specifies if access to a WSDL file requires
SSL client authentication. Set this to ssl to enable client authentication for WSDL access. If you set this to basic, the connect method ignores client authentication for WSDL access. |
-WSDLKeyFile filename | target-database |
The location of the client certificate. If you do not specify an absolute path of the client certificate file, the connection operation searches the $DLC/keys folder for the client-certificate-file-name.pem file. This option must be set only if -WSDLAuth parameter is set to ssl. |
| -WSDLKeyPwd password | The SSL client certificate password in clear text or encoded format. |
| -SSLAuth Authentication-type | Specifies if access to a SOAP service
requires SSL client authentication. Set this to ssl to enable client authentication for SOAP access. If you set this to basic, the connect method ignores client authentication for SOAP access. |
-SSLKeyFile filename | target-database |
The location of the client certificate. If you do not specify an absolute path of the client certificate file, the connection operation searches the $DLC/keys folder for the client-certificate-file-name.pem file.This option must be set only if -SSLAuth parameter is set to ssl. |
| -SSLKeyPwd password | The SSL client certificate password in clear text or encoded format. |
| -Service service-name | The local name of the service element within the WSDL document that the application will use. This field is optional. Many WSDL documents only support one service and this parameter is optional if there is only one (or zero) service elements defined. Used in conjunction with -Port. |
| -ServiceNamespace service-namespace | The namespace of the service element within the WSDL document that the application will use. Most WSDL documents only support one service and this parameter is optional if there is only one service defined. This parameter is used in conjunction with -Service and is ignored if -Service was not specified. This parameter is optional, if the namespace is included in -Service. |
| -Port port-name | The local name of the port element contained within the service element. Used in conjunction with -Service. This parameter is optional if -Service contains only one port. |
| -Binding binding-name | The local name of the binding element contained in the WSDL document. Used in conjunction with -SoapEndpoint. This parameter is optional if the WSDL contains only one binding. |
| -BindingNamespace binding-namespace | The namespace of the binding element within the WSDL document that the application will use. This optional field is needed only if the local binding-name is not unique. |
| -SOAPEndpoint URL-endpoint | The URL identifying the endpoint for this Web service. Used in conjunction with -Binding. It is an error to use this parameter in conjunction with -Service or -Port. |
| -SOAPEndpointUserid user-id | Optional user account name to use to connect to a Web service that hosts the Web Server application. If -SOAPEndpointUserid is specified and -SOAPEndpointPassword is not, the AVM uses a blank password. |
| -SOAPEndpointPassword password | Optional password to use with the -SoapEndpointUserid. This attribute is ignored if -SoapEndpointUserid is not specified. |
| -TargetNamespace targetNamespace | The namespace contained in the WSDL document. This parameter can be used as a version check. The information in this parameter is compared against the -TargetNamespace contained in the WSDL document. If they do NOT match the CONNECT ( ) method fails. |
| -connectionLifetime nSeconds | The maximum number of seconds that a given
connection can be reused for asynchronous requests before it is destroyed.
Connections whose lifetime exceeds the specified value are destroyed as they
become available. An available connection is one that is not currently
reserved to run an asynchronous request. The default value is 300 seconds. |
| -maxConnections num-connections | Maximum number of connections maintained
between the client and the Web Server for asynchronous requests. If num
connections is less than or equal to 0, the application is requesting no
predefined limit on the number of connections. If the client application
exceeds the specified number of connections, the asynchronous requests are
queued. The default value is 0. |
| -nosessionreuse | If specified, the connection does not reuse the SSL session ID when reconnecting to the same HTTPS-enabled Web server. |
| -nohostverify | If specified, turns off host verification for an HTTPS Web server connection. Without this parameter specified, the client compares the host name specified in the connection with the Common Name specified in the server certificate, and raises an error if they do not match. With this parameter specified, the client never raises the error. For more information, see Learn about Security and Auditing. |
| -clientConnectTimeout nMilliseconds | The number of milliseconds to wait before timing out each connection attempt. |
| -pf filename | A text file containing any of the other Web service binding parameters described in this table. If this file contains any other OpenEdge startup parameters, this method ignores them. |
The -WSDL parameter can optionally contain a user account name and password to use to connect to a Web Server.
This is the syntax for specifying the parameter using the HTTP and HTTPS protocols, respectively:
Instead of building the account name and password into the WSDL string, you can specify the account name using the -WSDLUserid parameter and the password using the -WSDLPassword parameter. If these parameters are used and the WSDL URL (WSDL-path) also contains a user id and password, the information on the WSDL URL is used.
The CONNECT( ) method is used to connect an ABL SERVER object to a specific application service. This service can be either an AppServer or a Web service. Independent of the type of application service to which the client is connecting, the client needs to provide the location of the service and transport information. There are two mechanisms for providing this information when connecting to a Web service:
If the WSDL document contains several service elements, the CONNECT method must identify which service element the client wants to connect to, via -Service. If the WSDL document only identifies one service element, the CONNECT method does not need to contain the service element name. Similarly if the WSDL document (or if the identified service element) only identifies one port element, the CONNECT method does not need to contain the port element name.
If the application needs to provide account name and password information, it can accomplish this by providing the account name and password information in the -SoapEndpointUserid and -SoapEndpointPassword parameters.
If the WSDL document identifies multiple service elements with the same local name, the CONNECT ( ) method must also contain the -ServiceNamespace connection parameter.
If the application needs to provide account name and password information, it can accomplish this by providing the account name and password information in the -SoapEndpointUserid and -SoapEndpointPassword parameters.
If the WSDL document identifies multiple binding elements with the same local name, the CONNECT( ) method must also contain the -BindingNamespace connection parameter.
If an error occurs while executing the CONNECT( ) method, the method returns FALSE. Otherwise, it returns TRUE. An error can occur if:
If the CONNECT( ) method completes successfully, the CONNECTED( ) method returns TRUE.
The connection lasts until the client application executes the server handle DISCONNECT( ) method or until the AVM detects any failure condition that automatically terminates the connection.