Package eu.webtoolkit.jwt.auth

Class FormBaseModel

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WFormModel

eu.webtoolkit.jwt.auth.FormBaseModel

Direct Known Subclasses:

AuthModel, RegistrationModel

public class FormBaseModel
extends WFormModel

A base model class for authentication-related forms.

This class manages the the auth services and the user database which an authentication model will use to implement a form..

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

WObject.FormData

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LoginNameField	Login name field.

Constructor Summary

Constructors

Constructor	Description
FormBaseModel(AuthService baseAuth, AbstractUserDatabase users)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addOAuth(OAuthService auth)	Adds an OAuth authentication service provider.
void	addOAuth(List<OAuthService> auth)	Adds a list of OAuth authentication service providers.
void	addPasswordAuth(AbstractPasswordService auth)	Adds a password authentication service.
AuthService	getBaseAuth()	Returns the authentication base service.
List<OAuthService>	getOAuth()	Returns the list of OAuth authentication service providers.
AbstractPasswordService	getPasswordAuth()	Returns the password authentication service.
AbstractUserDatabase	getUsers()	Returns the user database.
WString	label(String field)	Returns a field label.
final boolean	loginUser(Login login, User user)	Logs the user in.
boolean	loginUser(Login login, User user, LoginState state)	Logs the user in.
protected void	setValid(String field)
protected void	setValid(String field, CharSequence message)

Methods inherited from class eu.webtoolkit.jwt.WFormModel

addField, addField, getFields, getValidation, getValidator, getValue, isReadOnly, isValid, isValidated, isVisible, removeField, reset, setReadOnly, setValidated, setValidation, setValidator, setValue, setVisible, validate, validateField, valueText

Methods inherited from class eu.webtoolkit.jwt.WObject

getId, getObjectName, remove, resendFormData, setFormData, setObjectName, tr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LoginNameField

public static final String LoginNameField

Login name field.

See Also:

• Constant Field Values

Constructor Details

FormBaseModel

public FormBaseModel(AuthService baseAuth,
 AbstractUserDatabase users)

Constructor.

Method Details

getBaseAuth

public AuthService getBaseAuth()

Returns the authentication base service.

This returns the service passed through the constructor.

getUsers

public AbstractUserDatabase getUsers()

Returns the user database.

addPasswordAuth

public void addPasswordAuth(AbstractPasswordService auth)

Adds a password authentication service.

This enables password-based registration, including choosing a proper password.

Only one password authentication service can be configured.

See Also:

• addOAuth(OAuthService auth)

getPasswordAuth

public AbstractPasswordService getPasswordAuth()

Returns the password authentication service.

See Also:

• addPasswordAuth(AbstractPasswordService auth)

addOAuth

public void addOAuth(OAuthService auth)

Adds an OAuth authentication service provider.

This enables OAuth-based registration. More than one OAuth authentication service can be configured: one for each supported third-party OAuth identity provider.

See Also:

• addPasswordAuth(AbstractPasswordService auth)

addOAuth

public void addOAuth(List<OAuthService> auth)

Adds a list of OAuth authentication service providers.

See Also:

• addOAuth(OAuthService auth)

getOAuth

public List<OAuthService> getOAuth()

Returns the list of OAuth authentication service providers.

See Also:

• addOAuth(OAuthService auth)

label

public WString label(String field)

Description copied from class: WFormModel

Returns a field label.

The default implementation returns the WString::tr(field)

Overrides:

label in class WFormModel

loginUser

public boolean loginUser(Login login,
 User user,
 LoginState state)

Logs the user in.

Logs in the user, after checking whether the user can actually be logged in. A valid user may be refused to login if its account is disabled (see User.getStatus()) or if it's email address is unconfirmed and email confirmation is required.

Returns whether the user could be logged in.

loginUser

public final boolean loginUser(Login login,
 User user)

Logs the user in.

Returns loginUser(login, user, LoginState.Strong)

setValid

protected void setValid(String field)

setValid

protected void setValid(String field,
 CharSequence message)