Package eu.webtoolkit.jwt.auth.jpa

Class UserDatabase

java.lang.Object

eu.webtoolkit.jwt.auth.AbstractUserDatabase

eu.webtoolkit.jwt.auth.jpa.UserDatabase

public class UserDatabase
extends AbstractUserDatabase

A JPA implementation for user authentication data.

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.auth.AbstractUserDatabase

AbstractUserDatabase.Transaction

Constructor Summary

Constructors

Constructor	Description
UserDatabase(javax.persistence.EntityManager entityManager)	Constructor
UserDatabase(javax.persistence.EntityManager entityManager, AuthService authService)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addAuthToken(User user, Token token)	Adds an authentication token to a user.
void	addIdentity(User user, String provider, String identity)	Adds an identify for the user.
User	find(AuthInfo user)	Returns the User corresponding to an AuthInfo object.
AuthInfo	find(User user)	Returns the AuthInfo object corresponding to an User.
User	findWithAuthToken(String hash)	Finds a user with an authentication token.
User	findWithEmail(String address)	Finds a user with a given email address.
User	findWithEmailToken(String token)	Finds a user with a given email token.
User	findWithId(String id)	Finds a user with a given id.
User	findWithIdentity(String provider, String identity)	Finds a user with a given identity.
String	getEmail(User user)	Returns a user's email address.
Token	getEmailToken(User user)	Returns an email token.
EmailTokenRole	getEmailTokenRole(User user)	Returns the role of the current email token.
int	getFailedLoginAttempts(User user)	Returns the number of consecutive authentication failures.
String	getIdentity(User user, String provider)	Returns a user identity.
WDate	getLastLoginAttempt(User user)	Returns the time of the last login.
PasswordHash	getPassword(User user)	Returns a user password.
AccountStatus	getStatus(User user)	Returns the status for a user.
String	getUnverifiedEmail(User user)	Returns a user's unverified email address.
User	registerNew()	Registers a new user.
void	removeAuthToken(User user, String hash)	Deletes an authentication token.
void	removeIdentity(User user, String provider)	Removes a user identity.
boolean	setEmail(User user, String address)	Sets a user's email address.
void	setEmailToken(User user, Token token, EmailTokenRole role)	Sets a new email token for a user.
void	setFailedLoginAttempts(User user, int count)	Sets the number of consecutive authentication failures.
void	setLastLoginAttempt(User user, WDate d)	Sets the time of the last login attempt.
void	setPassword(User user, PasswordHash password)	Sets a new user password.
void	setUnverifiedEmail(User user, String address)	Sets a user's unverified email address.
AbstractUserDatabase.Transaction	startTransaction()	Creates a new database transaction.

Methods inherited from class eu.webtoolkit.jwt.auth.AbstractUserDatabase

deleteUser, idpClientAdd, idpClientAuthMethod, idpClientConfidential, idpClientFindWithId, idpClientId, idpClientRedirectUris, idpClientSecret, idpJsonClaim, idpTokenAdd, idpTokenExpirationTime, idpTokenFindWithValue, idpTokenOAuthClient, idpTokenPurpose, idpTokenRedirectUri, idpTokenRemove, idpTokenScope, idpTokenUser, idpTokenValue, idpVerifySecret, setIdentity, setStatus, updateAuthToken

Methods inherited from class java.lang.Object

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

Constructor Details

UserDatabase

public UserDatabase(javax.persistence.EntityManager entityManager)

Constructor

UserDatabase

public UserDatabase(javax.persistence.EntityManager entityManager,
 AuthService authService)

Constructor

Method Details

startTransaction

public AbstractUserDatabase.Transaction startTransaction()

Description copied from class: AbstractUserDatabase

Creates a new database transaction.

If the underlying database does not support transactions, you can return null.

Ownership of the transaction is transferred, and the transaction must be deleted after it has been committed or rolled back.

The default implementation returns null (no transaction support).

Overrides:

startTransaction in class AbstractUserDatabase

find

