main class representing a parsed WSDL file More...

#include <WSDL.qm.dox.h>

Inheritance diagram for WSDL::WebService:

Public Member Methods
transient list< string >	wsdl_services ()
	list of services in this WSDL

transient hash< string, XsdElement >	idocmap ()
	a hash of element names to XsdElement objects for top-level document-style bindings

transient hash< string, hash< string, XsdElement > >	emap ()
	map of elements

transient hash< string, WSMessage >	messages ()
	hash of messages names to messages

transient hash< string, XsdAbstractType >	tmap ()
	map of types

transient hash< string, hash< PortTypeInfo > >	portType ()
	hash of port names to port type information hashes

	constructor (string str, *hash< auto > opts)
	creates the WebService object

string	getName ()
	returns the name of the service

synchronized string	getHash ()
	returns a unique hash for the WSDL that can be used to compare schemas for equality

WSDL::WSOperation	getOperation (string opname)
	returns the given operation or throws an exception if it cannot be found; operations are searched in portTypes in the order they are declared

softlist< string >	getOperationNames ()
	returns a list of known operation names

WSDL::WSOperation	getPortTypeOperation (string ptname, string opname)
	returns the given operation for particular porttype or throws an exception if it cannot be found

WSDL::WSOperation	getBindingOperation (*string bname, string opname)
	returns the given operation for particular binding or throws an exception if it cannot be found

list< hash< OperationInfo > >	listOperations ()
	returns a list of hashes giving supported operation names for each port in the WSDL

WSDL::Binding	getBinding (string name)
	return a WSDL::Binding object describing the requested binding

list< hash< WSDL::ServiceInfo > >	listServices ()
	returns a list of services defined in the WSDL

hash< WSDL::ServiceInfo >	getService (string name)
	returns a hash describing the requested service

hash< auto >	getType (string name, auto v)
	return a hash value that can be used to serialize a value as a particular type

bool	isSoap12 ()
	returns True if the WSDL describes a SOAP 1.2 service

string	getWSDL ()
	returns the XML string for the WSDL

string	getWSDLHash ()
	returns a cryptographic hash for the WSDL source

string	getWSDL (string base_url)
	returns the XML string for the WSDL, adjusting the URLs for binding locations depending on the caller

	getReport (StringOutputStream stream, *string wsdl_name)
	prepare a WebService report enumerating the services and operations of the WSDL, outputs to the output stream given as the first argument

string	getReport (*string wsdl_name)
	prepare a WebService report enumerating the services and operations of the WSDL

Public Attributes
string	wsdl
	the WSDL string

string	wsdl_hash
	a cryptographic hash for the WSDL source

*hash< auto >	opts
	options used in the constructor

bool	has_try_import = False
	flag if the object has a "try_import" closure or call reference

string	name
	the name of the WebService

string	hash_str
	the digest of the WSDL source

transient Namespaces	nsc
	namespace container

transient *code	try_import
	optional closure/call reference to try to resolve import declarations

transient *string	def_path
	default path for retrieving XSD references

Private Attributes
transient hash< string, bool >	import_map
	issue #4449: map of imports used while parsing

Detailed Description

main class representing a parsed WSDL file

This is the main class for handling SOAP communication and is based on a WSDL file

Member Function Documentation

◆ constructor()

WSDL::WebService::constructor	(	string	str,
		*hash< auto >	opts
	)

creates the WebService object

Parameters

str the XML string representing the WSDL

opts

an optional hash of options with the following possible keys:

"compat_allow_any_header": allow any SOAP header to be sent without checking the WSDL
"compat_empty_string_is_nothing": deserialize empty strings to nothing instead of an empty string
"def_path": the default path to use when retrieving referenced XSDs
"try_import": a call reference or closure to be passed a string name for XSD imports without any scheme to retrieve the data, must take a string argument (the resource name) and return a string (the resource data)
"http_client": a HTTPClient object for retrieving data from import commands
"http_headers": a hash of optional HTTP header info to use when retrieving data from import commands

Since: 0.3.7 added the "compat_empty_string_is_nothing" and "compat_allow_any_header" options for backwards compatibility

◆ getBinding()

WSDL::Binding WSDL::WebService::getBinding ( string name )

return a WSDL::Binding object describing the requested binding

Parameters

name	the name of the binding

