Package eu.webtoolkit.jwt.auth.jpa

Class AuthInfo

java.lang.Object

eu.webtoolkit.jwt.auth.jpa.AuthInfo

public class AuthInfo
extends Object

A default JPA implementation for authentication data This class implements the requirements for use as a data type in UserDatabase.

It contains collections to two other types:
• getAuthTokens() references a collection of authentication tokens (see AuthService.setAuthTokensEnabled(boolean enabled))
• getAuthIdentities() references a collection of identities, which represent all the authentication identities this user has (e.g. a login name, but also an OAuth identity, etc...)

To use these classes, you need to map them to a database using JPA.

The auth1 feature example contains an example mapping file (examples/feature/auth1/src/META-INF/orm.xml), and a Postgres schema file (examples/feature/auth1/src/META-INF/schema.postgres.sql).

To add extra fields to a user's profile you need to extend AbstractUser.

See Also:

• UserDatabase

Constructor Summary

Constructors

Constructor	Description
AuthInfo()

Method Summary

Modifier and Type	Method	Description
List<AuthIdentity>	getAuthIdentities()	Returns the authentication identities.
List<AuthToken>	getAuthTokens()	Returns the authentication tokens.
String	getEmail()	Returns the email address.
String	getEmailToken()	Returns the email token.
Date	getEmailTokenExpires()	Returns the email token expiration date.
EmailTokenRole	getEmailTokenRole()	Returns the email token role.
int	getFailedLoginAttempts()	Returns the number of failed login attempts.
long	getId()
Date	getLastLoginAttempt()	Returns the time of the last login attempt.
String	getPasswordHash()	Returns the password hash.
String	getPasswordMethod()	Returns the password method.
String	getPasswordSalt()	Returns the password salt.
AccountStatus	getStatus()	Returns the status.
String	getUnverifiedEmail()	Returns the unverified email address.
AbstractUser	getUser()	Returns a reference to the user.
int	getVersion()
void	setAuthIdentities(List<AuthIdentity> authIdentities)
void	setAuthTokens(List<AuthToken> authTokens)
void	setEmail(String email)	Sets the email address.
void	setEmailToken(String emailToken)
void	setEmailToken(String hash, Date expires, EmailTokenRole role)	Sets the email token.
void	setEmailTokenExpires(Date emailTokenExpires)
void	setEmailTokenRole(EmailTokenRole emailTokenRole)
void	setFailedLoginAttempts(int count)	Sets the number of failed login attempts.
void	setId(long id)
void	setLastLoginAttempt(Date dt)	Sets the time of the last login attempt.
void	setPassword(String hash, String hashFunction, String hashSalt)	Sets a password.
void	setPasswordHash(String passwordHash)
void	setPasswordMethod(String passwordMethod)
void	setPasswordSalt(String passwordSalt)
void	setStatus(AccountStatus status)	Sets the status.
void	setUnverifiedEmail(String email)	Sets the unverified email address.
void	setUser(AbstractUser user)	Sets the user.
void	setVersion(int version)

Methods inherited from class java.lang.Object

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

Constructor Details

AuthInfo

public AuthInfo()

Method Details

setUser

public void setUser(AbstractUser user)

Sets the user. This sets the user that owns this authentication information. AbstractUser is an empty class by default, you can extend it to add extra field (e.g.: First name, Last name, ...).

getUser

public AbstractUser getUser()

Returns a reference to the user.

See Also:

• setUser(AbstractUser user)

setPassword

public void setPassword(String hash,
 String hashFunction,
 String hashSalt)

Sets a password.

getPasswordHash

public String getPasswordHash()

Returns the password hash.

See Also:

• setPassword(String hash, String hashFunction, String hashSalt)

setPasswordHash

public void setPasswordHash(String passwordHash)

getPasswordMethod

public String getPasswordMethod()

Returns the password method.

See Also:

• setPassword(String hash, String hashFunction, String hashSalt)

setPasswordMethod

public void setPasswordMethod(String passwordMethod)

getPasswordSalt

public String getPasswordSalt()

Returns the password salt.

See Also:

• setPassword(String hash, String hashFunction, String hashSalt)

setPasswordSalt

public void setPasswordSalt(String passwordSalt)

setEmail

public void setEmail(String email)

Sets the email address.

getEmail

public String getEmail()

Returns the email address.

See Also:

• setEmail(String email)

setUnverifiedEmail

public void setUnverifiedEmail(String email)

Sets the unverified email address.

getUnverifiedEmail

public String getUnverifiedEmail()

Returns the unverified email address.

See Also:

• setUnverifiedEmail(String email)

setEmailToken

public void setEmailToken(String hash,
 Date expires,
 EmailTokenRole role)

Sets the email token.

getEmailToken

public String getEmailToken()

Returns the email token.

See Also:

• setEmailToken(String hash, Date expires, EmailTokenRole role)

setEmailToken

public void setEmailToken(String emailToken)

getEmailTokenExpires

public Date getEmailTokenExpires()

Returns the email token expiration date.

See Also:

• setEmailToken(String hash, Date expires, EmailTokenRole role)

setEmailTokenExpires

public void setEmailTokenExpires(Date emailTokenExpires)

getEmailTokenRole

public EmailTokenRole getEmailTokenRole()

Returns the email token role.

See Also:

• setEmailToken(String hash, Date expires, EmailTokenRole role)

setEmailTokenRole

public void setEmailTokenRole(EmailTokenRole emailTokenRole)

setStatus

public void setStatus(AccountStatus status)

Sets the status.

getStatus

public AccountStatus getStatus()

Returns the status.

See Also:

• setStatus(AccountStatus status)

setFailedLoginAttempts

public void setFailedLoginAttempts(int count)

Sets the number of failed login attempts.

getFailedLoginAttempts

public int getFailedLoginAttempts()

Returns the number of failed login attempts.

See Also:

• setFailedLoginAttempts(int count)

setLastLoginAttempt

public void setLastLoginAttempt(Date dt)

Sets the time of the last login attempt.

getLastLoginAttempt

public Date getLastLoginAttempt()

Returns the time of the last login attempt.

See Also:

• setLastLoginAttempt(Date dt)

getAuthTokens

public List<AuthToken> getAuthTokens()

Returns the authentication tokens.

setAuthTokens

public void setAuthTokens(List<AuthToken> authTokens)

getAuthIdentities

public List<AuthIdentity> getAuthIdentities()

Returns the authentication identities.

setAuthIdentities

public void setAuthIdentities(List<AuthIdentity> authIdentities)

getId

public long getId()

setId

public void setId(long id)

getVersion

public int getVersion()

setVersion

public void setVersion(int version)