public AuthInfo find(User user)

Returns the AuthInfo object corresponding to an User.

find

public User find(AuthInfo user)

Returns the User corresponding to an AuthInfo object.

findWithId

public User findWithId(String id)

Description copied from class: AbstractUserDatabase

Finds a user with a given id.

The id uniquely identifies a user.

This should find the user with the given id, or return an invalid user if no user with that id exists.

Specified by:

findWithId in class AbstractUserDatabase

findWithIdentity

public User findWithIdentity(String provider,
 String identity)

Description copied from class: AbstractUserDatabase

Finds a user with a given identity.

The identity uniquely identifies the user by the provider.

This should find the user with the given identity, or return an invalid user if no user with that identity exists.

Specified by:

findWithIdentity in class AbstractUserDatabase

getIdentity

public String getIdentity(User user,
 String provider)

Description copied from class: AbstractUserDatabase

Returns a user identity.

Returns a user identity for the given provider, or an empty string if the user has no identitfy set for this provider.

Specified by:

getIdentity in class AbstractUserDatabase

See Also:

• AbstractUserDatabase.addIdentity(User user, String provider, String id)

removeIdentity

public void removeIdentity(User user,
 String provider)

Description copied from class: AbstractUserDatabase

Removes a user identity.

This removes all identities of a provider from the user.

Specified by:

removeIdentity in class AbstractUserDatabase

See Also:

• AbstractUserDatabase.addIdentity(User user, String provider, String id)

registerNew

public User registerNew()

Description copied from class: AbstractUserDatabase

Registers a new user.

This adds a new user.

This method is only used by view classes involved with registration (RegistrationWidget).

Overrides:

registerNew in class AbstractUserDatabase

getStatus

public AccountStatus getStatus(User user)

Description copied from class: AbstractUserDatabase

Returns the status for a user.

If there is support for suspending accounts, then this method may be implemented to return whether a user account is disabled.

The default implementation always returns AccountStatus.Normal.

Overrides:

getStatus in class AbstractUserDatabase

setPassword

public void setPassword(User user,
 PasswordHash password)

Description copied from class: AbstractUserDatabase

Sets a new user password.

This updates the password for a user.

This is used only by PasswordService.

Overrides:

setPassword in class AbstractUserDatabase

getPassword

public PasswordHash getPassword(User user)

Description copied from class: AbstractUserDatabase

Returns a user password.

This returns the stored password for a user, or a default constructed password hash if the user does not yet have password credentials.

This is used only by PasswordService.

Overrides:

getPassword in class AbstractUserDatabase

addIdentity

public void addIdentity(User user,
 String provider,
 String identity)

Description copied from class: AbstractUserDatabase

Adds an identify for the user.

This adds an identity to the user.

You are free to support only one identity per user, e.g. if you only use password-based authentication. But you may also want to support more than one if you allow the user to login using multiple methods (e.g. name/password, OAuth from one or more providers, LDAP, ...).

Specified by:

addIdentity in class AbstractUserDatabase

setEmail

public boolean setEmail(User user,
 String address)

Description copied from class: AbstractUserDatabase

Sets a user's email address.

This is used only when email verification is enabled, or as a result of a 3rd party Identity Provider based registration process, if the provider also provides email address information with the identiy.

Returns whether the user's email address could be set. This may fail when there is already a user registered that email address.

Overrides:

setEmail in class AbstractUserDatabase

See Also:

• AbstractUserDatabase.findWithEmail(String address)

getEmail

public String getEmail(User user)

Description copied from class: AbstractUserDatabase

Returns a user's email address.

This may be an unverified or verified email address, depending on whether email address verification is enabled in the model classes.

This is an optional method, and currently not used by any of the included models or views.

Overrides:

getEmail in class AbstractUserDatabase

setUnverifiedEmail

public void setUnverifiedEmail(User user,
 String address)

Description copied from class: AbstractUserDatabase

Sets a user's unverified email address.

This is only used when email verification is enabled. It holds the currently unverified email address, while a mail is being sent for the user to confirm this email address.