Returns: a WSDL::Binding object

Exceptions

WSDL-BINDING-ERROR unknown binding

◆ getHash()

synchronized string WSDL::WebService::getHash ( )

returns a unique hash for the WSDL that can be used to compare schemas for equality

Returns: a unique hash for the WSDL that can be used to compare schemas for equality

Since: WSDL 0.5

◆ getName()

string WSDL::WebService::getName ( )

returns the name of the service

Returns: the name of the service

Since: WSDL 0.5

◆ getOperation()

WSDL::WSOperation WSDL::WebService::getOperation ( string opname )

returns the given operation or throws an exception if it cannot be found; operations are searched in portTypes in the order they are declared

Exceptions

WSDL-OPERATION-ERROR if the operation is unknown

◆ getReport() [1/2]

string WSDL::WebService::getReport ( *string wsdl_name )

prepare a WebService report enumerating the services and operations of the WSDL

Parameters

wsdl_name name of the WSDL, typically a file name

Returns: human readable text report

◆ getReport() [2/2]

WSDL::WebService::getReport	(	StringOutputStream	stream,
		*string	wsdl_name
	)

prepare a WebService report enumerating the services and operations of the WSDL, outputs to the output stream given as the first argument

Parameters

stream	the output stream for the report data
wsdl_name	name of the WSDL, typically a file name

Returns: human readable text report

◆ getService()

hash< WSDL::ServiceInfo > WSDL::WebService::getService ( string name )

returns a hash describing the requested service

Parameters

name	the name of the service

Returns

a hash describing the service with the following keys:

"name": the name of the service
"port": a hash of port information; where each hash<auto> is keyed by port name and the values have the following keys:
- "address": the location of the port
- "binding": the binding of the port

Exceptions

WSDL-SERVICE-ERROR the service is not known

◆ getWSDL() [1/2]

string WSDL::WebService::getWSDL ( )

returns the XML string for the WSDL

Returns: the XML string for the WSDL

◆ getWSDL() [2/2]

string WSDL::WebService::getWSDL ( string base_url )

returns the XML string for the WSDL, adjusting the URLs for binding locations depending on the caller

Parameters

base_url the url to be prepended before the service name; it must include all the handler prefixes (like /SOAP) to produce valid URL

Returns: the XML string for the WSDL

◆ getWSDLHash()

string WSDL::WebService::getWSDLHash ( )

returns a cryptographic hash for the WSDL source

Returns: a cryptographic hash for the WSDL source

◆ isSoap12()

bool WSDL::WebService::isSoap12 ( )

returns True if the WSDL describes a SOAP 1.2 service

Returns: True if the WSDL describes a SOAP 1.2 service

◆ listOperations()

list< hash< OperationInfo > > WSDL::WebService::listOperations ( )

returns a list of hashes giving supported operation names for each port in the WSDL

Returns

a list of hashes giving supported operation names for each port in the WSDL; each hash<auto> has the following keys:

"port": the name of the port defining the operation
"operation": the WSDL::WSOperation object for the operation

◆ listServices()

list< hash< WSDL::ServiceInfo > > WSDL::WebService::listServices ( )

returns a list of services defined in the WSDL

Returns

a list of hashes of services defined in the WSDL; each hash<auto> has the following keys:

"name": the name of the service
"port": a hash of port information; the keys are port names and the values have the following keys:
- "address": the location of the port
- "binding": the binding of the port

Member Data Documentation

◆ def_path

transient *string WSDL::WebService::def_path

default path for retrieving XSD references

Note: there is no need to serialize def_path as it will be set with the saved options

◆ hash_str

string WSDL::WebService::hash_str

the digest of the WSDL source

Since: WSDL 0.5

◆ name

string WSDL::WebService::name

the name of the WebService

Since: WSDL 0.5

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

doxygen/qlib/WSDL/WSDL.qm.dox.h

Public Member Methods

Public Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ constructor()

◆ getBinding()

◆ getHash()

◆ getName()

◆ getOperation()

◆ getReport() [1/2]

◆ getReport() [2/2]

◆ getService()

◆ getWSDL() [1/2]

◆ getWSDL() [2/2]

◆ getWSDLHash()

◆ isSoap12()

◆ listOperations()

◆ listServices()

Member Data Documentation

◆ def_path

◆ hash_str

◆ name