SOAP::WSDL - SOAP with WSDL support


Back to Top


NAME

SOAP::WSDL - SOAP with WSDL support

Back to Top


Overview

For creating Perl classes instrumenting a web service with a WSDL definition, read the SOAP::WSDL::Manual manpage.

For using an interpreting (thus slow and somewhat troublesome) WSDL based SOAP client, which mimics SOAP::Lite's API, read on.

Back to Top


SYNOPSIS

 my $soap = SOAP::WSDL->new(
    wsdl => 'file://bla.wsdl',
 );
 
 my $result = $soap->call('MyMethod', %data);
 
 =head1 DESCRIPTION
 

SOAP::WSDL provides easy access to Web Services with WSDL descriptions.

The WSDL is parsed and stored in memory.

Your data is serialized according to the rules in the WSDL.

The only transport mechanisms currently supported are http and https.

Back to Top


METHODS

new

Constructor. All parameters passed are passed to the corresponding methods.

call

Performs a SOAP call. The result is either an object tree (with outputtree), a hash reference (with outputhash), plain XML (with outputxml) or a SOAP::SOM object (with neither of the above set).

call() can be called in different ways:

wsdlinit

Reads the WSDL file and initializes SOAP::WSDL for working with it.

Is called automatically from call() if not called directly before.

 servicename
 portname
 call

You may set servicename and portname by passing them as attributes to wsdlinit:

 $soap->wsdlinit(
    servicename => 'MyService',
    portname => 'MyPort' 
 );

Back to Top


CONFIGURATION METHODS

outputtree

When outputtree is set, SOAP::WSDL will return an object tree instead of a SOAP::SOM object.

You have to specify a class_resolver for this to work. See class_resolver

class_resolver

Set the class resolver class (or object).

Class resolvers must implement the method get_class which has to return the name of the class name for deserializing a XML node at the current XPath location.

Class resolvers are typically generated by using the generate_typemap method of a SOAP::WSDL::Generator subclass.

Example:

XML structure (SOAP body content):

 <Person>
    <Name>Smith</Name>
    <FirstName>John</FirstName>
 </Person>

Class resolver

 package MyResolver;
 my %typemap = (
    'Person' => 'MyPersonClass',
    'Person/Name' => 'SOAP::WSDL::XSD::Typelib::Builtin::string',
    'Person/FirstName' => 'SOAP::WSDL::XSD::Typelib::Builtin::string',
 );
 sub get_class { return $typemap{ $_[1] } };
 1;

You'll need a MyPersonClass module in your search path for this to work - see SOAP::WSDL::XSD::ComplexType on how to build / generate one.

servicename

 $soap->servicename('Name');

Sets the service to operate on. If no service is set via servicename, the first service found is used.

Returns the soap object, so you can chain calls like

 $soap->servicename->('Name')->portname('Port');

portname

 $soap->portname('Name');

Sets the port to operate on. If no port is set via portname, the first port found is used.

Returns the soap object, so you can chain calls like

 $soap->portname('Port')->call('MyMethod', %data);

no_dispatch

When set, call() returns the plain request XML instead of dispatching the SOAP call to the SOAP service. Handy for testing/debugging.

Back to Top


ACCESS TO SOAP::WSDL's internals

get_client / set_client

Returns the SOAP client implementation used (normally a SOAP::WSDL::Client object).

Back to Top


EXAMPLES

See the examples/ directory.

Back to Top


Differences to previous versions

Back to Top


Differences to SOAP::Lite

readable

readable is a no-op in SOAP::WSDL. Actually, the XML output from SOAP::Lite is hardly readable, either with readable switched on.

If you need readable XML messages, I suggest using your favorite XML editor for displaying and formatting.

Message style/encoding

While SOAP::Lite supports rpc/encoded style/encoding only, SOAP::WSDL currently supports document/literal style/encoding.

autotype / type information

SOAP::Lite defaults to transmitting XML type information by default, where SOAP::WSDL defaults to leaving it out.

autotype(1) might even be broken in SOAP::WSDL - it's not well-tested, yet.

Output formats

In contrast to SOAP::Lite, SOAP::WSDL supports the following output formats:

outputxml

SOAP::Lite returns only the content of the SOAP body when outputxml is set to true. SOAP::WSDL returns the complete XML response.

Auto-Dispatching

SOAP::WSDL does does not support auto-dispatching.

This is on purpose: You may easily create interface classes by using SOAP::WSDL::Client and implementing something like

 sub mySoapMethod {
     my $self = shift;
     $soap_wsdl_client->call( mySoapMethod, @_);
 }

You may even do this in a class factory - see the wsdl2perl.pl manpage for creating such interfaces.

Debugging / Tracing

While SOAP::Lite features a global tracing facility, SOAP::WSDL allows to switch tracing on/of on a per-object base.

This has to be done in the SOAP client used by SOAP::WSDL - see get_client for an example and the SOAP::WSDL::Client manpage for details.

Back to Top


Bugs and Limitations

Back to Top


SEE ALSO

Related projects

Sources of documentation

Back to Top


ACKNOWLEDGMENTS

There are many people out there who fostered SOAP::WSDL's developement. I would like to thank them all (and apologize to all those I have forgotten).

Giovanni S. Fois wrote a improved version of SOAP::WSDL (which eventually became v1.23)

David Bussenschutt, Damian A. Martinez Gelabert, Dennis S. Hennen, Dan Horne, Peter Orvos, Mark Overmeer, Jon Robens, Isidro Vila Verde and Glenn Wood spotted bugs and/or suggested improvements in the 1.2x releases.

Andreas 'ac0v' Specht constantly asked for better performance.

JT Justman provided some early feedback for the 2.xx pre-releases.

Numerous people sent me their real-world WSDL files for testing. Thank you.

Paul Kulchenko and Byrne Reese wrote and maintained SOAP::Lite and thus provided a base (and counterpart) for SOAP::WSDL.

Back to Top


LICENSE

Copyright 2004-2007 Martin Kutter.

This file is part of SOAP-WSDL. You may distribute/modify it under the same terms as perl itself

Back to Top


AUTHOR

Martin Kutter <martin.kutter fen-net.de>

Back to Top


REPOSITORY INFORMATION

 $Rev: 332 $
 $LastChangedBy: kutterma $
 $Id: WSDL.pm 332 2007-10-19 07:29:03Z kutterma $
 $HeadURL: https://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL.pm $
 
=cut

Back to Top

 SOAP::WSDL - SOAP with WSDL support