Package de.xima.fc.entities

Class UserCredentials

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.UserCredentials

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUserIdentity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class UserCredentials
extends AbstractLockableEntity
implements IUserIdentity

User credentials are the entries of the default formcycle authenticator. They store information about credentials that users may use to sign in using the formcycle authenticator.

Since:

8.0.0

Author:

XIMA Media GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_PASSWORD_HASH
static String	ATTR_PASSWORD_SET_INSTANT
static String	ATTR_USER_NAME
static String	ATTR_USER_PROFILE
static String	COL_PASSWORD_HASH
static String	COL_PASSWORD_SET_TIMESTAMP
static String	COL_USER_PROFILE_ID

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
UserCredentials()

Method Summary

Modifier and Type	Method	Description
boolean	checkPassword(String pasword)
IClientDescriptor	getClientDescriptor()
Long	getId()
String	getIdentifier()
String	getPasswordHash()
Instant	getPasswordSetInstant()
UserProfile	getUserProfile()
String	getUUID()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
UUID	getUUIDObject()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
boolean	isExpired(int expireIntervalDays)	Return whether or not the credentials are expired given the time interval of how long the credentials are valid until they expire (in days).
void	setId(Long id)	!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
void	setPassword(String password)
void	setPasswordHash(String passwordHash)
void	setPasswordSetInstant(Instant passwordSetInstant)
void	setUserProfile(UserProfile userProfile)
void	setUUID(String uuid)	Sets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setUUIDObject(UUID uuid)

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted

Field Detail

COL_PASSWORD_HASH

public static final String COL_PASSWORD_HASH

See Also:

Constant Field Values

COL_PASSWORD_SET_TIMESTAMP

public static final String COL_PASSWORD_SET_TIMESTAMP

See Also:

Constant Field Values

COL_USER_PROFILE_ID

public static final String COL_USER_PROFILE_ID

See Also:

Constant Field Values

ATTR_USER_NAME

public static final String ATTR_USER_NAME

See Also:

Constant Field Values

ATTR_PASSWORD_HASH

public static final String ATTR_PASSWORD_HASH

See Also:

Constant Field Values

ATTR_PASSWORD_SET_INSTANT

public static final String ATTR_PASSWORD_SET_INSTANT

See Also:

Constant Field Values

ATTR_USER_PROFILE

public static final String ATTR_USER_PROFILE

See Also:

Constant Field Values

Constructor Detail

UserCredentials

public UserCredentials()

Method Detail

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

setId

public void setId(Long id)

Description copied from class: AbstractEntity

!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!

Specified by:

setId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

Overrides:

setId in class AbstractEntity

Parameters:

id - Long the database-id to set

getUUID

public String getUUID()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUID in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUID

public void setUUID(String uuid)

Description copied from interface: IUUIDEntity

Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

setUUID in interface IUUIDEntity

Parameters:

uuid - The UUID of the entity.

getUUIDObject

public UUID getUUIDObject()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUIDObject in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUIDObject

public void setUUIDObject(UUID uuid)

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface IUserIdentity

Returns:

a string that uniquely identifies a user within the client of this user identity.

setPassword

public void setPassword(String password)

getPasswordHash

public String getPasswordHash()

setPasswordHash

public void setPasswordHash(String passwordHash)

checkPassword

public boolean checkPassword(String pasword)

getPasswordSetInstant

public Instant getPasswordSetInstant()

setPasswordSetInstant

public void setPasswordSetInstant(Instant passwordSetInstant)

isExpired

public boolean isExpired(int expireIntervalDays)

Return whether or not the credentials are expired given the time interval of how long the credentials are valid until they expire (in days).

Parameters:

expireIntervalDays - time interval of how long the credentials are valid until they expire (in days).

Returns:

true if the credentials are expired given the time interval of how long the credentials are valid until they expire (in days) and false otherwise.

getUserProfile

public UserProfile getUserProfile()

Specified by:

getUserProfile in interface IUserIdentity

Returns:

the user profile this identity is connected to.

setUserProfile

public void setUserProfile(UserProfile userProfile)

getClientDescriptor

public IClientDescriptor getClientDescriptor()

Specified by:

getClientDescriptor in interface IUserIdentity

Returns:

the client descriptor that is used for signing in.