/ 
XML-Compile-SOAP-0.58
River stage two • 30 direct dependents • 35 total dependents
/ XML::Compile::SOAP11

NAME

XML::Compile::SOAP11 - base class for SOAP1.1 implementation

INHERITANCE

XML::Compile::SOAP11
  is a XML::Compile::SOAP

XML::Compile::SOAP11 is extended by
  XML::Compile::SOAP11::Client
  XML::Compile::SOAP11::Server

SYNOPSIS

DESCRIPTION

This module handles the SOAP protocol version 1.1. See http://www.w3.org/TR/2000/NOTE-SOAP-20000508/). The implementation tries to behave like described in http://www.ws-i.org/Profiles/BasicProfile-1.0.html

Two extensions are made: the SOAP11 client XML::Compile::SOAP11::Client. and server in XML::Compile::SOAP11::Server.

METHODS

Constructors

$obj->new(OPTIONS)

    To simplify the URIs of the actors, as specified with the destination option, you may use the STRING NEXT. It will be replaced by the right URI.

    Option     --Defined in     --Default
encoding_ns  XML::Compile::SOAP  http://schemas.xmlsoap.org/soap/encoding/
envelope_ns  XML::Compile::SOAP  http://schemas.xmlsoap.org/soap/envelope/
media_type   XML::Compile::SOAP  application/soap+xml
schemas      XML::Compile::SOAP  created internally
version      XML::Compile::SOAP  'SOAP11'

    . encoding_ns => URI

    . envelope_ns => URI

    . media_type => MIMETYPE

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

    . version => STRING

Accessors

$obj->encodingNS

$obj->envelopeNS

$obj->prefixPreferences(TABLE)

$obj->schemas

$obj->version

Single messages

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

    Option        --Defined in     --Default
body            XML::Compile::SOAP  []
destination     XML::Compile::SOAP  []
encodings       XML::Compile::SOAP  {}
faults          XML::Compile::SOAP  []
header          XML::Compile::SOAP  undef
headerfault                      []
mustUnderstand  XML::Compile::SOAP  []
role            XML::Compile::SOAP  ULTIMATE
roles           XML::Compile::SOAP  []

    . body => ENTRIES

    . destination => ARRAY

    . encodings => HASH-of-HASHes

    . faults => ENTRIES

    . header => ENTRIES

    . headerfault => ENTRIES

      ARRAY of simple name with element references, for all expected faults. There can be unexpected faults, which will not get decoded automatically.

    . mustUnderstand => STRING|ARRAY-OF-STRING

    . role => URI|ARRAY-OF-URI

    . roles => ARRAY-OF-URI

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->writerEncstyleHook(NAMESPACE-TABLE)

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

Receiver (internals)

$obj->readerEncstyleHook

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

$obj->readerParseBody(BODYDEF)

$obj->readerParseFaults(FAULTSDEF)

    The decoders for the possible "faults" are compiled. Returned is a code reference which can handle it. See fault handler specifics in the DETAILS chapter below.

$obj->readerParseHeader(HEADERDEF)

$obj->receiver(ARGS)

Helpers

$obj->replyMustUnderstandFault(TYPE)

$obj->roleAbbreviation(URI)

$obj->roleURI(URI|STRING)

DETAILS

Using the produced calls

Calling SOAP without WSDL

Encodings

Receiving faults in SOAP1.1

When faults are received, they will be returned with the Faults key in the data structure. So:

my $answer = $call->($question);
if($answer->{Faults}) { ... }

As extra service, for each of the fault types, as defined with compileMessage(faults), a decoded structure is included. The name of that structure can be found like this:

if(my $faults = $answer->{Faults})
{   my $name    = $faults->{_NAME};
    my $decoded = $answer->{$name};
    ...
}

The untranslated $faults HASH looks like this:

Fault =>
  { faultcode => '{http://schemas.xmlsoap.org/soap/envelope/}Server.first'
  , faultstring => 'my mistake'
  , faultactor => 'http://schemas.xmlsoap.org/soap/actor/next'
  , detail => { '{http://test-types}fault_one' => [ XMLNODES ] }
  , _NAME => 'fault1'
  }

The _NAME originates from the compileMessage(faults) option:

$soap->compileMessage('RECEIVER', ...
  , faults => [ fault1 => '{http://test-types}fault_one' ] );

Now, automatically the answer will contain the decoded fault structure as well:

fault1 =>
  { code => '{http://schemas.xmlsoap.org/soap/envelope/}Server.first'
  , class  => [ 'http://schemas.xmlsoap.org/soap/envelope/'
       , 'Receiver', 'first' ]
  , reason => 'my mistake',
  , role   => 'NEXT'
  , detail => { help => 'please ignore' }
  }

The detail is the decoding of the XMLNODES, which are defined to be of type {http://test-types}fault_one.

The class is an unpacked version of the code. SOAP1.2 is using the (better) terms Sender and Receiver.

role is constructed by decoding the faultactor using roleAbbreviation(). The names are closer to the SOAP1.2 specification.

If the received fault is of an unpredicted type, then key unknown is used, and the detail will list the unparsed XMLNODEs. When there are no details, (according to the specs) the error must be caused by a header problem, so the header key is used.

SEE ALSO

This module is part of XML-Compile-SOAP distribution version 0.58, built on October 22, 2007. Website: http://perl.overmeer.net/xml-compile/

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