.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Lemonldap::NG::Handler::PSGI::Try 3pm"
.TH Lemonldap::NG::Handler::PSGI::Try 3pm "2020-09-07" "perl v5.28.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::Handler::PSGI::Try \- Special handler for Lemonldap::NG Portal
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package My::PSGI;
\&  
\&  use base Lemonldap::NG::Handler::PSGI::Try;
\&  
\&  sub init {
\&    my ($self,$args) = @_;
\&    
\&    # Declare REST routes for authenticated users (could be HTML templates or
\&    # methods)
\&    $self\->addAuthRoute ( \*(Aqindex.html\*(Aq, undef, [\*(AqGET\*(Aq] )
\&         \->addAuthRoute ( books => { \*(Aq:book\*(Aq => \*(AqbooksMethod\*(Aq }, [\*(AqGET\*(Aq, \*(AqPOST\*(Aq] );
\&  
\&    # Default route (ie: PATH_INFO == \*(Aq/\*(Aq)
\&    $self\->defaultAuthRoute(\*(Aqindex.html\*(Aq);
\&  
\&    # Same for unauthenticated users
\&    $self\->addUnauthRoute ( \*(Aqlogin.html\*(Aq, undef, [\*(AqGET\*(Aq] )
\&         \->addUnauthRoute ( \*(Aqlogin\*(Aq, undef, [\*(AqPOST\*(Aq] );
\&    $self\->defaultUnauthRoute(\*(Aqlogin.html\*(Aq);
\&   
\&    # Return a boolean. If false, then error message has to be stored in
\&    # $self\->error
\&    return 1;
\&  }
\&  
\&  sub booksMethod {
\&    my ( $self, $req, @otherPathInfo ) = @_;
\&
\&    # Will be called only if authorized
\&    my $userId = $self\->userId;
\&    my $book = $req\->params(\*(Aqbook\*(Aq);
\&    my $method = $req\->method;
\&    ...
\&    $self\->sendJSONresponse(...);
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Lemonldap::NG::Handler::PSGI::Try is a Lemonldap::NG::Handler::PSGI::Router
package that provides 2 \s-1REST\s0 routers: one for authenticated users and one for
unauthenticated users.
.SH "METHODS"
.IX Header "METHODS"
Same as Lemonldap::NG::Handler::PSGI::Router (inherits from
Lemonldap::NG::Common::PSGI::Router) except that:
.IP "\fBaddRoute()\fR must be replaced by \fBaddAuthRoute()\fR or \fBaddUnauthRoute()\fR" 4
.IX Item "addRoute() must be replaced by addAuthRoute() or addUnauthRoute()"
.PD 0
.IP "\fBdefaultRoute()\fR must be replaced by \fBdefaultAuthRoute()\fR or \fBdefaultUnauthRoute()\fR" 4
.IX Item "defaultRoute() must be replaced by defaultAuthRoute() or defaultUnauthRoute()"
.PD
.PP
Note also that user session datas are available in \f(CW$req\fR parameter (first argument
received by \s-1REST\s0 methods):
.ie n .IP "$req\->\fBuserData()\fR returns a hash reference containing user session data" 4
.el .IP "\f(CW$req\fR\->\fBuserData()\fR returns a hash reference containing user session data" 4
.IX Item "$req->userData() returns a hash reference containing user session data"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Lemonldap::NG::Common::PSGI::Router for more.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "LemonLDAP::NG team <http://lemonldap\-ng.org/team>" 4
.IX Item "LemonLDAP::NG team <http://lemonldap-ng.org/team>"
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use \s-1OW2\s0 system to report bug or ask for features:
<https://gitlab.ow2.org/lemonldap\-ng/lemonldap\-ng/issues>
.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"
See \s-1COPYING\s0 file for details.
.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 <http://www.gnu.org/licenses/>.