Package net.pricefx.domain
Class User
Object
DomainObject
PersistedObject
PartitionedObject
User
- All Implemented Interfaces:
Persistable,RenameSoftDeletedInNameConflict
@Entity
public class User
extends PartitionedObject
implements RenameSoftDeletedInNameConflict
-
Nested Class Summary
Nested classes/interfaces inherited from class PersistedObject
PersistedObject.BatchDelete, PersistedObject.BulkloadFilterCheckCallback, PersistedObject.ComputedFieldMapping, PersistedObject.ComputedFields, PersistedObject.ImportManagerEnabled, PersistedObject.PersistedObjectMeta, PersistedObject.VirtualField, PersistedObject.VirtualFieldMapping, PersistedObject.VirtualFields, PersistedObject.VirtualSearchFields, PersistedObject.VirtualSortFields -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected static final StringFields inherited from class PartitionedObject
FIELD_PARTITION, FIELD_PARTITIONID, PARTITION_FILTER_NAME, PARTITION_FILTER_PARAMFields inherited from class PersistedObject
FIELD_CREATEDATE, FIELD_CREATEDBY, FIELD_DELETEDATE, FIELD_DELETEDBY, FIELD_ID, FIELD_ISDELETED, FIELD_LASTUPDATEBY, FIELD_LASTUPDATEDATE, FIELD_VERSIONFields inherited from class DomainObject
DEFAULT_MAX_PACKET_SIZE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddRelevantFilter(Search search) voidauditOperation(AuditOperation operation, User byUser, CommandContext context, PersistedObjectService objService, String details) Override this method to log certain object operationsbooleancanEdit(User user, ValidationVisitor validationVisitor, PersistedObjectService objService, Map<String, Object> fieldsToEdit) Override this method to do edit-ability checks based on request details and object data (or related object data) and new data from request In case of a false return value a validation error should be added.booleancheckPassword(String clearTextPassword) This method checks if a passed clearText password matches the stored password hash@NotNull Stringstatic voidcreateOrUpdateSupportUser(PersistedObjectService objService) static voidcreateRootUser(PersistedObjectService objService) static voidcreateSupportUser(PersistedObjectService objService) voidGets all groups of a user including those assigned by a business roleTHIS SHOULD NOT BE USED IN CODE!.Set<Role> Gets all roles of a user including those assigned by a business roleList<BusinessRole> getEmail()Set<Permission> THIS SHOULD NOT BE USED IN CODE!.List<Role> getRoles()String[]The fields that represent the business key of the object, seePersistedObject.getBusinessKey().booleanhasModuleAccess(ApplicationModule module) booleanOverride this to enable audit calls on this objectbooleanbooleanbooleanvoidonSavedOrUpdated(PersistedObjectService objService) voidonSaveOrUpdate(PersistedObjectService objService) Default does nothing.voidrenameSoftDeleted(PersistedObjectService objService) voidsetActivated(Boolean activated) voidsetAdditionalInfo1(BigDecimal additionalInfo1) voidsetAdditionalInfo2(BigDecimal additionalInfo2) voidsetAdditionalInfo3(String additionalInfo3) voidsetAdditionalInfo4(String additionalInfo4) voidsetBusinessRoles(List<BusinessRole> businessroles) voidsetCustomerFilterCriteria(String customerFilterCriteria) voidsetDefaultUserGroupEdit(String defaultUserGroup) voidsetDefaultUserGroupViewDetails(String defaultUserViewDetails) voidvoidsetEmailLocale(String emailLocale) voidsetExtendedData(Map<String, Object> extendedData) voidsetFirstName(String firstName) voidvoidsetLastLogin(LocalDateTime lastLogin) voidsetLastName(String lastName) voidsetLastTermsOfUseAgreedDate(LocalDateTime lastTermsOfUseAgreedDate) voidsetLastTermsOfUseVersionAgreed(String lastTermsOfUseVersionAgreed) voidsetLoginName(String name) voidsetNoSession(Boolean noSession) voidsetPassword(String clearTextPassword) This convenience method accepts a clear-text password The password will be hashed using the password servicevoidsetPasswordExpiry(LocalDateTime passwordExpiry) voidsetPasswordHash(String passwordHash) voidsetPasswordSalt(String passwordSalt) voidsetPlatformManaged(Boolean platformManaged) voidsetProductFilterCriteria(String productFilterExpression) voidsetReceiveAdminEmail(Boolean receiveAdminEmail) voidsetRequireTFA(Boolean requireTFA) voidvoidsetSellerFilterCriteria(String sellerFilterCriteria) voidsetSsoOnly(Boolean ssoOnly) voidsetUniqueLoginName(String name) voidsetWizardDashboardName(String wizardDashboardName) voidsetWorkflowEmailingActivated(Boolean workflowEmailingActivated) static voidupdateSupportUser(PersistedObjectService objService, User supportUser) booleanvalidate(ValidationVisitor validationVisitor, PersistedObjectService objService) Override to implement per-object validation rulesMethods inherited from class PartitionedObject
addUniqueConstraint, getLoginNameByUserId, getPartition, setPartition, toStringMethods inherited from class PersistedObject
bumpVersion, canAdd, canDelete, canEdit, canRead, createDate, doHardDelete, entityIsSafeInserted, entityIsSafeInserted, getBulkloadMap, getBusinessKey, getCreateDate, getCreatedBy, getDbColumnNameForField, getDeleteDate, getDeletedBy, getId, getLastUpdateBy, getLastUpdateDate, getSensitiveFields, getTypeCode, getTypedId, getVersion, getVirtualSearchFieldMappings, getVirtualSortFieldMappings, isDeleted, isVirtualSearchField, notifyOnBusinessKeyChange, onBusinessKeyChange, onDelete, onRefreshed, setCreateDate, setCreateDateShouldBeIgnored, setCreateDateTime, setCreatedBy, setDeleted, setDeleteDate, setDeletedBy, setId, setLastUpdateBy, setLastUpdateDate, setLastUpdateDateTime, setTypedId, setVersion, userGroupEditBulkloadFilter, userGroupEditBulkloadFilterMethods inherited from class DomainObject
deepCopy, getNewMidnightDate, getNewMidnightDateTime, isMidnight, isMidnight, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonDeserialize, jsonSerialize, jsonSerialize, jsonSerialize, jsonSerialize, jsonSerialize, jsonSerialize, jsonSerializedSizeOK, jsonSerializeToBytes, jsonSerializeToBytes, setToDayEnd, setToDayEnd, setToMidnight, setToMidnight, setToMidnightAsLocalDateTime, toPropertyMap, truncatedToString
-
Field Details
-
CACHE_REGION_NAME
- See Also:
-
FIELD_ACTIVATED
- See Also:
-
FIELD_EMAIL
- See Also:
-
FIELD_LOGINNAME
- See Also:
-
FIELD_PASSWORD_HASH
- See Also:
-
FIELD_PASSWORD_SALT
- See Also:
-
SYSTEM_USER_NAME
- See Also:
-
SYSTEM_SUPPORT_USER_NAME
- See Also:
-
NEW_PASSWORD_HASH
-
NEW_PASSWORD_NOSESSION_HASH
-
UNKNOWN_HASH
- See Also:
-
-
Constructor Details
-
User
public User() -
User
public User(Partition partition) -
User
-
-
Method Details
-
getSignificantFields
Description copied from class:net.pricefx.domain.PersistedObjectThe fields that represent the business key of the object, seePersistedObject.getBusinessKey(). For some objects, the business key is dynamically generated instead, seeDynamicBusinessKeyObject.- Overrides:
getSignificantFieldsin classPersistedObject
-
getFirstName
-
setFirstName
-
getLastName
-
setLastName
-
computeFullName
-
getEmail
-
setEmail
-
getDefaultUserGroupEdit
-
setDefaultUserGroupEdit
-
getDefaultUserGroupViewDetails
-
setDefaultUserGroupViewDetails
-
getNoSession
-
getRequireTFA
-
setRequireTFA
-
getSsoOnly
-
setSsoOnly
-
getReceiveAdminEmail
-
setReceiveAdminEmail
-
setNoSession
-
getPlatformManaged
-
setPlatformManaged
-
passwordExpiry
-
getPasswordExpiry
-
setPasswordExpiry
-
getPasswordHash
-
setPasswordHash
-
getPasswordSalt
-
setPasswordSalt
-
isSystemUser
public boolean isSystemUser() -
getExtendedData
-
setExtendedData
-
getWizardDashboardName
-
setWizardDashboardName
-
setPassword
This convenience method accepts a clear-text password The password will be hashed using the password service- Parameters:
clearTextPassword-
-
checkPassword
This method checks if a passed clearText password matches the stored password hash- Parameters:
clearTextPassword-- Returns:
- true is passwords match
-
getHashMethod
-
getRoles
-
getRoleNames
THIS SHOULD NOT BE USED IN CODE!. Only here for jackson Use : AuthUtil.userHasRole(Role.WF_ADMIN, currentUser)- Returns:
-
getAllRoleNames
THIS SHOULD NOT BE USED IN CODE!. Only here for jackson Use : AuthUtil.userHasRole(Role.WF_ADMIN, currentUser)- Returns:
-
getAllRoles
Gets all roles of a user including those assigned by a business role- Returns:
- All roles or empty list. Never null.
-
setRoles
-
getGroups
-
getAllGroups
Gets all groups of a user including those assigned by a business role- Returns:
- All groups or empty list. Never null.
-
setGroups
-
getBusinessRoles
-
setBusinessRoles
-
isActivated
-
setActivated
-
isWorkflowEmailingActivated
-
setWorkflowEmailingActivated
-
getLastLogin
-
lastUpdateDate
- Overrides:
lastUpdateDatein classPersistedObject
-
setLastLogin
-
isFirstLogin
public boolean isFirstLogin() -
getFQLoginName
-
getLoginName
-
setLoginName
-
setUniqueLoginName
-
getAdditionalInfo1
-
setAdditionalInfo1
-
getAdditionalInfo2
-
setAdditionalInfo2
-
getAdditionalInfo3
-
setAdditionalInfo3
-
getAdditionalInfo4
-
setAdditionalInfo4
-
getEmailLocale
-
setEmailLocale
-
getProductFilterCriteria
-
setProductFilterCriteria
-
getCustomerFilterCriteria
-
setCustomerFilterCriteria
-
getSellerFilterCriteria
-
setSellerFilterCriteria
-
getLastTermsOfUseVersionAgreed
-
setLastTermsOfUseVersionAgreed
-
getLastTermsOfUseAgreedDate
-
setLastTermsOfUseAgreedDate
-
addRelevantFilter
public void addRelevantFilter(Search search) -
getSkuFilter
-
getCustomerFilter
-
getSellerFilter
-
hasModuleAccess
public boolean hasModuleAccess(ApplicationModule module) -
auditOperation
public void auditOperation(AuditOperation operation, User byUser, CommandContext context, PersistedObjectService objService, String details) Description copied from class:net.pricefx.domain.PersistedObjectOverride this method to log certain object operations- Overrides:
auditOperationin classPersistedObject- Parameters:
operation- a descriptive string that classifies the operation typebyUser- the user that requested the operation
-
isAudited
public boolean isAudited()Description copied from class:net.pricefx.domain.PersistedObjectOverride this to enable audit calls on this object- Overrides:
isAuditedin classPersistedObject
-
isInGroup
-
renameSoftDeleted
public void renameSoftDeleted(PersistedObjectService objService) - Specified by:
renameSoftDeletedin interfaceRenameSoftDeletedInNameConflict
-
validate
public boolean validate(ValidationVisitor validationVisitor, PersistedObjectService objService) Description copied from class:net.pricefx.domain.PersistedObjectOverride to implement per-object validation rules- Specified by:
validatein interfacePersistable- Overrides:
validatein classPartitionedObject- Parameters:
validationVisitor- visitor object that receives validation error detailsobjService- PersistedObjectService instance. May be null, so be cautious when requiring it
-
canEdit
public boolean canEdit(User user, ValidationVisitor validationVisitor, PersistedObjectService objService, Map<String, Object> fieldsToEdit) Description copied from class:net.pricefx.domain.PersistedObjectOverride this method to do edit-ability checks based on request details and object data (or related object data) and new data from request In case of a false return value a validation error should be added.- Overrides:
canEditin classPersistedObject- Parameters:
user- that requests edit accessvalidationVisitor- receives any "not allowed messages"objService- needed for cross object edit-ability checks. Implemented as parameter to optimize performance (vs. new object creation)fieldsToEdit- fields and their values that are about to be modified. To implement more fine-grained edit-ability checks (like e.g. allow tree repositioning while the object is otherwise locked)- Returns:
- true if edit is allowed, false otherwise
-
onSaveOrUpdate
public void onSaveOrUpdate(PersistedObjectService objService) Description copied from class:net.pricefx.domain.PersistedObjectDefault does nothing. Method is called when object is about to be saved or updated Override point- Overrides:
onSaveOrUpdatein classPersistedObject
-
onSavedOrUpdated
public void onSavedOrUpdated(PersistedObjectService objService) - Overrides:
onSavedOrUpdatedin classPersistedObject
-
emitUserUpdateActionAfterCommit
public void emitUserUpdateActionAfterCommit() -
getPermissions
-
createRootUser
public static void createRootUser(PersistedObjectService objService) -
createOrUpdateSupportUser
public static void createOrUpdateSupportUser(PersistedObjectService objService) -
createSupportUser
public static void createSupportUser(PersistedObjectService objService) -
updateSupportUser
-