ePages 7.21.0 - DE_EPAGES/Presentation/API/LoginChecker.pm

Package DE_EPAGES::Presentation::API::LoginChecker

The LoginChecker class is a trigger dispatcher for the Login action: LoginAttempt A login is started LoginFailure A login attempt has failed LoginSucessful A login has been finish succesfuly The Listeners can stop the Login process in the step LoginAttempt setting: $hTriggerArguments->{'MessageResponse'}->{'CancelLogin'} = 1 ; and notice the reason by, for instance: $hTriggerArguments->{'MessageResponse'}->{'Reason'} = 'LOGIN_LOCKED' ;

@EXPORT_OK
NewLoginChecker

Functions

NewLoginChecker
new
setUser
startLoginAttempt
triggerLoginFailure
triggerLoginSuccessful

NewLoginChecker

Function responsible to create and return a new LoginChecker object.

Syntax
$LoginChecker = NewLoginChecker( $Servlet ) ;
Input
$Servlet (object)
servlet
Return
$LoginChecker (object)
LoginChecker object

new

LoginChecker constructor.

Syntax
$LoginChecker = new( $Servlet ) ;
Input
$Servlet (object)
servlet
Return
$LoginChecker (object)
LoginChecker object

setUser

Setter method for the successfuly logged user

Syntax
$LoginChecker->setUser( $User ) ;
Input
$User (object)
User currently logged

startLoginAttempt

Notify to Listeners a Login is started.

Syntax
$LoginChecker->startLoginAttempt() ;
Return
$hMessageResponse (hash.ref)
Hash with the trigger listeners response. If a Listener wants to stop the Login
process it should use the attribute 'CancelLogin' in this hash:
  • CancelLogin : If is set to 1 the Login attempt will be stopped (default: 0)
  • Reason : Why the Login must be stopped.

triggerLoginFailure

Notify to Listeners the Login attempt has failed.

Syntax
$LoginChecker->triggerLoginFailure( $FailReason );
Input
$FailReason (string)
The code for the failure passed to the Listeners

triggerLoginSuccessful

Notify to Listeners the Login attempt has finisehd successfuly.

Syntax
$LoginChecker->triggerLoginSuccessful();