public final class LoginConfiguration
extends java.lang.Object
LoginAssistantComponent
Modifier and Type | Field and Description |
---|---|
java.lang.String |
activationErrorMessage
Customizable error message for inactive accounts
|
java.lang.String |
activationField
An optional field to check if the user account was activated.
|
boolean |
allowGuests
If set to true it will allow guest users to enter with a temporary name.
|
IDBManager |
customDBManager
ADVANCED
A custom DatabaseManager object can be specified if there's need to user more than one database.
|
boolean |
customPasswordCheck
Allows to bypass the default password check.
|
java.util.List<java.lang.String> |
extraFields
An optional list of other field names to be loaded in the query
and sent back in the optional SFSObject passed with the login response.
|
java.lang.String |
loginTable
The name of the Database table where user profiles are stored, default is 'users'
|
java.lang.String |
nickNameField
If the user name used for login is not to be used as the nickname of the user in the system, you can specify
which other field in the database contains the nickname.
|
java.lang.String |
passwordField
The name of the field in the Database containing the user password, default is 'password'
|
ILoginAssistantPlugin |
postProcessPlugin
ADVANCED
Allows developers to add and extra plugin class in the login flow to manipulate objects
AFTER the login credentials are verified.
|
ILoginAssistantPlugin |
preProcessPlugin
ADVANCED
Allows developers to add and extra plugin class in the login flow to manipulate objects
BEFORE the login credentials are verified.
|
boolean |
useCaseSensitiveNameChecks
By default user name checks are not case-sensitive.
|
java.lang.String |
userNameField
The name of the field in the Database containing the user name, default is 'username'
|
Constructor and Description |
---|
LoginConfiguration() |
public java.lang.String loginTable
public java.lang.String userNameField
public java.lang.String passwordField
public boolean customPasswordCheck
Since the introduction of TLS encryption clients can send the password as a custom object to avoid the default hashing done in pre-TLS API.
This allows to obtain the original password on the server side in a secure way (using TLS encryption) and check it against the database, using salt etc...
NOTE: when this parameter is turned on the LoginAssistant will not perform any password check. The password check instead must be executed via custom code in the the PreProcess plugin.
For further details and examples see the documentation here:
public boolean useCaseSensitiveNameChecks
You can turn this off if the above example should be detected as the same name.
public boolean allowGuests
NOTE: In order to login as guest, clients must send an empty string for the user name and password.
NOTE 2: If you allow guest users you will want to configure the Zone permissions so that the Guest profile is restricted in the types of request that it can send. For example you may want to deny room creation, public chats, setting variables etc...
public java.lang.String nickNameField
For example, if users log in with an email address or some other code you can specify which field in the DB contains the user's nickname. Default is null (the nickname will be the user name).
public java.lang.String activationField
This convention is particularly useful when used in conjunction with the SignUpAssistantComponent
SignUpAssistantComponent
public java.lang.String activationErrorMessage
public java.util.List<java.lang.String> extraFields
public ILoginAssistantPlugin preProcessPlugin
Allows developers to add and extra plugin class in the login flow to manipulate objects BEFORE the login credentials are verified. This can be useful for example to add extra processing to the password field, if necessary.
A possible use case is when the password is encrypted in the database and needs to be pre-processed (i.e. decrypted)
Default is null (no pre-processing is done)
ILoginAssistantPlugin
public ILoginAssistantPlugin postProcessPlugin
Allows developers to add and extra plugin class in the login flow to manipulate objects AFTER the login credentials are verified. This can be useful to add extra data in the optional SFSObject that can be sent to the client with the Login response.
Default is null (no post-processing is done)
ILoginAssistantPlugin
public IDBManager customDBManager
A custom DatabaseManager object can be specified if there's need to user more than one database.
Default is null (the default Extension's Zone DBManager is used).