soap::wsdl::factory::serializer(3pm) [debian man page]
SOAP::WSDL::Factory::Serializer(3pm) User Contributed Perl Documentation SOAP::WSDL::Factory::Serializer(3pm) NAME
SOAP::WSDL::Factory::Serializer - Factory for retrieving serializer objects SYNOPSIS
# from SOAP::WSDL::Client: $serializer = SOAP::WSDL::Factory::Serializer->get_serializer({ soap_version => $soap_version, }); # in serializer class: package MyWickedSerializer; use SOAP::WSDL::Factory::Serializer; # register as serializer for SOAP1.2 messages SOAP::WSDL::Factory::Serializer->register( '1.2' , __PACKAGE__ ); DESCRIPTION
SOAP::WSDL::Factory::Serializer serves as factory for retrieving serializer objects for SOAP::WSDL. The actual work is done by specific serializer classes. SOAP::WSDL::Serializer tries to load one of the following classes: o the class registered for the scheme via register() METHODS
register SOAP::WSDL::Serializer->register('1.1', 'MyWickedSerializer'); Globally registers a class for use as serializer class. get_serializer Returns an object of the serializer class for this endpoint. WRITING YOUR OWN SERIALIZER CLASS
Registering a deserializer Serializer classes may register with SOAP::WSDL::Factory::Serializer. Serializer objects may also be passed directly to SOAP::WSDL::Client by using the set_serializer method. Note that serializers objects set via SOAP::WSDL::Client's set_serializer method are discarded when the SOAP version is changed via set_soap_version. Registering a serializer class with SOAP::WSDL::Factory::Serializer is done by executing the following code where $version is the SOAP version the class should be used for, and $class is the class name. SOAP::WSDL::Factory::Serializer->register( $version, $class); To auto-register your transport class on loading, execute register() in your tranport class (see "SYNOPSIS" above). Serializer package layout Serializer modules must be named equal to the serializer class they contain. There can only be one serializer class per serializer module. Methods to implement Serializer classes must implement the following methods: o new Constructor. o serialize Serializes data to XML. The following named parameters are passed to the serialize method in a anonymous hash ref: { method => $operation_name, header => $header_data, body => $body_data, } LICENSE AND COPYRIGHT
Copyright 2004-2007 Martin Kutter. All rights reserved. This file is part of SOAP-WSDL. You may distribute/modify it under the same terms as perl itself. AUTHOR
Martin Kutter <martin.kutter fen-net.de> REPOSITORY INFORMATION
$Rev: 851 $ $LastChangedBy: kutterma $ $Id: Serializer.pm 851 2009-05-15 22:45:18Z kutterma $ $HeadURL: https://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL/Factory/Serializer.pm $ perl v5.10.1 2010-12-21 SOAP::WSDL::Factory::Serializer(3pm)
Check Out this Related Man Page
SOAP::WSDL::Server(3pm) User Contributed Perl Documentation SOAP::WSDL::Server(3pm) NAME
SOAP::WSDL::Server - WSDL based SOAP server base class SYNOPSIS
Don't use directly, use the SOAP::WSDL::Server::* subclasses instead. DESCRIPTION
SOAP::WSDL::Server basically follows the architecture sketched below (though dispatcher classes are not implemented yet) SOAP Request SOAP Response | ^ V | ------------------------------------------ | SOAP::WSDL::Server | | -------------------------------------- | | | Transport Class | | | |--------------------------------------| | | | Deserializer | Serializer | | | |--------------------------------------| | | | Dispatcher | | | -------------------------------------- | ------------------------------------------ | calls ^ v | returns ------------------------------------- | Handler | ------------------------------------- All of the components (Transport class, deserializer, dispatcher and serializer) are implemented as plugins. The architecture is not implemented as planned yet, but the dispatcher is currently part of SOAP::WSDL::Server, which aggregates serializer and deserializer, and is subclassed by transport classes (of which SOAP::WSDL::Server::CGI is the only implemented one yet). The dispatcher is currently based on the SOAPAction header. This does not comply to the WS-I basic profile, which declares the SOAPAction as optional. The final dispatcher will be based on wire signatures (i.e. the classes of the deserialized messages). A hash-based dispatcher could be implemented by examining the top level hash keys. EXCEPTION HANDLING
Builtin exceptions SOAP::WSDL::Server handles the following errors itself: In case of errors, a SOAP Fault containing an appropriate error message is returned. o XML parsing errors o Configuration errors Throwing exceptions The proper way to throw a exception is just to die - SOAP::WSDL::Server::CGI catches the exception and sends a SOAP Fault back to the client. If you want more control over the SOAP Fault sent to the client, you can die with a SOAP::WSDL::SOAP::Fault11 object - or just let the SOAP::Server's deserializer create one for you: my $soap = MyServer::SomeService->new(); die $soap->get_deserializer()->generate_fault({ code => 'SOAP-ENV:Server', role => 'urn:localhost', message => "The error message to pas back", detail => "Some details on the error", }); You may use any other object as exception, provided it has a serialize() method which returns the object's XML representation. Subclassing To write a transport-specific SOAP Server, you should subclass SOAP::WSDL::Server. See the "SOAP::WSDL::Server::*" modules for examples. A SOAP Server must call the following method to actually handle the request: handle Handles the SOAP request. Returns the response message as XML. Expects a "HTTP::Request" object as only parameter. You may use any other object as parameter, as long as it implements the following methods: o header Called as header('SOAPAction'). Must return the corresponding HTTP header. o content Returns the request message LICENSE AND COPYRIGHT
Copyright 2004-2008 Martin Kutter. This file is part of SOAP-WSDL. You may distribute/modify it under the same terms as perl itself AUTHOR
Martin Kutter <martin.kutter fen-net.de> REPOSITORY INFORMATION
$Rev: 391 $ $LastChangedBy: kutterma $ $Id: Client.pm 391 2007-11-17 21:56:13Z kutterma $ $HeadURL: https://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL/Client.pm $ perl v5.10.1 2010-12-21 SOAP::WSDL::Server(3pm)