Apache::SOAP (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Apache::SOAP.3pm".)

NAME

Apache::SOAP - mod_perl-based SOAP server with minimum configuration

SYNOPSIS

httpd.conf (Location), directory-based access

  <Location /mod_soap>
    SetHandler perl-script
    PerlHandler Apache::SOAP
    PerlSetVar dispatch_to "/Your/Path/To/Deployed/Modules, Module::Name, Module::method"
    PerlSetVar options "compress_threshold => 10000"
  </Location>

httpd.conf (Files), file-based access

  <FilesMatch "\.soap$">
    SetHandler perl-script
    PerlHandler Apache::SOAP
    PerlSetVar dispatch_to "/Your/Path/To/Deployed/Modules, Module::Name, Module::method"
    PerlSetVar options "compress_threshold => 10000"
  </FilesMatch>

.htaccess, directory-based access

  SetHandler perl-script
  PerlHandler Apache::SOAP
  PerlSetVar dispatch_to "/Your/Path/To/Deployed/Modules, Module::Name, Module::method"
  PerlSetVar options "compress_threshold => 10000"

DESCRIPTION

This Apache Perl module provides the ability to add support for (Simple Object Access Protocol) protocol with easy configuration (either in .conf or in .htaccess file). This functionality should give you lightweight option for hosting services and greatly simplify configuration aspects. This module inherits functionality from SOAP::Transport::HTTP::Apache component of SOAP::Lite module.

CONFIGURATION

The module can be placed in <Location>, <Directory>, <Files>, <FilesMatch> directives in main server configuration areas or directly in .htaccess file.

All parameters should be quoted and can be separated with commas or spaces for lists (``a, b, c'') and with 'wide arrows' and commas for hash parameters (``key1 => value1, key2 => value2'').

All options that you can find in SOAP::Transport::HTTP::Apache component are available for configuration. Here is the description of most important ones.

dispatch_to (

LIST

)

Specifies path to directory that contains Perl modules you'd like to give access to, or just list of modules (for preloaded modules).

  PerlSetVar dispatch_to "/Your/Path/To/Deployed/Modules, Module::Name, Module::method"

options (

HASH

)

Specifies list of options for your module, for example threshold for compression. Future versions will support more options. See SOAP::Transport::HTTP documentation for other options.

  PerlSetVar options "compress_threshold => 10000"

METHODS/SUBROUTINES

server

 my $server = Apache::XMLRPC::Lite->server();

Returns the server object.

Useful if you need to manipulate the server object from your code.

handle

Request handler. Called by apache.

DEPENDENCIES

 SOAP::Lite
 mod_perl

SEE ALSO

 SOAP::Transport::HTTP::Apache for implementation details,
 SOAP::Lite for general information, and
 F<examples/server/mod_soap.htaccess> for .htaccess example

COPYRIGHT

Copyright (C) 2000-2001 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.

AUTHOR

Paul Kulchenko (paulclinger@yahoo.com)