class for SOAP connections; returns an object of class SoapClient for connecting to SOAP servers
More...
#include <SoapClient.qm.dox.h>
|
| constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) |
| creates the SoapConnection object
|
|
string | getType () |
| returns "soap"
|
|
*hash< auto > | getRuntimeOptions () |
| returns runtime options
|
|
DataProvider::AbstractDataProvider | getDataProvider () |
| returns a data provider object for this connection
|
|
bool | hasDataProvider () |
| returns True as this connection returns a data provider with the getDataProvider() method
|
|
|
const | ConnectionScheme |
| Connection entry info.
|
|
|
SoapClient | getImpl (bool connect=True, *hash< auto > rtopts) |
| returns a SoapClient object
|
|
hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
| Returns the ConnectionSchemeInfo hash for this object.
|
|
class for SOAP connections; returns an object of class SoapClient for connecting to SOAP servers
supports all HttpConnection options plus the following static initialization options:
"service"
: the name of the "service" to use (if more than 1 service is defined in the WSDL then this key is mandatory)
"port"
: in case multiple port entries are found in the WSDL, give the one to be used here
"target_url"
: overrides the URL in the WSDL (mapped to "url"
in the SoapClient::constructor() argument)
"wsdl"
: overrides the WSDL URL provided by the connection URL; "wsdl"
values with a "file://"
scheme are subject to environment variable substitution
- See also
- SoapClient::constructor(hash) for more information on the above options
- Note
- additionally supports the following runtime options in getImpl() for connection logging:
"log"
: a closure accepting a single string for logging
"dbglog"
: a closure taking a single string for detailed technical connection logging
◆ constructor()
SoapConnection::constructor |
( |
string | name, |
|
|
string | description, |
|
|
string | url, |
|
|
hash< auto > | attributes = {}, |
|
|
hash< auto > | options = {} ) |
creates the SoapConnection object
- Parameters
-
name | the name of the connection |
description | connection description |
url | connection URL (potentially with password info) |
attributes | various attributes. See below |
options | connection options |
See AbstractConnection::constructor() for attributes
and options
reference.
◆ getDataProvider()
DataProvider::AbstractDataProvider SoapConnection::getDataProvider |
( |
| ) |
|
returns a data provider object for this connection
- Returns
- a data provider object for this connection
- See also
- hasDataProvider()
◆ getImpl()
SoapClient SoapConnection::getImpl |
( |
bool | connect = True, |
|
|
*hash< auto > | rtopts ) |
|
protected |
returns a SoapClient object
- Parameters
-
connect | if True, then SoapClient::connect() is called |
rtopts | supports the following runtime options in getImpl() for connection logging:
"log" : a closure accepting a single string for logging
"dbglog" : a closure taking a single string for detailed technical connection logging
|
- Returns
- a SoapClient object
◆ getRuntimeOptions()
*hash< auto > SoapConnection::getRuntimeOptions |
( |
| ) |
|
returns runtime options
- Returns
- a hash with the following keys reflecting support for the corresponding runtime options in getImpl() for connection logging:
"log"
: a closure accepting a single string for logging
"dbglog"
: a closure taking a single string for detailed technical connection logging
◆ hasDataProvider()
bool SoapConnection::hasDataProvider |
( |
| ) |
|
The documentation for this class was generated from the following file:
- doxygen/qlib/SoapClient/SoapClient.qm.dox.h