NAME

XML::Compile::SOAP - base-class for SOAP implementations

INHERITANCE

XML::Compile::SOAP has extra code in
  XML::Compile::SOAP::Encoding

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

SYNOPSIS

** WARNING: Implementation not finished (but making progress)
** see TODO, at the end of this page

use XML::Compile::SOAP11::Client;
use XML::Compile::Util qw/pack_type/;

# There are some (hidden) differences between SOAP1.1 and 1.2
my $client = XML::Compile::SOAP11::Client->new;

# load extra schemas always explicitly
$client->schemas->importDefinitions(...);

# !!! THE NEXT STEPS ARE ONLY REQUIRED WHEN YOU DO NOT HAVE A WSDL
# !!! SEE XML::Compile::WSDL11 IF YOU HAVE A WSDL FILE

my $h1el = pack_type $myns, $some_element;
my $b1el = "{$myns}$other_element";  # same, less clean

my $encode_query = $client->compileMessage
  ( 'SENDER'
  , header   => [ h1 => $h1el ]
  , body     => [ b1 => $b1el ]
  , destination    => [ h1 => 'NEXT' ]
  , mustUnderstand => 'h1'
  );

my $decode_response = $client->compileMessage
  ( 'RECEIVER'
  , header    => [ h2 => $h2el ]
  , body      => [ b2 => $b2el ]
  , faults    => [ ... ]
  );

my $http = XML::Compile::Transport::SOAPHTTP
   ->new(address => $server);
my $http = $transport->compileClient(action => ...);

# In nice, small steps:

my @query    = (h1 => ..., b1 => ...);
my $request  = $encode_query->($query);
my ($response, $trace) = $http->($request);
my $answer   = $decode_response->($response);
use Data::Dumper;
warn Dumper $answer;     # see: a HASH with h2 and b2!
if($answer->{Fault}) ... # error was reported

# Simplify your life
# also in this case: if you have a WSDL, this is created for you.
# This is Document-style SOAP

my $call   = $client->compileClient
  ( kind      => 'request-response'
  , name      => 'my first call'
  , encode    => $encode_query
  , decode    => $decode_response
  , transport => $http
  );

# With or without WSDL file the same

my $result = $call->(h1 => ..., b1 => ...);
print $result->{h2}->{...};
print $result->{b2}->{...};

my ($result, $trace) = $call->(...);

DESCRIPTION

