SoapClient::SoapConnection Class Reference

class for SOAP connections; returns an object of class SoapClient for connecting to SOAP servers More...

Inherits HttpBasedConnection.

Public Member Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash< auto > n_opts, hash< auto > urlh)
	DEPRECATED: creates the SoapConnection object. More...
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the SoapConnection object More...
string	getType ()
	returns "soap"
*hash< auto >	getRuntimeOptions ()
	returns runtime options More...
hash< auto >	getOptions ()
	gets options
*hash< auto >	getDefaultOptions ()
	returns default options
DataProvider::AbstractDataProvider	getDataProvider ()
	returns a data provider object for this connection More...
bool	hasDataProvider ()
	returns True as this connection returns a data provider with the getDataProvider() method More...

Static Public Member Methods
static deprecated SoapConnection	make (string name, string desc, string url, bool monitor, *hash< auto > opts, hash< auto > urlh)
	DEPRECATED: static constructor. More...

Private Member Methods
SoapClient	getImpl (bool connect=True, *hash< auto > rtopts)
	returns a SoapClient object More...

Detailed Description

class for SOAP connections; returns an object of class SoapClient for connecting to SOAP servers

supports the following static initialization options:

• "connect_timeout": connection timeout to use in milliseconds
• "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
• "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
• "max_redirects": maximum redirects to support
• "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
• "proxy": proxy URL to use
• "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
• "target_url": overrides the URL in the WSDL (mapped to "url" in the SoapClient::constructor() argument)
• "timeout": transfer timeout to use in milliseconds
• "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

Member Function Documentation

constructor() [1/2]

deprecated SoapClient::SoapConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash< auto >	n_opts,
		hash< auto >	urlh
	)

DEPRECATED: creates the SoapConnection object.

Parameters

name	the name of the connection
desc	connection description
url	connection URL
monitor	monitoring flag
n_opts	connection options
urlh	broken down URL hash (as returned by Qore::parse_url())

Deprecated:

since Qore 0.9

constructor() [2/2]

SoapClient::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 SoapClient::SoapConnection::getDataProvider

(

)

returns a data provider object for this connection

Returns

a data provider object for this connection

See also

hasDataProvider()

getImpl()

SoapClient SoapClient::SoapConnection::getImpl ( bool  connect = True, *hash< auto >  rtopts  )

private

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> SoapClient::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 SoapClient::SoapConnection::hasDataProvider

(

)

returns True as this connection returns a data provider with the getDataProvider() method

Returns

True as this connection returns a data provider with the getDataProvider() method

See also

getDataProvider()

make()

static deprecated SoapConnection SoapClient::SoapConnection::make ( string  name, string  desc, string  url, bool  monitor, *hash< auto >  opts, hash< auto >  urlh  )

static

DEPRECATED: static constructor.

Deprecated:

since Qore 0.9 in favor of new constructor and Qore::Reflection