.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Lemonldap::NG::Common::Conf::SOAP 3pm"
.TH Lemonldap::NG::Common::Conf::SOAP 3pm "2011-07-08" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Lemonldap::NG::Common::Conf::SOAP \- Perl extension written to access to
Lemonldap::NG Web\-SSO configuration via SOAP.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "Client side"
.IX Subsection "Client side"
\fIArea protection (Apache handler)\fR
.IX Subsection "Area protection (Apache handler)"
.PP
.Vb 1
\&  package My::Package;
\&  
\&  use base Lemonldap::NG::Handler::SharedConf;
\&  
\&  _\|_PACKAGE_\|_\->init ( {
\&      localStorage        => "Cache::FileCache",
\&      localStorageOptions => {
\&                \*(Aqnamespace\*(Aq          => \*(AqMyNamespace\*(Aq,
\&                \*(Aqdefault_expires_in\*(Aq => 600,
\&      },
\&      configStorage       => {
\&                type     => \*(AqSOAP\*(Aq,
\&                proxy    => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\&                # If soapserver is protected by HTTP Basic:
\&                User     => \*(Aqhttp\-user\*(Aq,
\&                Password => \*(Aqpass\*(Aq,
\&      },
\&      https               => 0,
\&  } );
.Ve
.PP
\fIAuthentication portal\fR
.IX Subsection "Authentication portal"
.PP
.Vb 1
\&  use Lemonldap::NG::Portal::SharedConf;
\&  
\&  my $portal = Lemonldap::NG::Portal::SharedConf\->new ( {
\&          configStorage => {
\&                  type    => \*(AqSOAP\*(Aq,
\&                  proxy    => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\&                  # If soapserver is protected by HTTP Basic:
\&                  User     => \*(Aqhttp\-user\*(Aq,
\&                  Password => \*(Aqpass\*(Aq,
\&          }
\&  });
\&  # Next as usual... See Lemonldap::NG::Portal(3)
\&  if($portal\->process()) {
\&    ...
.Ve
.PP
\fIManager\fR
.IX Subsection "Manager"
.PP
.Vb 1
\&  use Lemonldap::NG::Manager;
\&  
\&  my $m=new Lemonldap::NG::Manager(
\&       {
\&           configStorage=>{
\&                  type  => \*(AqSOAP\*(Aq,
\&                  proxy    => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\&                  # If soapserver is protected by HTTP Basic:
\&                  User     => \*(Aqhttp\-user\*(Aq,
\&                  Password => \*(Aqpass\*(Aq,
\&           },
\&            dhtmlXTreeImageLocation=> "/imgs/",
\&        }
\&  ) or die "Unable to start manager";
\&  
\&  $m\->doall();
.Ve
.SS "Server side"
.IX Subsection "Server side"
You just have to set \*(L"Soap => 1\*(R" in your portal. See \s-1HTML\s0 documentation for
more.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Lemonldap::NG::Common::Conf provides a simple interface to access to
Lemonldap::NG Web-SSO configuration. It is used by Lemonldap::NG::Handler,
Lemonldap::NG::Portal and Lemonldap::NG::Manager.
.PP
Lemonldap::NG::Common::Conf::SOAP provides the \*(L"\s-1SOAP\s0\*(R" target used to access
configuration via \s-1SOAP\s0.
.SS "\s-1SECURITY\s0"
.IX Subsection "SECURITY"
As Lemonldap::NG::Common::Conf::SOAP use SOAP::Lite, you have to see
SOAP::Transport to know arguments that can be passed to \f(CW\*(C`proxyOptions\*(C'\fR.
Lemonldap::NG provides a system for \s-1HTTP\s0 basic authentication.
.PP
Examples :
.IP "\(bu" 4
\&\s-1HTTP\s0 Basic authentication
.Sp
.Vb 1
\&  package My::Package;
\&  
\&  use base Lemonldap::NG::Handler::SharedConf;
\&  
\&  _\|_PACKAGE_\|_\->init ( {
\&      localStorage        => "Cache::FileCache",
\&      localStorageOptions => {
\&                \*(Aqnamespace\*(Aq          => \*(AqMyNamespace\*(Aq,
\&                \*(Aqdefault_expires_in\*(Aq => 600,
\&      },
\&      configStorage       => {
\&                type  => \*(AqSOAP\*(Aq,
\&                proxy => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\&                User     => \*(Aqhttp\-user\*(Aq,
\&                Password => \*(Aqpass\*(Aq,
\&      },
\&      https               => 1,
\&  } );
.Ve
.IP "\(bu" 4
\&\s-1SSL\s0 Authentication
.Sp
SOAP::transport provides a simple way to use \s-1SSL\s0 certificate: you've just to
set environment variables.
.Sp
.Vb 1
\&  package My::Package;
\&  
\&  use base Lemonldap::NG::Handler::SharedConf;
\&  
\&  # AUTHENTICATION
\&  $ENV{HTTPS_CERT_FILE} = \*(Aqclient\-cert.pem\*(Aq;
\&  $ENV{HTTPS_KEY_FILE}  = \*(Aqclient\-key.pem\*(Aq;
\&  
\&  _\|_PACKAGE_\|_\->init ( {
\&      localStorage        => "Cache::FileCache",
\&      localStorageOptions => {
\&                \*(Aqnamespace\*(Aq          => \*(AqMyNamespace\*(Aq,
\&                \*(Aqdefault_expires_in\*(Aq => 600,
\&      },
\&      configStorage       => {
\&                type  => \*(AqSOAP\*(Aq,
\&                proxy => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\&      },
\&      https               => 1,
\&  } );
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Lemonldap::NG::Common::Conf::SOAP,
Lemonldap::NG::Handler, Lemonldap::NG::Portal,
http://lemonldap\-ng.org/ <http://lemonldap-ng.org/>
.SH "AUTHOR"
.IX Header "AUTHOR"
Xavier Guimard, <x.guimard@free.fr>
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use \s-1OW2\s0 system to report bug or ask for features:
<http://jira.ow2.org>
.SH "DOWNLOAD"
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
<http://forge.objectweb.org/project/showfiles.php?group_id=274>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2007, 2010 by Xavier Guimard
.PP
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.