1Lemonldap::NG::Portal::UMsaeirn:C:oRnetqruiebsutt(e3d)PLeermlonDlodcaupm:e:nNtGa:t:iPoonrtal::Main::Request(3)
2
3
4

NAME

6       Lemonldap::NG::Portal::Main::Request - HTTP request object used in LLNG
7       portal methods.
8

SYNOPSIS

10         # Somewhere in a plugin...
11         sub run {
12             my ( $self, $req ) = @_;
13             # $req is a Lemonldap::NG::Portal::Main::Request object
14             ...
15         }
16

DESCRIPTION

18       Lemonldap::NG::Portal::Main::Request extends
19       Lemonldap::NG::Common::PSGI::Request to add all parameters needed to
20       manage portal jobs.
21

METHODS

23   Accessors
24       steps()
25
26       Stack of methods to call for this requests. It can be modified to
27       change authentication process
28
29       data()
30
31       Free hash ref where plugins can store their data (during one request).
32       Using it is a LLNG best practice
33
34       pdata
35
36       Free hash ref where plugins can store some persistent data: data are
37       kept during auth process and cleaned after successful authentication,
38       except if "$req->pdata->{keepPdata}" is set to an array of values. In
39       this case, module that has set these values must remove them after its
40       job ends.
41
42       User information
43
44       id()
45
46       Session id (main cookie value).
47
48       sessionInfo()
49
50       Hash ref that will be stored in session DB.
51
52       user()
53
54       Username given by authentication module, used by userDB module.
55
56       mustRedirect()
57
58       Boolean to indicate that response must be a redirection (used for
59       example when request is a POST).
60
61       urlNotBase64
62
63       Boolean to indicate that url isn't Base64 encoded.
64
65   Other methods
66       info()
67
68       Store info to display in response.
69
70       menuError()
71
72       notification()
73
74       see notification plugin.
75
76       errorType()
77
78       Returns positive/warning/negative depending on value stored in error
79       property.
80
81   Cookie methods
82       addCookie(string $cookie): add cookie in $req response headers. String
83       is a complete cookie string, ex: "lemonldap=xxx"
84       delCookie(string $cookieName): remove cookie from $req response
85       headers. It doesn't remove navigator cookie but remove a "Set-Cookie"
86       header if value match "ltcookieNamegt=..."
87

SEE ALSO

89       <http://lemonldap-ng.org/>, Lemonldap::NG::Common::PSGI::Request
90

AUTHORS

92       LemonLDAP::NG team <http://lemonldap-ng.org/team>
93

BUG REPORT

95       Use OW2 system to report bug or ask for features:
96       <https://gitlab.ow2.org/lemonldap-ng/lemonldap-ng/issues>
97

DOWNLOAD

99       Lemonldap::NG is available at <https://lemonldap-ng.org/download>
100

102       See COPYING file for details.
103
104       This library is free software; you can redistribute it and/or modify it
105       under the terms of the GNU General Public License as published by the
106       Free Software Foundation; either version 2, or (at your option) any
107       later version.
108
109       This program is distributed in the hope that it will be useful, but
110       WITHOUT ANY WARRANTY; without even the implied warranty of
111       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
112       General Public License for more details.
113
114       You should have received a copy of the GNU General Public License along
115       with this program.  If not, see <http://www.gnu.org/licenses/>.
116
117
118
119perl v5.38.0                      2023-1L1e-m1o4nldap::NG::Portal::Main::Request(3)
Impressum