XML::Compile::SOAP11::Operation - defines a SOAP11 interaction
XML::Compile::SOAP11::Operation is a XML::Compile::SOAP::Operation
# object created by XML::Compile::WSDL* my $op = $wsdl->operation('GetStockPrices'); $op->explain($wsdl, PERL => 'INPUT', recurse => 1);
Objects of this type define one possible SOAP11 interaction, either client side or server side.
input_def, output_def and fault_def are HASHes which contain the input and output message header, body and fault-header definitions in WSDL1.1 style.
input_def
output_def
fault_def
-Option --Defined in --Default action XML::Compile::SOAP::Operation undef endpoints XML::Compile::SOAP::Operation [] fault_def <undef> input_def <undef> kin XML::Compile::SOAP::Operation <required> nam XML::Compile::SOAP::Operation <required> output_def <undef> schemas XML::Compile::SOAP::Operation <required> style 'document' transport XML::Compile::SOAP::Operation 'HTTP'
See "Accessors" in XML::Compile::SOAP::Operation
Operations are often modified by SOAP extensions. See XML::Compile::SOAP::WSA, for instance. Also demonstrated in the FAQ, XML::Compile::SOAP::FAQ.
Add a header definitions. Many protocols on top of SOAP, like WSS, add headers to the operations which are not specified in the WSDL.
[2.31] When you add a header with same LABEL again, it will get silently ignored unless the ELEMENT type differs.
-Option --Default destination undef mustUnderstand undef
[2.33] adds the destination attribute,
[2.33] adds the mustUnderstand attribute.
Returns one CODE reference which handles the processing for this operation. Options transporter, transport_hook, and endpoint are passed to compileTransporter().
transporter
transport_hook
endpoint
You pass that CODE reference an input message of the correct type, as pure Perl HASH structure. An 'request-response' operation will return then answer, or undef in case of failure. An 'one-way' operation with return undef in case of failure, and a true value when successfull.
undef
You cannot pass options for XML::Compile::Schema::compile(), like <sloppy_integers = 0>>, hooks or typemaps this way. Provide these to the ::WSDL or other ::Cache object which defines the types, via new option opts_rw and friends.
<sloppy_integers =
::WSDL
::Cache
new
opts_rw
Prepare the routines which will decode the request and encode the answer, as will be run on the server. The XML::Compile::SOAP::Server will connect these. All OPTIONS will get passed to XML::Compile::SOAP11::Server::compileHandler()
-Option --Default callback <required> selector <from input def>
Determines whether the handler belongs to a received message.
See "Handlers" in XML::Compile::SOAP::Operation
[since 2.13]
Dump an annotated structure showing how the operation works, helping developers to understand the schema. FORMAT is PERL. (XML is not yet supported)
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.
INPUT
OUTPUT
All OPTIONS besides those described here are passed to XML::Compile::Schema::template(), when recurse is enabled.
recurse
-Option --Default recurse <false> skip_header <false>
Append the templates of all the part structures.
[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;
See "Helpers" in XML::Compile::SOAP::Operation
This module is part of XML-Compile-SOAP distribution version 2.34, built on December 21, 2012. Website: http://perl.overmeer.net/xml-compile/
Other distributions in this suite: XML::Compile, XML::Compile::SOAP, XML::Compile::SOAP12, XML::Compile::SOAP::Daemon, XML::Compile::SOAP::WSA, XML::Compile::C14N, XML::Compile::WSS, XML::Compile::WSS::Signature, XML::Compile::Tester, XML::Compile::Cache, XML::Compile::Dumper, XML::Compile::RPC, XML::Rewrite, XML::eXistDB, and XML::LibXML::Simple.
Please post questions or ideas to the mailinglist at http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/xml-compile
For live contact with other developers, visit the #xml-compile channel on irc.perl.org.
#xml-compile
irc.perl.org
Copyrights 2007-2012 by [Mark Overmeer]. 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://www.perl.com/perl/misc/Artistic.html
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.