Class User
public class User
extends java.lang.Object
Provide a User value object class.
- Since:
- 5.0.0
Field Summary
FieldsModifier and Type | Field | Description |
---|---|---|
java.lang.String |
accountStatus |
The user account status [ Active | Inactive | Locked | Locked Temporarily | Pending | Rejected ]. |
java.util.Date |
createdTime |
The time the user was created. |
java.lang.String |
email |
The user email address. |
int |
failedLoginAttempts |
The number of failed login attempts. |
java.lang.String |
firstName |
The user first name (given name). |
java.util.Set<java.lang.String> |
groupNames |
The user group names. |
boolean |
hasGlobalAccess |
The user has global client organization access. |
java.lang.Long |
id |
The user id (PK). |
java.util.Date |
lastAccessedTime |
The time the user last logged in. |
java.lang.String |
lastName |
The user last name (family name). |
java.util.Date |
lockoutEndTime |
The time a temporary lockout should end. |
java.lang.String |
loginName |
The user login name. |
java.lang.String |
mobile |
The user mobile telephone number. |
java.util.Set<java.lang.String> |
orgNames |
The user organization names. |
java.util.Map<java.lang.String,java.lang.String>
|
profileMap |
The user profile values map. |
java.util.Set<java.lang.String> |
roleNames |
The user role names. |
java.util.Set<java.lang.String> |
spaceNames |
The user form space names. |
static java.lang.String |
STATUS_ACTIVE |
The "Active" user status. |
static java.lang.String |
STATUS_INACTIVE |
The "Inactive" user status. |
static java.lang.String |
STATUS_LOCKED |
The "Locked" user status. |
static java.lang.String |
STATUS_LOCKED_TEMPORARILY |
The "Locked Temporarily" user status. |
static java.lang.String |
STATUS_PENDING |
The "Pending" user status. |
static java.lang.String |
STATUS_REJECTED |
The "Rejected" user status. |
static java.lang.String |
TYPE_LDAP |
The "LDAP" user type. |
static java.lang.String |
TYPE_LOCAL |
The "Local" user type. |
static java.lang.String |
TYPE_SSO |
The "SSO" user type. |
java.lang.String |
userKey |
The user GUID alternative key. |
java.lang.String |
userType |
The user type [ Local | LDAP | SSO ]. |
Constructor Summary
ConstructorsConstructor | Description |
---|---|
User(com.avoka.fc.core.entity.UserAccount userAccount)
|
Create a User value object with the given user account entity. |
|
Create a User value object with the given user account entity and group names. |
User(java.util.Map fields) |
Create a unit testing User value object with the given fields. |
Method Summary
All Methods Instance Methods Concrete MethodsModifier and Type | Method | Description |
---|---|---|
java.lang.String |
toString() |
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait,
wait
Field Detail
STATUS_ACTIVE
public static final java.lang.String STATUS_ACTIVE
The "Active" user status.
- See Also:
- Constant Field Values
STATUS_INACTIVE
public static final java.lang.String STATUS_INACTIVE
The "Inactive" user status.
- See Also:
- Constant Field Values
STATUS_LOCKED
public static final java.lang.String STATUS_LOCKED
The "Locked" user status.
- See Also:
- Constant Field Values
STATUS_LOCKED_TEMPORARILY
public static final java.lang.String STATUS_LOCKED_TEMPORARILY
The "Locked Temporarily" user status.
- See Also:
- Constant Field Values
STATUS_PENDING
public static final java.lang.String STATUS_PENDING
The "Pending" user status.
- See Also:
- Constant Field Values
STATUS_REJECTED
public static final java.lang.String STATUS_REJECTED
The "Rejected" user status.
- See Also:
- Constant Field Values
TYPE_LOCAL
public static final java.lang.String TYPE_LOCAL
The "Local" user type.
- See Also:
- Constant Field Values
TYPE_LDAP
public static final java.lang.String TYPE_LDAP
The "LDAP" user type.
- See Also:
- Constant Field Values
TYPE_SSO
public static final java.lang.String TYPE_SSO
The "SSO" user type.
- See Also:
- Constant Field Values
id
public final java.lang.Long id
The user id (PK).
loginName
public final java.lang.String loginName
The user login name.
accountStatus
public final java.lang.String accountStatus
The user account status [ Active | Inactive | Locked | Locked Temporarily |
Pending | Rejected ].
public final java.lang.String email
The user email address.
firstName
public final java.lang.String firstName
The user first name (given name).
lastName
public final java.lang.String lastName
The user last name (family name).
mobile
public final java.lang.String mobile
The user mobile telephone number.
userKey
public final java.lang.String userKey
The user GUID alternative key.
userType
public final java.lang.String userType
The user type [ Local | LDAP | SSO ].
hasGlobalAccess
public final boolean hasGlobalAccess
The user has global client organization access.
failedLoginAttempts
public final int failedLoginAttempts
The number of failed login attempts.
createdTime
public final java.util.Date createdTime
The time the user was created.
lastAccessedTime
public final java.util.Date lastAccessedTime
The time the user last logged in.
lockoutEndTime
public final java.util.Date lockoutEndTime
The time a temporary lockout should end.
profileMap
public final java.util.Map<java.lang.String,java.lang.String>
profileMap
The user profile values map.
groupNames
public final java.util.Set<java.lang.String> groupNames
The user group names.
orgNames
public final java.util.Set<java.lang.String> orgNames
The user organization names.
roleNames
public final java.util.Set<java.lang.String> roleNames
The user role names.
spaceNames
public final java.util.Set<java.lang.String> spaceNames
The user form space names.
Constructor Detail
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,
java.util.Set<java.lang.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(java.util.Map fields)
Create a unit testing User value object with the given fields.
- Parameters:
fields
- the submission entity fields (required)- Since:
- 5.1.4
Method Detail
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of the object.