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>>
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class AbstractLockableEntity
COL_LOCKINGVERSION, lockingVersionFields inherited from class AbstractEntity
COL_ID, idFields inherited from interface de.xima.cmn.dao.interfaces.IEntity
ATTR_IDFields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity
ATTR_LOCKINGVERSIONFields inherited from interface ITransferableEntity
IMPORT_ID, INVALID_IDFields inherited from interface IUUIDEntity
ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleancheckPassword(String pasword) getId()getUUID()Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.booleanisExpired(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!!!voidsetPassword(String password) voidsetPasswordHash(String passwordHash) voidsetPasswordSetInstant(Instant passwordSetInstant) voidsetUserProfile(UserProfile userProfile) voidSets the UUID (universal unique identifier) that uniquely identifies this type of entity.voidsetUUIDObject(UUID uuid) Methods inherited from class AbstractLockableEntity
entityHasChanged, getLockingVersion, setLockingVersion, toStringMethods inherited from class AbstractEntity
asIntValue, isPersisted, setIdMethods inherited from class de.xima.cmn.dao.model.AEntity
compareTo, equals, getDBTableName, hashCodeMethods inherited from interface Comparable
compareToMethods inherited from interface de.xima.cmn.dao.interfaces.IEntity
isPersisted
-
Field Details
-
COL_PASSWORD_HASH
- See Also:
-
COL_PASSWORD_SET_TIMESTAMP
- See Also:
-
COL_USER_PROFILE_ID
- See Also:
-
ATTR_USER_NAME
- See Also:
-
ATTR_PASSWORD_HASH
- See Also:
-
ATTR_PASSWORD_SET_INSTANT
- See Also:
-
ATTR_USER_PROFILE
- See Also:
-
-
Constructor Details
-
UserCredentials
public UserCredentials()
-
-
Method Details
-
getId
-
setId
Description copied from class:AbstractEntity!!!WARNING: Currently values biggerInteger.MAX_VALUEor lower thenInteger.MIN_VALUEwill be altered to null!!!- Specified by:
setIdin interfacede.xima.cmn.dao.interfaces.IEntity<Long>- Overrides:
setIdin classAbstractEntity- Parameters:
id-Longthe database-id to set
-
getUUID
Description copied from interface:IUUIDEntityGets 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 exampleclient scopesorproject scope.- Specified by:
getUUIDin interfaceIUUIDEntity- Returns:
- The UUID of the entity.
-
setUUID
Description copied from interface:IUUIDEntitySets 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 exampleclient scopesorproject scope.- Specified by:
setUUIDin interfaceIUUIDEntity- Parameters:
uuid- The UUID of the entity.
-
getUUIDObject
Description copied from interface:IUUIDEntityGets 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 exampleclient scopesorproject scope.- Specified by:
getUUIDObjectin interfaceIUUIDEntity- Returns:
- The UUID of the entity.
-
setUUIDObject
-
getIdentifier
- Specified by:
getIdentifierin interfaceIUserIdentity- Returns:
- a string that uniquely identifies a user within the
clientof this user identity.
-
setPassword
-
getPasswordHash
-
setPasswordHash
-
checkPassword
-
getPasswordSetInstant
-
setPasswordSetInstant
-
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:
trueif the credentials are expired given the time interval of how long the credentials are valid until they expire (in days) andfalseotherwise.
-
getUserProfile
- Specified by:
getUserProfilein interfaceIUserIdentity- Returns:
- the user profile this identity is connected to.
-
setUserProfile
-
getClientDescriptor
- Specified by:
getClientDescriptorin interfaceIUserIdentity- Returns:
- the client descriptor that is used for signing in.
-