.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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" ''
. ds C`
. ds C'
'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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" 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 3pm"
.TH Lemonldap::NG::Common::Conf 3pm "2014-01-17" "perl v5.20.1" "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 \- Perl extension written to manage Lemonldap::NG
Web\-SSO configuration.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\& use Lemonldap::NG::Common::Conf;
\& my $confAccess = new Lemonldap::NG::Common::Conf(
\& {
\& type=>\*(AqFile\*(Aq,
\& dirName=>"/tmp/",
\&
\& # To use local cache, set :
\& localStorage => "Cache::FileCache",
\& localStorageOptions = {
\& \*(Aqnamespace\*(Aq => \*(Aqlemonldap\-ng\-config\*(Aq,
\& \*(Aqdefault_expires_in\*(Aq => 600,
\& \*(Aqdirectory_umask\*(Aq => \*(Aq007\*(Aq,
\& \*(Aqcache_root\*(Aq => \*(Aq/tmp\*(Aq,
\& \*(Aqcache_depth\*(Aq => 5,
\& },
\& },
\& ) or die "Unable to build Lemonldap::NG::Common::Conf, see Apache logs";
\& my $config = $confAccess\->getConf();
.Ve
.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.
.SS "\s-1SUBROUTINES\s0"
.IX Subsection "SUBROUTINES"
.IP "\(bu" 4
\&\fBnew\fR (constructor): it takes different arguments depending on the
chosen type. Examples:
.RS 4
.IP "\(bu" 4
\&\fBFile\fR:
\f(CW$confAccess\fR = new Lemonldap::NG::Common::Conf(
{
type => 'File',
dirName => '/var/lib/lemonldap\-ng/',
});
.IP "\(bu" 4
\&\fB\s-1DBI\s0\fR:
\f(CW$confAccess\fR = new Lemonldap::NG::Common::Conf(
{
type => '\s-1DBI\s0',
dbiChain => 'DBI:mysql:database=lemonldap\-ng;host=1.2.3.4',
dbiUser => 'lemonldap'
dbiPassword => 'pass'
dbiTable => 'lmConfig',
});
.IP "\(bu" 4
\&\fB\s-1SOAP\s0\fR:
\f(CW$confAccess\fR = new Lemonldap::NG::Common::Conf(
{
type => '\s-1SOAP\s0',
proxy => 'http://auth.example.com/index.pl/config',
proxyOptions => {
timeout => 5,
},
});
.Sp
\&\s-1SOAP\s0 configuration access is a sort of proxy: the portal is configured to use
the real session storage type (\s-1DBI\s0 or File for example). See \s-1HTML\s0 documentation
for more.
.IP "\(bu" 4
\&\fB\s-1LDAP\s0\fR:
\f(CW$confAccess\fR = new Lemonldap::NG::Common::Conf(
{
type => '\s-1LDAP\s0',
ldapServer => 'ldap://localhost',
ldapConfBranch => 'ou=conf,ou=applications,dc=example,dc=com',
ldapBindDN => 'cn=manager,dc=example,dc=com",
ldapBindPassword => 'secret'
});
.RE
.RS 4
.Sp
\&\s-1WARNING:\s0 You have to use the same storage type on all Lemonldap::NG parts in
the same server.
.RE
.IP "\(bu" 4
\&\fBgetConf\fR: returns a hash reference to the configuration. it takes
a hash reference as first argument containing 2 optional parameters:
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`cfgNum =\*(C'\fR \f(CW$number\fR>: the number of the configuration wanted. If this
argument is omitted, the last configuration is returned.
.IP "\(bu" 4
\&\f(CW\*(C`fields =\*(C'\fR [array of names]: the desired fields asked. By default,
getConf returns all (\f(CW\*(C`select * from lmConfig\*(C'\fR).
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBsaveConf\fR: stores the Lemonldap::NG configuration passed in argument
(hash reference). it returns the number of the new configuration.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Lemonldap::NG::Handler, Lemonldap::NG::Portal,
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "Clement Oudot, " 4
.IX Item "Clement Oudot, "
.PD 0
.IP "Franc\*,ois\-Xavier Deltombe, " 4
.IX Item "Franc,ois-Xavier Deltombe, "
.IP "Xavier Guimard, " 4
.IX Item "Xavier Guimard, "
.IP "Sandro Cazzaniga, " 4
.IX Item "Sandro Cazzaniga, "
.PD
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use \s-1OW2\s0 system to report bug or ask for features:
.SH "DOWNLOAD"
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "Copyright (C) 2008, 2009, 2010 by Xavier Guimard, " 4
.IX Item "Copyright (C) 2008, 2009, 2010 by Xavier Guimard, "
.PD 0
.IP "Copyright (C) 2012 by Sandro Cazzaniga, " 4
.IX Item "Copyright (C) 2012 by Sandro Cazzaniga, "
.IP "Copyright (C) 2012 by Franc\*,ois\-Xavier Deltombe, " 4
.IX Item "Copyright (C) 2012 by Franc,ois-Xavier Deltombe, "
.IP "Copyright (C) 2009, 2010, 2011, 2012, 2013 by Clement Oudot, " 4
.IX Item "Copyright (C) 2009, 2010, 2011, 2012, 2013 by Clement Oudot, "
.PD
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program. If not, see .