NAME

       XML::Compile::SOAP::Operation - base-class for possible interactions

INHERITANCE

        XML::Compile::SOAP::Operation is extended by
          XML::Compile::SOAP11::Operation
          XML::Compile::SOAP12::Operation

SYNOPSIS

        # created by XML::Compile::WSDL11
        my $op = $wsdl->operation('GetStockPrices');

DESCRIPTION

       These objects are created by XML::Compile::WSDL11, grouping information about a certain
       specific message interchange between a client and a server.

METHODS

   Constructors
       XML::Compile::SOAP::Operation->new(%options)
            -Option     --Default
             action       undef
             endpoints    []
             kind         <required>
             name         <required>
             schemas      <required>
             server_type  undef
             transport    'HTTP'

           action => STRING
             Some string which is referring 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 "one-way", "request-response", "sollicit-response", and
             "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'
             "HTTP" is short for "http://schemas.xmlsoap.org/soap/http/", which is a constant to
             indicate that transport should use the HyperText Transfer Protocol.

   Accessors
       $obj->bindingName()
       $obj->clientClass()
           Returns the class name which implements the Client side for this protocol.

       $obj->endPoints()
           Returns the list of alternative URLs for the end-point, which should be defined within
           the service's port declaration.

       $obj->kind()
       $obj->longName()
           [3.06] prefix the service name before the operation name, to make it really unique.  A
           "#" is used as separator.

       $obj->name()
       $obj->portName()
       $obj->schemas()
       $obj->serverClass()
           Returns the class name which implements the Server side for this protocol.

       $obj->serviceName()
       $obj->soapAction()
           Used for the "soapAction" header in HTTP transport, for routing messages through
           firewalls.

       $obj->version()
       $obj->wsaAction('INPUT'|'OUTPUT')
           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.

   Handlers
       $obj->compileClient(%options)
           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.

       $obj->compileHandler(%options)
           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
       $obj->compileTransporter(%options)
           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
             "endpoint" is provided.

           transport_hook => CODE
             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.

           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.

   Helpers
       $obj->explain($wsdl, $format, $direction, %options)
           Dump an annotated structure showing how the operation works, helping developers to
           understand the schema. $format is "PERL" or "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.

       $obj->parsedWSDL(%options)
           [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.

           example:

             use Data::Dumper;
             $Data::Dumper::Indent    = 1;
             $Data::Dumper::Quotekeys = 0;

             print Dumper $op->parsedWSDL;

SEE ALSO

       This module is part of XML-Compile-SOAP distribution version 3.28, built on August 01,
       2022. Website: http://perl.overmeer.net/CPAN/

LICENSE

       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/