- SEE ALSO
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'
- action => STRING
Some string which is refering to the action which is taken. For SOAP protocols, this defines the soapAction header.
- endpoints => ADDRESS|ARRAY
Where to contact the server.
- kind => 'one-way'|...
This returns the type of operation this is. There are four kinds, which are returned as strings
notification. The latter two are initiated by a server, the former two by a client.
- name => STRING
- schemas => XML::Compile::Cache
- server_type => NAME
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.
- transport => URI|'HTTP'
HTTPis short for
http://schemas.xmlsoap.org/soap/http/, which is a constant to indicate that transport should use the HyperText Transfer Protocol.
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
soapActionheader in HTTP transport, for routing messages through firewalls.
Only available when
XML::Compile::SOAP::WSAis 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
OUTPUTis used by the server in its message back.
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>
- callback => CODE
Create the transporter code for a certain specific target.
-Option --Default endpoint <from WSDL> server undef transport_hook undef transporter <created>
- endpoint => URI|ARRAY-of-URI
Overrule the destination address(es).
- server => URI-HOST
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
- transport_hook => CODE
- transporter => CODE|XML::Compile::Transport-object
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.
- $obj->explain($wsdl, $format, $direction, %options)
Dump an annotated structure showing how the operation works, helping developers to understand the schema. $format is
The $direction is
INPUT, it will return the message which the client sends to the server (input for the server). The
OUTPUTmessage 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
TREEto get more details about the element types mentioned in this structure.
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.18, built on March 22, 2016. Website: http://perl.overmeer.net/xml-compile/
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
Copyrights 2007-2016 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