table of contents
Apache::XMLRPC::Lite(3) | User Contributed Perl Documentation | Apache::XMLRPC::Lite(3) |
NAME¶
Apache::XMLRPC::Lite - mod_perl-based XML-RPC server with minimum configuration
SYNOPSIS¶
- httpd.conf (Location), directory-based access
-
<Location /mod_xmlrpc> SetHandler perl-script PerlHandler Apache::XMLRPC::Lite 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 "\.xmlrpc$"> SetHandler perl-script PerlHandler Apache::XMLRPC::Lite 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::XMLRPC::Lite 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 XML-RPC protocol with easy configuration (either in .conf or in .htaccess file). This functionality should give you lightweight option for hosting SOAP services and greatly simplify configuration aspects. This module inherites functionality from XMLRPC::Transport::HTTP::Apache component of XMLRPC::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 XMLRPC::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
XMLRPC::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¶
XMLRPC::Lite mod_perl
SEE ALSO¶
XMLRPC::Transport::HTTP::Apache for implementation details, XMLRPC::Lite for general information, and F<examples/server/mod_xmlrpc.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)
2014-06-25 | perl v5.40.0 |