This module handles the SOAP protocol. The first implementation is SOAP1.1 (http://www.w3.org/TR/2000/NOTE-SOAP-20000508/), which is still most often used. The SOAP1.2 definition (http://www.w3.org/TR/soap12/) is quite different; this module tries to define a sufficiently abstract interface to hide the protocol differences.

Be aware that there are three kinds of SOAP:

Document style (literal) SOAP, where there is a WSDL file which explicitly types all out-going and incoming messages. Very easy to use.
RPC style SOAP literal. The WSDL file is not explicit about the content of the messages, but all messages must be schema defined types.
RPC style SOAP encoded. The sent data is nowhere described formally. The data is transported in some ad-hoc way.

METHODS

Constructors

$obj->new(OPTIONS)

Create a new SOAP object. You have to instantiate either the SOAP11 or SOAP12 sub-class of this, because there are quite some differences (which can be hidden for you)

Option            --Default
encoding_ns         <required>
envelope_ns         <required>
media_type          application/soap+xml
schema_instance_ns  $schema_ns . '-instance'
schema_ns           <required>
schemas             created internally
version             <required>

. encoding_ns => URI

. envelope_ns => URI

. media_type => MIMETYPE

. schema_instance_ns => URI

. schema_ns => URI

. schemas => XML::Compile::Schema object

Use this when you have already processed some schema definitions. Otherwise, you can add schemas later with $soap->schames->importDefinitions()

. version => STRING

The simple string representation of the protocol.

Accessors

$obj->encodingNS

$obj->envelopeNS

$obj->prefixPreferences(TABLE, NEW, [USED])

NEW is a HASH or ARRAY-of-PAIRS which define prefix-to-uri relations, which are added to the list defined in the TABLE (a HASH-of-HASHes). When USED is set, then it will show-up in the output message. At compile-time, the value of USED is auto-detect.

This method is called for the soap specification preferred namespaces, and for your compileMessage(prefixes).

$obj->schemaInstanceNS(() {shift->{schemains}})

$obj->schemaNS

$obj->schemas

Returns the XML::Compile::Schema object which contains the knowledge about the types.

$obj->version

Single messages

$obj->compileClient(OPTIONS)

Option   --Default
decode     <required>
encode     <required>
kind       request-response
name       "unnamed"
rpcin      <depends on type of rpcout>
rpcout     undef
transport  <required>

. decode => CODE

The CODE reference is produced by compileMessage(), and must be a RECEIVER: translate a SOAP message into Perl data.

. encode => CODE

The CODE reference is produced by compileMessage(), and must be a SENDER: translates Perl data structures into the SOAP message in XML.

. kind => STRING

Which kind of client is this. WSDL11 defines four kinds of client-server interaction. Only request-response (the default) is currently supported.

. name => STRING

Currently only used in some error messages, but may be used more intensively in the future.

. rpcin => TYPE|CODE

The TYPE of the RPC input message (RPC literal style) or a CODE reference which can be created to parse the RPC block (RPC encoded style).

If this option is not specified, but there is an rpcout with TYPE value, then the value for this options will default for that type name with Response concatenated: a commonly used convension.

If this option is not used, but there is an rpcout with CODE reference, then a standard decode routine is called. That routine does use XML::Compile::SOAP::Encoding::decSimplify() to get an as simple as possible return structure.

. rpcout => TYPE|CODE

The TYPE of the RPC output message (RPC literal style) or a CODE reference which can be created to produce the RPC block (RPC encoded style).

. transport => CODE

The CODE reference is produced by an extensions of XML::Compile::Transport::compileClient() (usually XML::Compile::Transport::SOAPHTTP::compileClient().

$obj->compileMessage(('SENDER'|'RECEIVER'), OPTIONS)

The payload is defined explicitly, where all headers and bodies are specified as ARRAY containing key-value pairs (ENTRIES). When you have a WSDL file, these ENTRIES are generated automatically.

To make your life easy, the ENTRIES use a label (a free to choose key, the part name in WSDL terminology), to ease relation of your data with the type where it belongs to. The element of an entry (the value) is defined as an any element in the schema, and therefore you will need to explicitly specify the element to be processed.

Option        --Default
body            []
destination     []
faults          []
header          undef
mustUnderstand  []
prefixes        {}
role            ULTIMATE
roles           []
style           'document'

. body => ENTRIES

ARRAY of PAIRS, defining a nice LABEL (free of choice but unique, also w.r.t. the header and fault ENTRIES) and an element type name or CODE reference. The LABEL will appear in the Perl HASH only, to be able to refer to a body element in a simple way.

. destination => ARRAY

Writers only. Indicate who the target of the header entry is. By default, the end-point is the destination of each header element.

The ARRAY contains a LIST of key-value pairs, specifing an entry label followed by an actor (soap1.1) or role (soap1.2) URI. You may use the predefined actors/roles, like 'NEXT'. See roleURI() and roleAbbreviation().

. faults => ENTRIES

The SOAP1.1 and SOAP1.2 protocols define fault entries in the answer. Both have a location to add your own additional information: the type(-processor) is to specified here, but the returned information structure is larger and differs per SOAP implementation.

. header => ENTRIES

ARRAY of PAIRS, defining a nice LABEL (free of choice but unique) and an element type name. The LABEL will appear in the Perl HASH, to refer to the element in a simple way.

The element type is used to construct a reader or writer. You may also create your own reader or writer, and then pass a compatible CODE reference.

. mustUnderstand => STRING|ARRAY-OF-STRING

Writers only. The specified header entry labels specify which elements must be understood by the destination. These elements will get the mustUnderstand attribute set to 1 (soap1.1) or true (soap1.2).

. prefixes => HASH

For the sender only: add additional prefix definitions. All provided names will be used always.

. role => URI|ARRAY-OF-URI

Readers only. One or more URIs, specifying the role(s) you application has in the process. Only when your role contains ULTIMATE, the body is parsed. Otherwise, the body is returned as uninterpreted XML tree. You should not use the role NEXT, because every intermediate node is a NEXT.

All understood headers are parsed when the actor (soap1.1) or role (soap1.2) attribute address the specified URI. When other headers emerge which are not understood but carry the mustUnderstood attribute, an fault is returned automatically. In that case, the call to the compiled subroutine will return undef.

. roles => ARRAY-OF-URI

Alternative for option role

. style => 'document'|'rpc-literal'|'rpc-encoded'

Sender (internals)

$obj->sender(ARGS)

$obj->writerCreateBody(BODY-DEFS, NAMESPACE-TABLE)

$obj->writerCreateFault(FAULT-DEFS, NAMESPACE-TABLE, FAULTTYPE)

$obj->writerCreateHeader(HEADER-DEFS, NS-TABLE, UNDERSTAND, DESTINATION)

$obj->writerCreateRpcEncoded(NAMESPACE-TABLE)

Create a handler which understands RPC encoded specifications.

$obj->writerCreateRpcLiteral(NAMESPACE-TABLE)

Create a handler which understands RPC literal specifications.

$obj->writerEncstyleHook(NAMESPACE-TABLE)

$obj->writerHook(NAMESPACE, LOCAL, ACTIONS)

Receiver (internals)

$obj->readerEncstyleHook

$obj->readerHook(NAMESPACE, LOCAL, ACTIONS)

$obj->readerParseBody(BODYDEF)

$obj->readerParseFaults(FAULTSDEF)

$obj->readerParseHeader(HEADERDEF)

$obj->receiver(ARGS)

Transcoding

SOAP defines encodings, especially for SOAP-RPC.

Encoding

$obj->array((NAME|undef), ITEM_TYPE, ARRAY-of-ELEMENTS, OPTIONS)

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->element(NAME, TYPE, VALUE)

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->enc(LOCAL, VALUE, [ID])

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->encAddNamespaces(PAIRS)

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->href(NAME, ELEMENT, [ID])

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->multidim((NAME|undef), ITEM_TYPE, ARRAY-of-ELEMENTS, OPTIONS)

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->prefixed(TYPE|(NAMESPACE,LOCAL))

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->startEncoding(OPTIONS)

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->struct(TYPE, CHILDS)

See "Encoding" in XML::Compile::SOAP::Encoding

$obj->typed(TYPE, NAME, VALUE)

See "Encoding" in XML::Compile::SOAP::Encoding

Decoding

$obj->dec(XMLNODES)

See "Decoding" in XML::Compile::SOAP::Encoding

$obj->decSimplify(TREE, OPTIONS)

See "Decoding" in XML::Compile::SOAP::Encoding

$obj->startDecoding(OPTIONS)

See "Decoding" in XML::Compile::SOAP::Encoding

Helpers

$obj->replyMustUnderstandFault(TYPE)

Produce an error structure to be returned to the sender.

$obj->roleAbbreviation(URI)

Translate a role URI into a simple string, if predefined. See roleURI().

$obj->roleURI(URI|STRING)

Translates actor/role/destination abbreviations into URIs. Various SOAP protocol versions have different pre-defined STRINGs, which can be abbreviated for readibility. Returns the unmodified URI in all other cases.

SOAP11 only defines NEXT. SOAP12 defines NEXT, NONE, and ULTIMATE.

DETAILS

SOAP introduction

Although the specification of SOAP1.1 and WSDL1.1 are thin, the number of special constructs are many. And, of course, all poorly documented. Both SOAP and WSDL have 1.2 versions, which will clear things up a lot, but not used that often yet.

WSDL defines two kinds of messages: document style SOAP and rpc style SOAP. In Document style SOAP, the messages are described in great detail in the WSDL: the message components are all defined in Schema's; the worst things you can (will) encounter are any schema elements which require additional manual processing.

I would like to express my personal disgust over RPC style SOAP. In this case, the body of the message is not clearly specified in the WSDL... which violates the whole purpose of using interface descriptions in the first place! In a client-server interface definition, you really wish to be very explicit in the data you communicate. Gladly, SOAP1.2 shares my feelings a little, and speaks against RPC although still supporting it.

Anyway, we have to live with this feature. SOAP-RPC is simple to use on strongly typed languages, to exchange data when you create both the client software and the server software. You can simply autogenerate the data encoding. Clients written by third parties have to find the documentation on how to use the RPC call in some other way... in text, if they are lucky; the WSDL file does not contain the prototype of the procedures, but that doesn't mean that they are free-format.

The encoded RPC messsages are shaped to the procedures which are being called on the server. The body of the sent message contains the ordered list of parameters to be passed as 'in' and 'in/out' values to the remote procedure. The body of the returned message lists the result value of the procedure, followed by the ordered 'out' and 'in/out' parameters.

The literal RPC messages are half-breed document style message: there is a schema which tells you how to interpret the body, but the WSDL doesn't tell you what the options are.

Using SOAP calls

Naming types and elements

XML uses namespaces: URIs which are used as constants, grouping a set of type and element definitions. By using name-spaces, you can avoid name clashes, which have frustrate many projects in history, when they grew over a certain size... at a certain size, it becomes too hard to think of good distriguishable names. In such case, you must be happy when you can place those names in a context, and use the same naming in seperate contexts without confusion.

That being said: XML supports both namespace- and non-namespace elements and schema's; and of cause many mixed cases. It is by far preferred to use namespace schemas only. For a schema xsd file, look for the targetNamespace attribute of the schema element: if present, it uses namespaces.

In XML data, it is seen as a hassle to write the full length of the URI each time that a namespace is addressed. For this reason, prefixes are used as abbreviations. In programs, you can simply assign short variable names to long URIs, so we do not need that trick.

Within your program, you use

$MYSN = 'long URI of namespace';
... $type => "{$MYNS}typename" ...

or nicer

use XML::Compile::Util qw/pack_type/;
use constant MYNS => 'some uri';
... $type => pack_type(MYNS, 'typename') ...

The XML::Compile::Util module provides a helpfull methods and constants, as does the XML::Compile::SOAP::Util.

Calling the server (Document style)

First, you compile the call either via a WSDL file (see XML::Compile::WSDL11), or in a few manual steps (which are described in the next section). In either way, you end-up with a CODE references which can be called multiple times.

# compile once
my $call   = $soap->compileClient(...);

# and call often
my $answer = $call->(%request);  # list of pairs
my $answer = $call->(\%request); # same, but HASH
my $answer = $call->(\%request, 'UTF-8');  # same

But what is the structure of %request and $answer? Well, there are various syntaxes possible: from structurally perfect, to user-friendly.

First, find out which data structures can be present: when you compiled your messages explicitly, you have picked your own names. When the call was initiated from a WSDL file, then you have to find the names of the message parts which can be used: the part names for header blocks, body blocks, headerfaults, and (body) faults. Do not worry to much, you will get (hopefully understandable) run-time error messages when the structure is incorrect.

Let's say that the WSDL defines this (ignoring all name-space issues)

<definitions xmlns:xx="MYNS"
  <message name="GetLastTradePriceInput">
   <part name="count" type="int" />
   <part name="request" element="xx:TradePriceRequest"/>
  </message>

  <message name="GetLastTradePriceOutput">
   <part name="answer" element="xx:TradePrice"/>
  </message>

  <binding
   <operation
    <input>
     <soap:header message="GetLastTradePriceInput" part="count"
     <soap:body message="GetLastTradePriceInput" parts="request"
    <output>
     <soap:body message="GetLastTradePriceOutput"

The input message needs explicitly named parts in this case, where the output message simply uses all defined in the body. So, the input message has one header part count, and one body part request. The output message only has one part named answer, which is all defined for the message and therefore its name can be omitted.

Then, the definitions of the blocks:

<schema targetNamespace="MYNS"
  <element name="TradePriceRequest">
   <complexType>
    <all>
     <element name="tickerSymbol" type="string"/>

  <element name="TradePrice">
   <complexType>
    <all>
     <element name="price" type="float"/>
</schema>

Now, calling the compiled function can be done like this:

my $got
   = $call->(  count => 5, request => {tickerSymbol => 'IBM'}  );
   = $call->({ count => 5, request => {tickerSymbol => 'IBM'} });
   = $call->({ count => 5, request => {tickerSymbol => 'IBM'} }
      , 'UTF-8');

If the first arguments for the code ref is a HASH, then there may be a second which specifies the required character-set. The default is UTF-8, which is very much adviced.

Parameter unpacking (Document Style)

In the example situation of previous section, you may simplify the call even further. To understand how, we need to understand the parameter unpacking algorithm.

The structure which we need to end up with, looks like this

$call->(\%data, $charset);
%data = ( Header => {count => 5}
        , Body   =>
           { request => {tickerSymbol => 'IBM'} }
        );

The structure of the SOAP message is directly mapped on this nested complex HASH. But is inconvenient to write each call like this, therefore the $call parameters are transformed into the required structure according to the following rules:

if called with a LIST, then that will become a HASH
when a Header and/or Body are found in the HASH, those are used
if there are more parameters in the HASH, then those with names of known header and headerfault message parts are moved to the Header sub-structure. Body and fault message parts are moved to the Body sub-structure.
If the Body sub-structure is empty, and there is only one body part expected, then all remaining parameters are put in a HASH for that part. This also happens if there are not parameters: it will result in an empty HASH for that block.

So, in our case this will also do, because count is a known part, and request gets all left-overs, being the only body part.

my $got = $call->(count => 5, tickerSymbol => 'IBM');

This does not work if the block element is a simple type. In most existing Document style SOAP schemas, this simplification probably is possible.

Understanding the output (Document style)

The $got is a HASH, which will not be simplified automatically: it may change with future extensions of the interface. The return is a complex nested structure, and Data::Dumper is your friend.

$got = { answer => { price => 16.3 } }

To access the value use

printf "%.2f US\$\n", $got->{answer}->{price};
printf "%.2f US\$\n", $got->{answer}{price};   # same

my $answer = $got->{answer};
printf "%.2f US\$\n", $answer->{price};

Calling the server (SOAP-RPC style literal)

SOAP-RPC style messages which have <use=literal> cannot be used without a little help. However, one extra definition per procedure call suffices.

This a complete code example, although you need to fill in some specifics about your environment. If you have a WSDL file, then it will be a little simpler, see XML::Compile::WSDL11::compileClient().

# You probably need these
use XML::Compile::SOAP11::Client;
use XML::Compile::Transport::SOAPHTTP;
use XML::Compile::Util  qw/pack_type/;

# Literal style RPC
my $outtype = pack_type $MYNS, 'myFunction';
my $intype  = pack_type $MYNS, 'myFunctionResponse';
my $style   = 'rpc-literal';

# Encoded style RPC (see next section on these functions)
my $outtype = \&my_pack_params;
my $in type = \&my_unpack_params;
my $style   = 'rpc-encoded';

# For all RPC calls, you need this only once:
my $transp  = XML::Compile::Transport::SOAPHTTP->new(...);
my $http    = $transp->compileClient(...);
my $soap    = XML::Compile::SOAP11::Client->new(...);
my $send    = $soap->compileMessage('SENDER',   style => $style, ...);
my $get     = $soap->compileMessage('RECEIVER', style => $style, ...);

# Per RPC procedure
my $myproc = $soap->compileClient
  ( name   => 'MyProc'
  , encode => $send, decode => $get, transport => $http
  , rpcout => $outtype, rpcin => $intype
  );

my $answer = $myproc->(@parameters);   # as document style

Actually, the @paramers are slightly less flexible as in document style SOAP. If you use header blocks, then the called CODE reference will not be able to distinguish between parameters for the RPC block and parameters for the header blocks. Therefore, in that situation, you MUST separate the rpc data explicitly as one argument.

my $answer = $trade_price
  ->( {symbol => 'IBM'}    # the RPC package implicit
    , transaction => 5     # in the header
    );

my $answer = $trade_price  # RPC very explicit
  ->(rpc => {symbol => 'IBM'}, transaction => 5);

When the number of arguments is odd, the first is indicating the RPC element, and the other pairs refer to header blocks.

The $answer structure may contain a Fault entry, or a decoded datastructure with the results of your query. One call using Data::Dumper will show you more than I can explain in a few hundred words.

Calling the server (SOAP-RPC style, encoded)

SOAP-RPC is a simplification of the interface description: basically, the interface is not described at all but left to good communication between the client and server authors. In strongly typed languages, this is quite simple to enforce: the client side and server side use the same (remote) method prototype. However, in Perl we are blessed without these typed prototypes...

The approach of SOAP::Lite, is to guess the types of the passed parameters. For instance, "42" will get passed as Integer. This may lead to nasty problems: a float parameter "2.0" will get passed as integer "2", or a string representing a house number "8" is passed as an number. This may not be accepted by the SOAP server.

So, using SOAP-RPC in XML::Compile::SOAP will ask a little more effort from you: you have to state parameter types explicitly.

Faults (Document and RPC style)

Faults and headerfaults are a slightly different story: the type which is specified with them is not of the fault XML node itself, but of the detail sub-element within the standard fault structure.

When producing the data for faults, you must be aware of the fact that the structure is different for SOAP1.1 and SOAP1.2. When interpreting faults, the same problems are present, although the implementation tries to help you by hiding the differences.

Check whether SOAP1.1 or SOAP1.2 is used by looking for a faultcode (SOAP1.1) or a Code (SOAP1.2) field in the data:

if(my $fault = $got->{Fault})
{  if($fault->{faultcode}) { ... SOAP1.1 ... }
   elsif($fault->{Code})   { ... SOAP1.2 ... }
   else { die }
}

In either protocol case, the following will get you at a compatible structure in two steps:

if(my $fault = $got->{Fault})
{   my $decoded = $got->{$fault->{_NAME}};
    print $decoded->{code};
    ...
}

See the respective manuals XML::Compile::SOAP11 and XML::Compile::SOAP12 for the hairy details. But one thing can be said: when the fault is declared formally, then the _NAME will be the name of that part.

SOAP without WSDL (Document style)

See the manual page of XML::Compile::WSDL11 to see how simple you can use this module when you have a WSDL file at hand. The creation of a correct WSDL file is NOT SIMPLE.

When using SOAP without WSDL file, it gets a little bit more complicate to use: you need to describe the content of the messages yourself. The following example is used as test-case t/10soap11.t, directly taken from the SOAP11 specs section 1.3 example 1.

# for simplification
my $TestNS   = 'http://test-types';
use XML::Compile::Util qw/SCHEMA2001/;
my $SchemaNS = SCHEMA2001;

First, the schema (hopefully someone else created for you, because they can be quite hard to create correctly) is in file myschema.xsd

<schema targetNamespace="$TestNS"
  xmlns="$SchemaNS">

<element name="GetLastTradePrice">
  <complexType>
     <all>
       <element name="symbol" type="string"/>
     </all>
  </complexType>
</element>

<element name="GetLastTradePriceResponse">
  <complexType>
     <all>
        <element name="price" type="float"/>
     </all>
  </complexType>
</element>

<element name="Transaction" type="int"/>
</schema>

Ok, now the program you create the request:

use XML::Compile::SOAP11;
use XML::Compile::Util  qw/pack_type/;

my $soap   = XML::Compile::SOAP11->new;
$soap->schemas->importDefinitions('myschema.xsd');

my $get_price = $soap->compileMessage
  ( 'SENDER'
  , header =>
     [ transaction => pack_type($TestNS, 'Transaction') ]
  , body  =>
     [ request => pack_type($TestNS, 'GetLastTradePrice') ]
  , mustUnderstand => 'transaction'
  , destination    => [ transaction => 'NEXT http://actor' ]
  );

INPUT is used in the WSDL terminology, indicating this message is an input message for the server. This $get_price is a WRITER. Above is done only once in the initialization phase of your program.

At run-time, you have to call the CODE reference with a data-structure which is compatible with the schema structure. (See XML::Compile::Schema::template() if you have no clue how it should look) So: let's send this:

# insert your data
my %data_in = (transaction => 5, request => {symbol => 'DIS'});
my %data_in = (transaction => 5, symbol => 'DIS'); # alternative

# create a XML::LibXML tree
my $xml  = $get_price->(\%data_in, 'UTF-8');
print $xml->toString;

And the output is:

<SOAP-ENV:Envelope
   xmlns:x0="http://test-types"
   xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <x0:Transaction
      mustUnderstand="1"
      actor="http://schemas.xmlsoap.org/soap/actor/next http://actor">
        5
    </x0:Transaction>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <x0:GetLastTradePrice>
      <symbol>DIS</symbol>
    </x0:GetLastTradePrice>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Some transport protocol will sent this data from the client to the server. See XML::Compile::Transport::SOAPHTTP, as one example.

On the SOAP server side, we will parse the message. The string $soap contains the XML. The program looks like this:

my $server = $soap->compileMessage # create once
 ( 'RECEIVER'
 , header => [ transaction => pack_type($TestNS, 'Transaction') ]
 , body   => [ request => pack_type($TestNS, 'GetLastTradePrice') ]
 );

my $data_out = $server->($soap);   # call often

Now, the $data_out reference on the server, is stucturally exactly equivalent to the %data_in from the client.

LICENSE

Copyrights 2007 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.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

INHERITANCE

SYNOPSIS

DESCRIPTION

METHODS

Constructors

Accessors

Single messages

Sender (internals)

Receiver (internals)

Transcoding

Encoding

Decoding

Helpers

DETAILS

SOAP introduction

Using SOAP calls

Naming types and elements

Calling the server (Document style)

Parameter unpacking (Document Style)

Understanding the output (Document style)

Calling the server (SOAP-RPC style literal)

Calling the server (SOAP-RPC style, encoded)

Faults (Document and RPC style)

SOAP without WSDL (Document style)

SEE ALSO

LICENSE

Module Install Instructions