6. GenticsLoginModule

6.1. Introduction

This portlet can be used to let users log in. It consists of two TextComponents and one ButtonComponent. You may customize these templates by adding a template loader to your configuration. The class 'PasswordClass' is assigned to the TextComponent that is used for password input.

6.2. Parameters

Table 5.14.  Portlet parameters for GenticsLoginModule

NameTypeDefaultDescription
loginregexStringNULLRegex to check for allowed login names.
logindescriptionStringNULLMessage to be shown when the entered login name does not match the given loginregex.
passwordregexStringNULLRegex to check for allowed passwords.
passworddescriptionStringNULLMessage to be shown when the entered password does not match the given passwordregex.
[Warning]Warning

The parameters loginregex and passwordregex are only used to validate user input if the user login fails. If the regular expressions do not match used passwords the users will still be able to log in.

6.3. Properties

Table 5.15.  Portlet Properties for GenticsLoginModule

VariableTypeDescription
logouturlStringURL to log out.

6.4. Events of the GenticsLoginModule

Table 5.16. Events of the GenticsLoginModule

NameDescriptionEvent properties
onUserLogoutThis event is triggered when a user logs out.
NameDescription
No event properties.

When the user logs in (either using the GenticsLoginModule or through other means) a portal.events.onLogin is triggered. See “Portal events” (Section 3.2) for details.