XML::Compile::SOAP::Operation - base-class for possible interactions
XML::Compile::SOAP::Operation is extended by XML::Compile::SOAP11::Operation XML::Compile::SOAP12::Operation
# created by XML::Compile::WSDL11 my $op = $wsdl->operation('GetStockPrices');
These objects are created by XML::Compile::WSDL11, grouping information about a certain specific message interchange between a client and a server.
-Option --Default action undef endpoints [] kind <required> name <required> schemas <required> server_type undef transport 'HTTP'
Some string which is referring to the action which is taken. For SOAP protocols, this defines the soapAction header.
Where to contact the server.
This returns the type of operation this is. There are four kinds, which are returned as strings one-way, request-response, sollicit-response, and notification. The latter two are initiated by a server, the former two by a client.
one-way
request-response
sollicit-response
notification
Most server implementations show some problems. Also, servers may produce responses using their own namespaces (like for error codes). When you know which server you are talking to, the quirks of the specific server type can be loaded. Read more in the "Supported servers" in XML::Compile::SOAP.
HTTP is short for http://schemas.xmlsoap.org/soap/http/, which is a constant to indicate that transport should use the HyperText Transfer Protocol.
HTTP
http://schemas.xmlsoap.org/soap/http/
Returns the class name which implements the Client side for this protocol.
Returns the list of alternative URLs for the end-point, which should be defined within the service's port declaration.
[3.06] prefix the service name before the operation name, to make it really unique. A # is used as separator.
#
Returns the class name which implements the Server side for this protocol.
Used for the soapAction header in HTTP transport, for routing messages through firewalls.
soapAction
Only available when XML::Compile::SOAP::WSA is loaded. It specifies the name of the operation in the WSA header. With INPUT, it is the Action to be used with a message sent to the server (input to the server). The OUTPUT is used by the server in its message back.
XML::Compile::SOAP::WSA
INPUT
OUTPUT
Returns one CODE reference which handles the conversion from a perl data-structure into a request message, the transmission of the request, the receipt of the answer, and the decoding of that answer into a Perl data-structure.
Returns a code reference which translates in incoming XML message into Perl a data-structure, then calls the callback. The result of the callback is encoded from Perl into XML and returned.
-Option --Default callback <required>
Create the transporter code for a certain specific target.
-Option --Default endpoint <from WSDL> server undef transport_hook undef transporter <created>
Overrule the destination address(es).
Overrule only the server part in the endpoint, not the whole endpoint. This could be a string like username:password@myhost:4711. Only used when no explicit endpoint is provided.
username:password@myhost:4711
endpoint
Passed to XML::Compile::Transport::compileClient(hook). Can be used to create off-line tests and last resort work-arounds. See the DETAILs chapter in the XML::Compile::Transport manual page.
The routine which will be used to exchange the data with the server. This code is created by an XML::Compile::Transport::compileClient() extension.
By default, a transporter compatible to the protocol is created. However, in most cases you want to reuse one (HTTP1.1) connection to a server.
[3.14] You may provide a XML::Compile::Transport object as well. Its compileClient() will be called for you.
Dump an annotated structure showing how the operation works, helping developers to understand the schema. $format is PERL or XML.
PERL
XML
The $direction is INPUT, it will return the message which the client sends to the server (input for the server). The OUTPUT message is sent as response by the server.
[2.29] For some purposes, it is useful to get access to the parsed WSDL structure.
Be aware that the structure returned is consided "internal" and strongly influenced by behavior of XML::Compile; backwards compatibility will not be maintained at all cost.
You can use XML::Compile::Schema::template() format TREE to get more details about the element types mentioned in this structure.
TREE
example:
use Data::Dumper; $Data::Dumper::Indent = 1; $Data::Dumper::Quotekeys = 0; print Dumper $op->parsedWSDL;
This module is part of XML-Compile-SOAP distribution version 3.26, built on November 20, 2019. Website: http://perl.overmeer.net/CPAN/
Copyrights 2007-2019 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://dev.perl.org/licenses/
To install XML::Compile::SOAP, copy and paste the appropriate command in to your terminal.
cpanm
cpanm XML::Compile::SOAP
CPAN shell
perl -MCPAN -e shell install XML::Compile::SOAP
For more information on module installation, please visit the detailed CPAN module installation guide.