soap::client(3) [suse man page]
SOAP::Client(3) User Contributed Perl Documentation SOAP::Client(3) NAME
SOAP::Client - exists purely as a superclass for client classes declared by the various SOAP::Lite transport modules. DESCRIPTION
The SOAP::Client class exists purely as a superclass for client classes declared by the various SOAP::Lite transport modules. The methods it provides are all simple accessors; they return the current value when called with no arguments or set the attribute value and return the object reference when called with an argument. These attributes include: METHODS
code, message, status Stores the response code, message, and status from the most-recent send attempt. For some protocols, such as FTP, the same value is used for all three because of the lack of finer-grained detail (the default is to ensure that all three attributes contain data, even if redundant). Other protocols (such as HTTP) have distinct values in each. endpoint Identifies the current endpoint to which messages are being sent. This should match the value of the transport method from the SOAP::Transport class, but setting this doesn't propagate to the transport object. It is better to use the transport object (or the shortcut via the SOAP::Lite object itself) when setting this. is_success The success or failure of the most-recent transmission is noted here as a boolean value. options The options attribute keeps a hash-table reference of additional options and their values. At present, only one option is used by any of the transport modules: compress_threshold The value of this option should be a numerical value. If set, and if the Compress::Zlib library is available, messages whose size in bytes exceeds this value will be compressed before sending. Both ends of the conversation must have it enabled. Other options may be defined using this mechanism. Note that setting the options using this accessor requires a full hash reference be passed. To set just one or a few values, consider retrieving the current reference value and using it to set the key(s). SEE ALSO
SOAP::Server ACKNOWLEDGEMENTS
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from Programming Web Services with Perl, mainly the SOAP::Lite reference found in Appendix B. COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. AUTHORS
Paul Kulchenko (paulclinger@yahoo.com) Randy J. Ray (rjray@blackperl.com) Byrne Reese (byrne@majordojo.com) perl v5.12.1 2010-03-18 SOAP::Client(3)
Check Out this Related Man Page
SOAP::Fault(3) User Contributed Perl Documentation SOAP::Fault(3) NAME
SOAP::Fault - encapsulates SOAP faults prior to their serialization or after their deserialization DESCRIPTION
This class encapsulates SOAP faults prior to their serialization or after their deserialization. The methods available are a constructor and four accessors. Each accessor creates an object on demand, just as the other classes do, when called as a static method. Like other accessors in the SOAP::Lite package, they return the object itself when setting the attribute. GENERATING A SOAP FAULT
To generate a SOAP Fault simply issue a Perl die command on the server side as you might normally. The SOAP processor will intercept the die command and return a SOAP Fault, using the string passed to the die command as the faultstring, to the client making the call. If you require having more control over the SOAP Fault returned to the client, then simply pass a SOAP::Fault object to the die command and the SOAP processor will behave accordingly. For example: die SOAP::Fault->faultcode('Server.Custom') # will be qualified ->faultstring('Died in server method') ->faultdetail(bless {code => 1} => 'BadError') ->faultactor('http://www.soaplite.com/custom'); METHODS
new(optional data) $fault = SOAP::Fault->new(faultcode => 'Server'); Explicitly creates a new SOAP::Fault object. Any of the four attributes represented next by accessor methods may be passed in the argument list with values immediately following their attribute name. faultcode(optional value) $fault->faultcode('MethodUnknown'); Returns the current fault code or sets it if a value is given. faultstring(optional value) $fault->faultstring("There is no $method here"); Returns or sets the fault string. faultactor(optional value) $fault->faultcode($header->actor); Returns or sets the fault-actor element. Note that the actor isn't always required in a SOAP fault. faultdetail(optional value) $fault->faultcode(bless { proxy => $ip }, 'Err'); Returns or sets the fault's detail element. Like the actor, this isn't always a required element. Note that fault detail content in a message is represented as tag blocks. Thus, the values passed to this accessor when setting the value are either SOAP::Data objects, or more general blessed hash references. In addition to these methods, the SOAP::Fault package also provides detail as an alias for faultdetail. The former is the actual name of the element with SOAP faults, but the latter name is less ambiguous when regarded with the rest of the SOAP::Lite package. Objects of this class also have a special stringification enabled. If an object is printed or otherwise stringified, the value produced is faultcode: faultstring, with the attribute values of the object. SEE ALSO
SOAP::Data, SOAP::Header, SOAP::SOM ACKNOWLEDGEMENTS
Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from Programming Web Services with Perl, mainly the SOAP::Lite reference found in Appendix B. COPYRIGHT
Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. AUTHORS
Paul Kulchenko (paulclinger@yahoo.com) Randy J. Ray (rjray@blackperl.com) Byrne Reese (byrne@majordojo.com) perl v5.12.1 2008-03-15 SOAP::Fault(3)