Overrides:

setUnverifiedEmail in class AbstractUserDatabase

getUnverifiedEmail

public String getUnverifiedEmail(User user)

Description copied from class: AbstractUserDatabase

Returns a user's unverified email address.

This is an optional method, and currently not used by any of the included models or views.

Overrides:

getUnverifiedEmail in class AbstractUserDatabase

findWithEmail

public User findWithEmail(String address)

Description copied from class: AbstractUserDatabase

Finds a user with a given email address.

This is used to verify that a email addresses are unique, and to implement lost password functionality.

Overrides:

findWithEmail in class AbstractUserDatabase

setEmailToken

public void setEmailToken(User user,
 Token token,
 EmailTokenRole role)

Description copied from class: AbstractUserDatabase

Sets a new email token for a user.

This is only used when email verification is enabled or for lost password functionality.

Overrides:

setEmailToken in class AbstractUserDatabase

getEmailToken

public Token getEmailToken(User user)

Description copied from class: AbstractUserDatabase

Returns an email token.

This is only used when email verification is enabled and for lost password functionality. It should return the email token previously set with setEmailToken()

Overrides:

getEmailToken in class AbstractUserDatabase

getEmailTokenRole

public EmailTokenRole getEmailTokenRole(User user)

Description copied from class: AbstractUserDatabase

Returns the role of the current email token.

This is only used when email verification is enabled or for lost password functionality. It should return the role previously set with setEailToken().

Overrides:

getEmailTokenRole in class AbstractUserDatabase

findWithEmailToken

public User findWithEmailToken(String token)

Description copied from class: AbstractUserDatabase

Finds a user with a given email token.

This is only used when email verification is enabled or for lost password functionality.

Overrides:

findWithEmailToken in class AbstractUserDatabase

addAuthToken

public void addAuthToken(User user,
 Token token)

Description copied from class: AbstractUserDatabase

Adds an authentication token to a user.

Unless you want a user to only have remember-me support from a single computer at a time, you should support multiple authentication tokens per user.

Overrides:

addAuthToken in class AbstractUserDatabase

removeAuthToken

public void removeAuthToken(User user,
 String hash)

Description copied from class: AbstractUserDatabase

Deletes an authentication token.

Deletes an authentication token previously added with addAuthToken()

Overrides:

removeAuthToken in class AbstractUserDatabase

findWithAuthToken

public User findWithAuthToken(String hash)

Description copied from class: AbstractUserDatabase

Finds a user with an authentication token.

Returns a user with an authentication token.

This should find the user associated with a particular token hash, or return an invalid user if no user with that token hash exists.

Overrides:

findWithAuthToken in class AbstractUserDatabase

setFailedLoginAttempts

public void setFailedLoginAttempts(User user,
 int count)

Description copied from class: AbstractUserDatabase

Sets the number of consecutive authentication failures.

This sets the number of consecutive authentication failures since the last valid login.

This is used by the throttling logic to determine how much time a user needs to wait before he can do a new login attempt.

Overrides:

setFailedLoginAttempts in class AbstractUserDatabase

getFailedLoginAttempts

public int getFailedLoginAttempts(User user)

Description copied from class: AbstractUserDatabase

Returns the number of consecutive authentication failures.

setFailedLoginAttempts()

Overrides:

getFailedLoginAttempts in class AbstractUserDatabase

setLastLoginAttempt

public void setLastLoginAttempt(User user,
 WDate d)

Description copied from class: AbstractUserDatabase

Sets the time of the last login attempt.

This sets the time at which the user attempted to login.

Overrides:

setLastLoginAttempt in class AbstractUserDatabase

getLastLoginAttempt

public WDate getLastLoginAttempt(User user)

Description copied from class: AbstractUserDatabase

Returns the time of the last login.

Overrides:

getLastLoginAttempt in class AbstractUserDatabase

See Also:

• AbstractUserDatabase.setLastLoginAttempt(User user, WDate t)