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.
Extends "DESCRIPTION" in XML::Compile::SOAP::Operation.
Extends "METHODS" in XML::Compile::SOAP::Operation.
Extends "Constructors" in XML::Compile::SOAP::Operation.
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> kind XML::Compile::SOAP::Operation <required> name XML::Compile::SOAP::Operation <required> output_def <undef> schemas XML::Compile::SOAP::Operation <required> server_type XML::Compile::SOAP::Operation undef style 'document' transport XML::Compile::SOAP::Operation 'HTTP'
Extends "Accessors" in XML::Compile::SOAP::Operation.
Inherited, 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. An $element is either a full type or a [3.00] prefixed type.
-Option --Default destination undef mustUnderstand undef
[2.33] adds the destination attribute.
[2.33] adds the mustUnderstand attribute.
Extends "Handlers" in XML::Compile::SOAP::Operation.
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 successful.
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.
Inherited, see "Handlers" in XML::Compile::SOAP::Operation
Extends "Helpers" in XML::Compile::SOAP::Operation.
[since 2.13]
Dump an annotated structure showing how the operation works, helping developers to understand the schema. The $format must be string "PERL". ($format "XML" is not yet supported)
When the $direction is string "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.
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.
Inherited, see "Helpers" in XML::Compile::SOAP::Operation
This module is part of XML-Compile-SOAP distribution version 3.28, built on August 01, 2022. Website: http://perl.overmeer.net/CPAN/
Copyrights 2007-2022 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.