LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyLoginBehaviorInterface

All Superinterfaces:
LyActionBehaviorInterface, LyBehaviorInterface
All Known Implementing Classes:
LyLoginBehavior

public interface LyLoginBehaviorInterface
extends LyActionBehaviorInterface

This interface defines the methods to implement in order to manage the login of a user.

See Also:
LyLoginController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 void completeInitializeLogin(LyLoginController loginController)
          Complete login initialization with default values or extra fields adding for input.
 boolean confirmReconnect(LyLoginController loginController)
          Returns a boolean value that indicates if the reconnect must be confirmed or not
 void endLogin(LyLoginController loginController, LyParameterValues values)
          Ends the login.
 LySession getExistingSessionForUser(LyLoginController loginController, LyObject currentUser, LyParameterValues values)
          Gets any existing session for the given user
 LyObject getUser(LyLoginController loginController, LyParameterValues values)
          Gets the user associated to the given login and password values.
 void initializeLogin(LyLoginController loginController)
          Login initialization of manipulated classInfo, loginFieldInfo and passwordFieldInfo.
 boolean validate(LyLoginController loginController, java.lang.String login, java.lang.String password, LyParameterValues values)
          Deprecated. since V1.2. Replaced by validate(LyLoginController, String, String, LyParameterValue, StringBuffer).
 boolean validate(LyLoginController loginController, java.lang.String login, java.lang.String password, LyParameterValues values, java.lang.StringBuffer error)
          Validate the login: checks that one unique user exists for the given values.
 boolean validateUser(LyLoginController loginController, LyObject user, LyParameterValues values, java.lang.StringBuffer error, boolean autoLogin)
          Validate the login: checks that user is valid.
 
Methods inherited from interface leon.app.behaviorinterface.LyActionBehaviorInterface
endAction, getClientContext, getContextTitle, getHelpFile, getImage, getImageTooltip, getKeyValue, getMenuItemImage, getTitle, reset, startAction
 
Methods inherited from interface leon.app.behaviorinterface.LyBehaviorInterface
free, handleDemand, init
 

Field Detail

__VERSION

static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Method Detail

initializeLogin

void initializeLogin(LyLoginController loginController)
Login initialization of manipulated classInfo, loginFieldInfo and passwordFieldInfo.

Parameters:
loginController - current controller

completeInitializeLogin

void completeInitializeLogin(LyLoginController loginController)
Complete login initialization with default values or extra fields adding for input.

Parameters:
loginController - current controller

validate

boolean validate(LyLoginController loginController,
                 java.lang.String login,
                 java.lang.String password,
                 LyParameterValues values)
Deprecated. since V1.2. Replaced by validate(LyLoginController, String, String, LyParameterValue, StringBuffer).

Validate the login.

Parameters:
loginController - current controller
login - value typed in by the user
password - value typed in by the user
values - extra values from the login controller validation.
Returns:
true if login is ok, false for default login tries

validate

boolean validate(LyLoginController loginController,
                 java.lang.String login,
                 java.lang.String password,
                 LyParameterValues values,
                 java.lang.StringBuffer error)
Validate the login: checks that one unique user exists for the given values.

Parameters:
loginController - current controller
login - value typed in by the user
password - value typed in by the user
values - extra values from the login controller validation.
error - error message to show in case of invalid login. It is a result parameter.
Returns:
true if login is valid, false otherwise

validateUser

boolean validateUser(LyLoginController loginController,
                     LyObject user,
                     LyParameterValues values,
                     java.lang.StringBuffer error,
                     boolean autoLogin)
Validate the login: checks that user is valid.

Parameters:
loginController - current controller
user - user that logged in.
values - extra values from the login controller validation.
error - error message to show in case of invalid login. It is a result parameter.
autoLogin - boolean indicating if the call results from an auto-login.
Returns:
true if login is valid, false otherwise

endLogin

void endLogin(LyLoginController loginController,
              LyParameterValues values)
Ends the login.

Parameters:
loginController - current controller
values - extra values from the login controller validation.

getUser

LyObject getUser(LyLoginController loginController,
                 LyParameterValues values)
Gets the user associated to the given login and password values.

Parameters:
loginController - current controller
values - values from the login controller.
Returns:
true if everything is done, false othewise and complete generic processing

getExistingSessionForUser

LySession getExistingSessionForUser(LyLoginController loginController,
                                    LyObject currentUser,
                                    LyParameterValues values)
Gets any existing session for the given user

Parameters:
loginController - current controller
currentUser - the current user
values - the values for the current login view
Returns:
a session with the current user as the logged-in user.

confirmReconnect

boolean confirmReconnect(LyLoginController loginController)
Returns a boolean value that indicates if the reconnect must be confirmed or not

Parameters:
loginController - the login controller
Returns:
true if the reconnection has to be confirmed by the user.

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com