Class User


  • public class User
    extends Object
    Provide a User value object class.
    Since:
    5.0.0
    • Constructor Detail

      • User

        public User()
      • User

        public User​(com.avoka.fc.core.entity.UserAccount userAccount)
        Create a User value object with the given user account entity.
        Parameters:
        userAccount - the user account entity (required)
      • User

        public User​(com.avoka.fc.core.entity.UserAccount userAccount,
                    Set<String> groupNames)
        Create a User value object with the given user account entity and group names.
        Parameters:
        userAccount - the user account entity (required)
        groupNames - the user group names (required)
      • User

        public User​(Map fields)
        Create a unit testing User value object with the given fields.
        Parameters:
        fields - the user entity fields (required)
        Since:
        5.1.4
    • Method Detail

      • toString

        public String toString()
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object.
      • getId

        public Long getId()
        The user id (PK).
      • getLoginName

        public String getLoginName()
        The user login name.
      • getAccountStatus

        public String getAccountStatus()
        The user account status [ Active | Inactive | Locked | Locked Temporarily | Pending | Rejected ].
      • getEmail

        public String getEmail()
        The user email address.
      • getFirstName

        public String getFirstName()
        The user first name (given name).
      • getLastName

        public String getLastName()
        The user last name (family name).
      • getMobile

        public String getMobile()
        The user mobile telephone number.
      • getUserKey

        public String getUserKey()
        The user GUID alternative key.
      • getUserType

        public String getUserType()
        The user type [ Local | LDAP | SSO ].
      • isHasGlobalAccess

        public boolean isHasGlobalAccess()
        The user has global client organization access.
      • getFailedLoginAttempts

        public int getFailedLoginAttempts()
        The number of failed login attempts.
      • getCreatedTime

        public Date getCreatedTime()
        The time the user was created.
      • getLastAccessedTime

        public Date getLastAccessedTime()
        The time the user last logged in.
      • getLockoutEndTime

        public Date getLockoutEndTime()
        The time a temporary lockout should end.
      • getProfileMap

        public Map<String,​String> getProfileMap()
        The user profile values map.
      • getGroupNames

        public Set<String> getGroupNames()
        The user group names.
      • getOrgNames

        public Set<String> getOrgNames()
        The user organization names.
      • getRoleNames

        public Set<String> getRoleNames()
        The user role names.
      • getSpaceNames

        public Set<String> getSpaceNames()
        The user form space names.
      • isChangePassword

        public boolean isChangePassword()
        The user is forced change password on next login.
        Since:
        19.11.3
      • isEmailVerificationRequired

        public boolean isEmailVerificationRequired()
        The user requires email verification.
        Since:
        19.11.3