From a4dbbf2ccde019effb7cdcb93acd5c60767042e5 Mon Sep 17 00:00:00 2001
From: Xavier Guimard <xavier.guimard@laposte.net>
Date: Tue, 3 Mar 2009 06:21:52 +0000
Subject: [PATCH] POD

---
 .../lib/Lemonldap/NG/Common/CGI/SOAPServer.pm | 36 ++++++++++++
 .../Lemonldap/NG/Common/CGI/SOAPService.pm    | 33 +++++++++++
 .../lib/Lemonldap/NG/Manager/Sessions.pm      |  1 -
 .../lib/Lemonldap/NG/Portal/AuthRemote.pm     | 55 +++++++++++++++++++
 4 files changed, 124 insertions(+), 1 deletion(-)

diff --git a/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm b/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm
index b1b1efe04..5adcfba5e 100644
--- a/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm
+++ b/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm
@@ -83,3 +83,39 @@ sub handle {
 1;
 __END__
 
+=head1 NAME
+
+Lemonldap::NG::Common::CGI::SOAPServer - Extends L<SOAP::Lite> to be compatible
+with L<CGI>.
+
+=head1 SYNOPSIS
+
+  use CGI;
+  use Lemonldap::NG::Common::CGI::SOAPServer;
+  
+  my $cgi = CGI->new();
+  Lemonldap::NG::Common::CGI::SOAPServer->dispatch_to('same as SOAP::Lite')
+     ->handle($cgi)
+
+=head1 DESCRIPTION
+
+This extension just extend L<SOAP::Lite> handle() method to load datas from
+a L<CGI> object instead of STDIN.
+
+=head1 SEE ALSO
+
+L<http://lemonldap.objectweb.org/>, L<Lemonldap::NG::Common::CGI>
+
+=head1 AUTHOR
+
+Xavier Guimard, E<lt>x.guimard@free.frE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2009 by Xavier Guimard
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.10.0 or,
+at your option, any later version of Perl 5 you may have available.
+
+=cut
diff --git a/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm b/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm
index 2febe9616..18f5c3287 100644
--- a/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm
+++ b/modules/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm
@@ -42,3 +42,36 @@ sub AUTOLOAD {
 
 1;
 
+__END__
+
+=head1 NAME
+
+Lemonldap::NG::Common::CGI::SOAPService - Wrapper for all SOAP functions of
+Lemonldap::NG CGIs.
+
+=head1 SYNOPSIS
+
+See L<Lemonldap::NG::Common::CGI>
+
+=head1 DESCRIPTION
+
+Private class used by L<Lemonldap::NG::Common::CGI> to control SOAP functions
+access.
+
+=head1 SEE ALSO
+
+L<http://lemonldap.objectweb.org/>, L<Lemonldap::NG::Common::CGI>
+
+=head1 AUTHOR
+
+Xavier Guimard, E<lt>x.guimard@free.frE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2009 by Xavier Guimard
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.10.0 or,
+at your option, any later version of Perl 5 you may have available.
+
+=cut
diff --git a/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Sessions.pm b/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Sessions.pm
index ae033a5fc..a4aa9cb48 100755
--- a/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Sessions.pm
+++ b/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Sessions.pm
@@ -1139,7 +1139,6 @@ EOF
 }
 1;
 __END__
-# Below is stub documentation for your module. You'd better edit it!
 
 =head1 NAME
 
diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthRemote.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthRemote.pm
index da9e0fbfa..2c803290a 100644
--- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthRemote.pm
+++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/AuthRemote.pm
@@ -42,3 +42,58 @@ sub authenticate {
 
 1;
 
+__END__
+
+=head1 NAME
+
+Lemonldap::NG::Portal::AuthRemote - Authentication module for Lemonldap::NG
+that delegates authentication to a remote Lemonldap::NG portal.
+
+=head1 SYNOPSIS
+
+  use Lemonldap::NG::Portal::Simple;
+  my $portal = new Lemonldap::NG::Portal::Simple(
+         
+         # AUTHENTICATION PART
+         authentication      => 'Remote', 
+         remotePortal        => 'https://auth.remote.com/',
+         # Example with SOAP access to remote session DB
+         remoteGlobalStorage => 'Lemonldap::NG::Common::Apache::Session::SOAP',
+         remoteGlobalStorageOptions => {
+             proxy    => 'https://auth.remote.com/index.pl/sessions',
+             ns => 'urn://auth.remote.com/Lemonldap/NG/Common/CGI/SOAPService',
+             user     => 'myuser',
+             password => 'mypass',
+         }
+         # Optional parameters if remote parameters are not the same.
+         # Example with default values:
+         remoteCookieName => 'lemonldap',
+         remoteUserField  => 'uid',
+         
+         # USER DATABASE PART (not required if remote users exists in your DB)
+         userDB              => 'Remote',
+    );
+
+=head1 DESCRIPTION
+
+Authentication module for Lemonldap::NG portal that delegates authentication to
+a remote portal.
+
+=head1 SEE ALSO
+
+L<http://lemonldap.objectweb.org/>
+L<http://wiki.lemonldap.objectweb.org/xwiki/bin/view/NG/AuthRemote>
+
+=head1 AUTHOR
+
+Xavier Guimard, E<lt>x.guimard@free.frE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2009 by Xavier Guimard
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.10.0 or,
+at your option, any later version of Perl 5 you may have available.
+
+=cut