Lemonldap::NG::Portal::Main::Request(3pm)

Lemonldap::NG::Portal::Main::Request3pm

Http request object used in llng portal methods.

Usage

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

Overview

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

Methods

Accessors

steps()

Stack of methods to call for this requests. It can be modified to change authentication process

data()

Free hash ref where plugins can store their data (during one request). Using it is a LLNG best practice

pdata

Free hash ref where plugins can store some persistent data: data are kept during auth process and cleaned after successful authentication, except if "$req->pdata->{keepPdata}" is set to an array of values. In this case, module that has set these values must remove them after its job ends.

User information

id()

Session id (main cookie value).

sessionInfo()

Hash ref that will be stored in session DB.

user()

Username given by authentication module, used by userDB module.

mustRedirect()

Boolean to indicate that response must be a redirection (used for example when request is a POST).

urlNotBase64

Boolean to indicate that url isn't Base64 encoded.

Other methods

info()

Store info to display in response.

menuError()

notification()

see notification plugin.

errorType()

Returns positive/warning/negative depending on value stored in error property.

Cookie methods

addCookie(string $cookie): add cookie in $req response headers. String is a complete cookie string, ex: "lemonldap=xxx"
delCookie(string $cookieName): remove cookie from $req response headers. It doesn't remove navigator cookie but remove a "Set-Cookie" header if value match "ltcookieNamegt=..."

Bug report

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

Download

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

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

Authors

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

From liblemonldap-ng-portal-perl 2.21.2+ds-1+deb13u3 in Debian 13 (Trixie). Parsed by carta from the page's man source.