1SOAP::WSDL::Client(3) User Contributed Perl DocumentationSOAP::WSDL::Client(3)
2
6 SOAP::WSDL::Client - SOAP::WSDL's SOAP Client
7
9 use SOAP::WSDL::Client;
10 my $soap = SOAP::WSDL::Client->new({
11 proxy => 'http://www.example.org/webservice/test'
12 });
13 $soap->call( \%method, $body, $header);
14
16 call
17 $soap->call( \%method, \@parts );
18 %method is a hash with the following keys:
20 Name Description
22 ----------------------------------------------------
23 operation operation name
24 soap_action SOAPAction HTTP header to use
25 style Operation style. One of (document|rpc)
26 use SOAP body encoding. One of (literal|encoded)
27 The style and use keys have no influence yet.
29 @parts is a list containing the elements of the message parts.
31 For backward compatibility, call may also be called as below:
33 $soap->call( $method, \@parts );
35 In this case, $method is the SOAP operation name, and the SOAPAction
37 header is guessed from the first part's namespace and the operation
38 name (which is mostly correct, but may fail). Operation style and body
39 encoding are assumed to be document/literal
40 Configuration methods
42 outputxml
43 $soap->outputxml(1);
45 When set, call() returns the raw XML of the SOAP Envelope.
47 set_content_type
49 $soap->set_content_type('application/xml; charset: utf8');
51 Sets the content type and character encoding.
53 You probably should not use a character encoding different from utf8:
55 SOAP::WSDL::Client will not convert the request into a different
56 encoding (yet).
57 To leave out the encoding, just set the content type without appending
59 charset like this:
60 $soap->set_content_type('text/xml');
62 Default:
64 text/xml; charset: utf8
66 set_prefix
68 $soap->set_prefix('ns2');
70 If set, alters the serialization of the request XML such that the
72 supplied value is used as a namespace prefix for SOAP method calls. By
73 way of example, the default XML serialization returns something like
74 this:
75 <?xml version="1.0"?>
77 <SOAP-ENV:Envelope
78 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
79 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
80 <SOAP-ENV:Body>
81 <getElementId xmlns="http://services.exmaple.org/">
82 <elementId>12345</elementId>
83 </getElementId>
84 </SOAP-ENV:Body>
85 </SOAP-ENV:Envelope>
86 If the sample set_prefix() call above is used prior to calling your
88 SOAP method, the XML serialization returns this instead:
89 <?xml version="1.0"?>
91 <SOAP-ENV:Envelope
92 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
93 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
94 xmlns:ns2="http://services.example.org/">
95 <SOAP-ENV:Body>
96 <ns2:getElementId>
97 <elementId>12345</elementId>
98 </ns2:getElementId>
99 </SOAP-ENV:Body>
100 </SOAP-ENV:Envelope>
101 This is useful in cases where, for instance, one is communicating with
103 a JAX <https://jax-ws.dev.java.net/> webservice, which tends to
104 understand the latter but not the former. Note that this implementation
105 is currently limited to a single additional namespace; if you require
106 multiple custom namespaces, you should probably look into creating your
107 own serializer.
108 Features different from SOAP::Lite
110 SOAP::WSDL does not aim to be a complete replacement for SOAP::Lite -
111 the SOAP::Lite module has its strengths and weaknesses and SOAP::WSDL
112 is designed as a cure for the weakness of little WSDL support - nothing
113 more, nothing less.
114 Nonetheless SOAP::WSDL mimics part of SOAP::Lite's API and behaviour,
116 so SOAP::Lite users can switch without looking up every method call in
117 the documentation.
118 A few things are quite different from SOAP::Lite, though:
120 SOAP request data
122 SOAP request data may either be given as message object, or as a hash
124 ref (in which case it will automatically be encoded into a message
125 object).
126 Return values
128 The result from call() is not a SOAP::SOM object, but a message object.
130 Message objects' classes may be generated from WSDL definitions
132 automatically - see SOAP::WSDL::Generator::Typelib on how to generate
133 your own WSDL based message class library.
134 Fault handling
136 SOAP::WSDL::Client returns a fault object on errors, even on transport
138 layer errors.
139 The fault object is a SOAP1.1 fault object of the following
141 "SOAP::WSDL::SOAP::Typelib::Fault11".
142 SOAP::WSDL::SOAP::Typelib::Fault11 objects are false in boolean
144 context, so you can just do something like:
145 my $result = $soap->call($method, $data);
147 if ($result) {
149 # handle result
150 }
151 else {
152 die $result->faultstring();
153 }
154 outputxml
156 SOAP::Lite returns only the content of the SOAP body when outputxml is
158 set to true. SOAP::WSDL::Client returns the complete XML response.
159 Auto-Dispatching
161 SOAP::WSDL::Client does not support auto-dispatching.
163 This is on purpose: You may easily create interface classes by using
165 SOAP::WSDL::Client and implementing something like
166 sub mySoapMethod {
168 my $self = shift;
169 $soap_wsdl_client->call( mySoapMethod, @_);
170 }
171 You may even do this in a class factory - see wsdl2perl.pl for creating
173 such interfaces.
174
176 Accessing protected web services
177 Accessing protected web services is very specific for the transport
178 backend used.
179 In general, you may pass additional arguments to the set_proxy method
181 (or a list ref of the web service address and any additional arguments
182 to the new method's proxy argument).
183 Refer to the appropriate transport module for documentation.
185
187 Copyright 2004-2007 Martin Kutter.
188 This file is part of SOAP-WSDL. You may distribute/modify it under the
190 same terms as perl itself
191
193 Martin Kutter <martin.kutter fen-net.de>
194
196 $Rev: 851 $
197 $LastChangedBy: kutterma $
198 $Id: Client.pm 851 2009-05-15 22:45:18Z kutterma $
199 $HeadURL: https://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL/Client.pm $
200perl v5.36.0 2023-01-20 SOAP::WSDL::Client(3)