/ 
XML-Compile-SOAP-Daemon-3.01
River stage one • 2 direct dependents • 2 total dependents
/ XML::Compile::SOAP::Daemon::CGI

NAME

XML::Compile::SOAP::Daemon::CGI - CGI based server

INHERITANCE

XML::Compile::SOAP::Daemon::CGI
  is a XML::Compile::SOAP::Daemon

SYNOPSIS

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

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

# per connected client
my $query = CGI->new;
$daemon->runCgiRequest(query => $query);

DESCRIPTION

This module handles the exchange of SOAP messages via Apache, using mod_perl and the popular Perl module CGI. Have a look at the examples/ directory, contained in the XML-Compile-SOAP-Daemon distribution.

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.

METHODS

Constructors

XML::Compile::SOAP::Daemon::CGI->new(OPTIONS)
-Option            --Defined in     --Default
 accept_slow_select  XML::Compile::SOAP::Daemon  <true>
 output_charset      XML::Compile::SOAP::Daemon  'UTF-8'
 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
soap_action_input => HASH|ARRAY
wsa_action_input => HASH|ARRAY
wsa_action_output => HASH|ARRAY

Attributes

$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

$obj->process(OPTIONS)

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

$obj->run(OPTIONS)

Used by runCgiRequest() to process a connection. Not to be called directly.

$obj->runCgiRequest(OPTIONS)
-Option     --Default
 postprocess  undef
 query        <created internally>
postprocess => CODE

When defined, the CODE will get called with a HASH (containing OPTIONS and other compile information), a HASH of headers (which you may change), the HTTP return code, and a reference to the message body (which may be changed as well).

Be warned that the message body must be considered as bytes, so not as Latin1 or utf-8 string. You may wish to add or remove bytes. The Content-Length will be added to the headers after the call.

query => <CGI object>

Preparations

$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

$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

Operation handlers

Returning errors

Returning general errors

Returning private errors

How to use the CGI module

The code and documentation for this module was contributed by Patrick Powell in December 2010. Both have seen major changes since.

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.01, built on February 13, 2012. 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::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-2012 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