Mark Overmeer > XML-Compile-SOAP-Daemon-3.06 > XML::Compile::SOAP::Daemon::PSGI

Download:
XML-Compile-SOAP-Daemon-3.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 3.06   Source   Latest Release: XML-Compile-SOAP-Daemon-3.09

NAME ^

XML::Compile::SOAP::Daemon::PSGI - PSGI based application

INHERITANCE ^

 XML::Compile::SOAP::Daemon::PSGI
   is a XML::Compile::SOAP::Daemon

 XML::Compile::SOAP::Daemon::PSGI
   is a Plack::Component

SYNOPSIS ^

 #### have a look in the examples directory!
 use XML::Compile::SOAP::Daemon::PSGI;
 my $daemon = XML::Compile::SOAP::Daemon::PSGI->new;

 # initialize definitions from WSDL
 my $wsdl    = XML::Compile::WSDL11->new(...);
 $wsdl->importDefinitions(...); # more schemas
 $daemon->operationsFromWSDL($wsdl, callbacks => ...);

 # generate PSGI application
 my $app = $daemon->to_app;
 $app;

DESCRIPTION ^

This module handles the exchange of SOAP messages via PSGI stack, using Plack toolkit. This module was contributed by Piotr Roszatycki.

This abstraction level of the object (code in this pm file) is not concerned with parsing or composing XML, but only worries about the HTTP transport specifics of SOAP messages.

See documentation in base class.

METHODS ^

See documentation in base class.

Constructors

See documentation in base class.

XML::Compile::SOAP::Daemon::PSGI->new(OPTIONS)
 -Option            --Defined in                --Default
  accept_slow_select  XML::Compile::SOAP::Daemon  <true>
  output_charset      XML::Compile::SOAP::Daemon  'UTF-8'
  postprocess                                     undef
  preprocess                                      undef
  soap_action_input   XML::Compile::SOAP::Daemon  {}
  wsa_action_input    XML::Compile::SOAP::Daemon  {}
  wsa_action_output   XML::Compile::SOAP::Daemon  {}
accept_slow_select => BOOLEAN
output_charset => STRING
postprocess => CODE

When defined, the CODE will get called with a Plack::Request and Plack::Response objects after processing SOAP message.

preprocess => CODE

When defined, the CODE will get called with a Plack::Request object before processing SOAP message.

soap_action_input => HASH|ARRAY
wsa_action_input => HASH|ARRAY
wsa_action_output => HASH|ARRAY

Attributes

See documentation in base class.

$obj->addSoapAction(HASH|PAIRS)

See "Attributes" in XML::Compile::SOAP::Daemon

$obj->addWsaTable(('INPUT'|'OUTPUT'), [HASH|PAIRS])

See "Attributes" in XML::Compile::SOAP::Daemon

$obj->outputCharset()

See "Attributes" in XML::Compile::SOAP::Daemon

Running the server

See documentation in base class.

$obj->call(ENV)

Process the content of a single message. Not to be called directly.

$obj->process(CLIENT, XMLIN, REQUEST, ACTION)

See "Running the server" in XML::Compile::SOAP::Daemon

$obj->run(OPTIONS)

The same as to_app but accepts additional preprocess and postprocess options.

$obj->to_app()

Converts the server into a PSGI $app.

Preparations

See documentation in base class.

$obj->addHandler(NAME, SOAP, CODE)

See "Preparations" in XML::Compile::SOAP::Daemon

$obj->operationsFromWSDL(WSDL, OPTIONS)

See "Preparations" in XML::Compile::SOAP::Daemon

$obj->setWsdlResponse(FILENAME)

See "Preparations" in XML::Compile::SOAP::Daemon

Helpers

See documentation in base class.

$obj->faultInvalidXML(ERROR)

See "Helpers" in XML::Compile::SOAP::Daemon

$obj->faultNotSoapMessage(NODETYPE)

See "Helpers" in XML::Compile::SOAP::Daemon

$obj->faultUnsupportedSoapVersion(ENV_NS)

See "Helpers" in XML::Compile::SOAP::Daemon

$obj->handlers(('SOAP11'|'SOAP12'|SOAP))

See "Helpers" in XML::Compile::SOAP::Daemon

$obj->printIndex([FILEHANDLE])

See "Helpers" in XML::Compile::SOAP::Daemon

$obj->soapVersions()

See "Helpers" in XML::Compile::SOAP::Daemon

DETAILS ^

See documentation in base class.

Operation handlers

See documentation in base class.

Returning errors

See documentation in base class.

How to use the PSGI module

The code and documentation for this module was contributed by Piotr Roszatycki in March 2012.

Go to the examples/mod_perl/ directory which is included in the distribution of this module, XML::Compile::SOAP::Daemon There you find a README describing the process.

SEE ALSO ^

This module is part of XML-Compile-SOAP-Daemon distribution version 3.06, built on May 03, 2013. Website: http://perl.overmeer.net/xml-compile/

Other distributions in this suite: XML::Compile, XML::Compile::SOAP, XML::Compile::SOAP12, XML::Compile::SOAP::Daemon, XML::Compile::SOAP::WSA, XML::Compile::C14N, XML::Compile::WSS, XML::Compile::WSS::Signature, XML::Compile::Tester, XML::Compile::Cache, XML::Compile::Dumper, XML::Compile::RPC, XML::Rewrite, XML::eXistDB, and XML::LibXML::Simple.

Please post questions or ideas to the mailinglist at http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/xml-compile

For live contact with other developers, visit the #xml-compile channel on irc.perl.org.

LICENSE ^

Copyrights 2007-2013 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

syntax highlighting: