SoapClient::SoapConnection Class Reference

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

#include <SoapClient.qm.dox.h>

Inherits HttpBasedConnection.

Public Member Methods
void	constructor (string url, hash< auto > attributes, string name, string description, hash< auto > options)
	creates the SoapConnection object
void	constructor (hash< auto > config, *hash< auto > attr)
	Creates the SoapConnection object.
string	getType ()
	returns "soap"
*hash< auto >	getRuntimeOptions ()
	returns runtime options
bool	hasDataProvider ()
	returns True as this connection returns a data provider with the getDataProvider method
bool	supportsPollingApi ()
	returns False
void	setChildCapabilities ()
	Set child capabilities.
SoapClient	getImpl (bool connect, *hash< auto > rtopts)
	returns a SoapClient object
hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.

Detailed Description

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

Member Function Documentation

constructor() [1/2]

void SoapClient::SoapConnection::constructor	(	hash< auto >	config,
		*hash< auto >	attr
	)

Creates the SoapConnection object.

Parameters

config

with the following keys: name (required string): the connection name display_name (optional string): the display name short_desc (optional string): a short description in plain text desc (optional string): a long description with markdown formatting url (required string): the connection URL opts (optional hash): connection options logger (optional LoggerInterface object): logger for the connection

attr

optional connection attributes monitor (optional bool): should the connection be monitored? Default: True enabled (optional bool): is the connection enabled? Default: True locked (optional bool): is the connection locked? Default: False debug_data (optional bool): debug data? Default: False tags (optional hash): tags for the connection; no default value

Exceptions

CONNECTION-OPTION-ERROR

missing or invalid connection option or attribute

constructor() [2/2]

void SoapClient::SoapConnection::constructor	(	string	url,
		hash< auto >	attributes,
		string	name,
		string	description,
		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.

getImpl()

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

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

supportsPollingApi()

bool SoapClient::SoapConnection::supportsPollingApi

(

)

returns False

This connection type has not yet been updated to support the Qore Socket-based polling API

Returns

False

---

The documentation for this class was generated from the following file:

• doxygen/qlib/SoapClient/SoapClient.qm.dox.h