apache::xmlrpc::lite(3pm) [debian man page]

Apache::XMLRPC::Lite(3pm)				User Contributed Perl Documentation				 Apache::XMLRPC::Lite(3pm)

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)

perl v5.12.4							    2011-08-18						 Apache::XMLRPC::Lite(3pm)

XMLRPC::Transport::HTTP(3)				User Contributed Perl Documentation				XMLRPC::Transport::HTTP(3)

NAME

       XMLRPC::Transport::HTTP - Server/Client side HTTP support for XMLRPC::Lite

SYNOPSIS

       Client
	     use XMLRPC::Lite
	       proxy => 'http://localhost/',
	     # proxy => 'http://localhost/cgi-bin/xmlrpc.cgi', # local CGI server
	     # proxy => 'http://localhost/',		       # local daemon server
	     # proxy => 'http://login:password@localhost/cgi-bin/xmlrpc.cgi', # local CGI server with authentication
	     ;

	     print getStateName(1);

       CGI server
	     use XMLRPC::Transport::HTTP;

	     my $server = XMLRPC::Transport::HTTP::CGI
	       -> dispatch_to('methodName')
	       -> handle
	     ;

       Daemon server
	     use XMLRPC::Transport::HTTP;

	     my $daemon = XMLRPC::Transport::HTTP::Daemon
	       -> new (LocalPort => 80)
	       -> dispatch_to('methodName')
	     ;
	     print "Contact to XMLRPC server at ", $daemon->url, "
";
	     $daemon->handle;

DESCRIPTION

       This class encapsulates all HTTP related logic for a XMLRPC server, independent of what web server it's attached to.  If you want to use
       this class you should follow simple guideline mentioned above.

   PROXY SETTINGS
       You can use any proxy setting you use with LWP::UserAgent modules:

	XMLRPC::Lite->proxy('http://endpoint.server/',
			    proxy => ['http' => 'http://my.proxy.server']);

       or

	$xmlrpc->transport->proxy('http' => 'http://my.proxy.server');

       should specify proxy server for you. And if you use "HTTP_proxy_user" and "HTTP_proxy_pass" for proxy authorization SOAP::Lite should know
       how to handle it properly.

   COOKIE-BASED AUTHENTICATION
	 use HTTP::Cookies;

	 my $cookies = HTTP::Cookies->new(ignore_discard => 1);
	   # you may also add 'file' if you want to keep them between sessions

	 my $xmlrpc = XMLRPC::Lite->proxy('http://localhost/');
	 $xmlrpc->transport->cookie_jar($cookies);

       Cookies will be taken from response and provided for request. You may always add another cookie (or extract what you need after response)
       with HTTP::Cookies interface.

       You may also do it in one line:

	 $xmlrpc->proxy('http://localhost/',
			cookie_jar => HTTP::Cookies->new(ignore_discard => 1));

   COMPRESSION
       XMLRPC::Lite provides you option for enabling compression on wire (for HTTP transport only). Both server and client should support this
       capability, but this logic should be absolutely transparent for your application.  Server will respond with encoded message only if client
       can accept it (client sends Accept-Encoding with 'deflate' or '*' values) and client has fallback logic, so if server doesn't understand
       specified encoding (Content-Encoding: deflate) and returns proper error code (415 NOT ACCEPTABLE) client will repeat the same request not
       encoded and will store this server in per-session cache, so all other requests will go there without encoding.

       Having options on client and server side that let you specify threshold for compression you can safely enable this feature on both client
       and server side.

       Compression will be enabled on client side IF: threshold is specified AND size of current message is bigger than threshold AND module
       Compress::Zlib is available. Client will send header 'Accept-Encoding' with value 'deflate' if threshold is specified AND module
       Compress::Zlib is available.

       Server will accept compressed message if module Compress::Zlib is available, and will respond with compressed message ONLY IF: threshold is
       specified AND size of current message is bigger than threshold AND module Compress::Zlib is available AND header 'Accept-Encoding' is
       presented in request.

DEPENDENCIES

	Crypt::SSLeay		  for HTTPS/SSL
	HTTP::Daemon		  for XMLRPC::Transport::HTTP::Daemon
	Apache, Apache::Constants for XMLRPC::Transport::HTTP::Apache

SEE ALSO

	See ::CGI, ::Daemon and ::Apache for implementation details.
	See examples/XMLRPC/* for examples.

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)

perl v5.12.1							    2010-03-18						XMLRPC::Transport::HTTP(3)