Package de.xima.fc.entities

Class UserProfileMfa

java.lang.Object

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

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.UserProfileMfa

All Implemented Interfaces:

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

@Entity
public class UserProfileMfa
extends AbstractLockableEntity
implements IUUIDEntity

This entity represents the MFA configuration of a user profile.

Since:

8.0.0

Author:

XIMA Media GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_LAST_AUTHENTICATED_INSTANT	Deprecated.
static String	ATTR_REMOVE_EXPIRE_INSTANT
static String	ATTR_REMOVE_UUID
static String	ATTR_SECRET
static String	ATTR_TYPE
static String	ATTR_USER_PROFILE
static String	ATTR_VERIFICATION_EXPIRE_INSTANT
static String	ATTR_VERIFICATION_STATE
static String	ATTR_VERIFIED_INSTANT
static String	COL_LAST_AUTHENTICATED_TIMESTAMP	Deprecated.
static String	COL_REMOVE_EXPIRE_TIMESTAMP
static String	COL_REMOVE_UUID
static String	COL_SECRET
static String	COL_TYPE
static String	COL_USER_PROFILE
static String	COL_VERIFICATION_EXPIRE_TIMESTAMP
static String	COL_VERIFICATION_STATE
static String	COL_VERIFIED_TIMESTAMP
static String	VERIFICATION_STATE_VERIFIED

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
UserProfileMfa()

Method Summary

Modifier and Type	Method	Description
Long	getId()
Instant	getLastAuthenticatedInstant()	Deprecated. Use UserProfile.getMfaLastAuthenticatedInstant() instead.
Instant	getRemoveExpireInstant()
UUID	getRemoveUuid()
String	getSecret()
EMultiFactorAuthenticationType	getType()
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.
Instant	getVerificationExpireInstant()
String	getVerificationState()
Instant	getVerifiedInstant()
boolean	isRegistered()	Checks if the MFA configuration is registered and ready for use.
boolean	isRemovalRequestPending()
boolean	isVerified()
void	setId(Long id)	!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
void	setLastAuthenticatedInstant(Instant lastAuthenticatedInstant)	Deprecated. Use UserProfile.setMfaLastAuthenticatedInstant(Instant) instead.
void	setRemoveExpireInstant(Instant removeExpireInstant)
void	setRemoveUuid(UUID removeUuid)
void	setSecret(String secret)
void	setType(EMultiFactorAuthenticationType type)
void	setUnverified()
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)
void	setVerificationExpireInstant(Instant verificationExpireInstant)
void	setVerificationState(String verificationState)
void	setVerified()
void	setVerifiedInstant(Instant verifiedInstant)

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_USER_PROFILE

public static final String COL_USER_PROFILE

See Also:

Constant Field Values

COL_TYPE

public static final String COL_TYPE

See Also:

Constant Field Values

COL_SECRET

public static final String COL_SECRET

See Also:

Constant Field Values

COL_LAST_AUTHENTICATED_TIMESTAMP

@Deprecated
public static final String COL_LAST_AUTHENTICATED_TIMESTAMP

Deprecated.

See Also:

Constant Field Values

COL_VERIFICATION_STATE

public static final String COL_VERIFICATION_STATE

See Also:

Constant Field Values

COL_VERIFICATION_EXPIRE_TIMESTAMP

public static final String COL_VERIFICATION_EXPIRE_TIMESTAMP

See Also:

Constant Field Values

COL_VERIFIED_TIMESTAMP

public static final String COL_VERIFIED_TIMESTAMP

See Also:

Constant Field Values

COL_REMOVE_UUID

public static final String COL_REMOVE_UUID

See Also:

Constant Field Values

COL_REMOVE_EXPIRE_TIMESTAMP

public static final String COL_REMOVE_EXPIRE_TIMESTAMP

See Also:

Constant Field Values

ATTR_USER_PROFILE

public static final String ATTR_USER_PROFILE

See Also:

Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

Constant Field Values

ATTR_SECRET

public static final String ATTR_SECRET

See Also:

Constant Field Values

ATTR_LAST_AUTHENTICATED_INSTANT

@Deprecated
public static final String ATTR_LAST_AUTHENTICATED_INSTANT

Deprecated.

See Also:

Constant Field Values

ATTR_VERIFICATION_STATE

public static final String ATTR_VERIFICATION_STATE

See Also:

Constant Field Values

ATTR_VERIFICATION_EXPIRE_INSTANT

public static final String ATTR_VERIFICATION_EXPIRE_INSTANT

See Also:

Constant Field Values

ATTR_VERIFIED_INSTANT

public static final String ATTR_VERIFIED_INSTANT

See Also:

Constant Field Values

ATTR_REMOVE_UUID

public static final String ATTR_REMOVE_UUID

See Also:

Constant Field Values

ATTR_REMOVE_EXPIRE_INSTANT

public static final String ATTR_REMOVE_EXPIRE_INSTANT

See Also:

Constant Field Values

VERIFICATION_STATE_VERIFIED

public static final String VERIFICATION_STATE_VERIFIED

See Also:

Constant Field Values

Constructor Detail

UserProfileMfa

public UserProfileMfa()

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)

getUserProfile

public UserProfile getUserProfile()

setUserProfile

public void setUserProfile(UserProfile userProfile)

getType

public EMultiFactorAuthenticationType getType()

setType

public void setType(EMultiFactorAuthenticationType type)

getSecret

public String getSecret()

setSecret

public void setSecret(String secret)

getLastAuthenticatedInstant

@Deprecated
public Instant getLastAuthenticatedInstant()

Deprecated.

Use UserProfile.getMfaLastAuthenticatedInstant() instead.

See Also:

UserProfile.getMfaLastAuthenticatedInstant()

setLastAuthenticatedInstant

@Deprecated
public void setLastAuthenticatedInstant(Instant lastAuthenticatedInstant)

Deprecated.

Use UserProfile.setMfaLastAuthenticatedInstant(Instant) instead.

See Also:

UserProfile.setMfaLastAuthenticatedInstant(Instant)

getVerificationState

public String getVerificationState()

setVerificationState

public void setVerificationState(String verificationState)

getVerificationExpireInstant

public Instant getVerificationExpireInstant()

setVerificationExpireInstant

public void setVerificationExpireInstant(Instant verificationExpireInstant)

getVerifiedInstant

public Instant getVerifiedInstant()

setVerifiedInstant

public void setVerifiedInstant(Instant verifiedInstant)

setVerified

public void setVerified()

setUnverified

public void setUnverified()

isRegistered

public boolean isRegistered()

Checks if the MFA configuration is registered and ready for use. This method returns true if the MFA type is EMAIL or TOTP and the secret is set and verified.

Returns:

true if the MFA configuration is registered, false otherwise

isVerified

public boolean isVerified()

getRemoveUuid

public UUID getRemoveUuid()

setRemoveUuid

public void setRemoveUuid(UUID removeUuid)

getRemoveExpireInstant

public Instant getRemoveExpireInstant()

setRemoveExpireInstant

public void setRemoveExpireInstant(Instant removeExpireInstant)

isRemovalRequestPending

public boolean isRemovalRequestPending()