Package com.broadleafcommerce.auth.user.provider.jpa.domain

Class JpaUser

java.lang.Object

com.broadleafcommerce.auth.user.provider.jpa.domain.JpaUser

All Implemented Interfaces:

com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware, com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable, Serializable

@Entity
public class JpaUser
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable, com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware

Persisted counterpart for a User.

Author:

Nathan Moore (nathanmoore)., Samarth Dhruva (samarthd)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JpaUser()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
org.modelmapper.ModelMapper	fromMe()
List<JpaAccountRoleXref>	getAccountRoles()
Set<String>	getApplicationIds()
Map<String,Object>	getAttributes()
Class<?>	getBusinessDomainType()
String	getCustomerContextId()
String	getDefaultAccountId()
String	getEmail()
String	getExternalId()
String	getFirstName()
String	getFullName()
String	getId()
String	getLastName()
Instant	getLastUpdated()	We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).
Instant	getLockedTime()
String	getMiddleName()
String	getPassword()
List<JpaUserHistoricalPassword>	getPasswordHistory()
Instant	getPasswordLastUpdated()
Set<JpaUserPermission>	getPermissions()
String	getPlainPassword()
Set<JpaUserRestrictedPermission>	getRestrictedPermissions()
Set<JpaUserRestrictedRole>	getRestrictedRoles()
Set<JpaUserRestriction>	getRestrictions()
Set<JpaUserRole>	getRoles()
String	getServerId()
String	getServiceId()
String	getTenantId()
String	getType()
String	getUsername()
int	hashCode()
boolean	isActive()
boolean	isApplicationAccess()
boolean	isArchived()
boolean	isChangePasswordRequired()
boolean	isExpired()
boolean	isImpersonationAllowed()
boolean	isLocked()
boolean	isTenantAccess()
protected User	pruneArchivedReferences(org.modelmapper.spi.MappingContext<JpaUser,User> mappingContext)	Used as the TypeMap.setPostConverter(Converter) for fromMe().
void	setAccountRoles(List<JpaAccountRoleXref> accountRoles)
void	setActive(boolean active)
void	setApplicationAccess(boolean applicationAccess)
void	setApplicationIds(Set<String> applicationIds)
void	setArchived(boolean archived)
void	setAttributes(Map<String,Object> attributes)
void	setChangePasswordRequired(boolean changePasswordRequired)
void	setCustomerContextId(String customerContextId)
void	setDefaultAccountId(String defaultAccountId)
void	setEmail(String email)
void	setExpired(boolean expired)
void	setExternalId(String externalId)
void	setFirstName(String firstName)
void	setFullName(String fullName)
void	setId(String id)
void	setImpersonationAllowed(boolean impersonationAllowed)
void	setLastName(String lastName)
void	setLastUpdated(Instant lastUpdated)	We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).
void	setLocked(boolean locked)
void	setLockedTime(Instant lockedTime)
void	setMiddleName(String middleName)
void	setPassword(String password)
void	setPasswordHistory(List<JpaUserHistoricalPassword> passwordHistory)
void	setPasswordLastUpdated(Instant passwordLastUpdated)
void	setPermissions(Set<JpaUserPermission> permissions)
void	setPlainPassword(String plainPassword)
void	setRestrictedPermissions(Set<JpaUserRestrictedPermission> restrictedPermissions)
void	setRestrictedRoles(Set<JpaUserRestrictedRole> restrictedRoles)
void	setRestrictions(Set<JpaUserRestriction> restrictions)
void	setRoles(Set<JpaUserRole> roles)
void	setServerId(String serverId)
void	setServiceId(String serviceId)
void	setTenantAccess(boolean tenantAccess)
void	setTenantId(String tenantId)
void	setType(String type)
void	setUsername(String username)
org.modelmapper.ModelMapper	toMe()
protected <U extends User, J extends JpaUser> J	toMeParentUserBackReferenceAdder(org.modelmapper.spi.MappingContext<U,J> mappingContext)	Used as the TypeMap.setPostConverter(Converter) for JpaUser in toMe().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable

postFromMe, postToMe, preFromMe, preToMe

Constructor Details

JpaUser

public JpaUser()

Method Details

fromMe

public org.modelmapper.ModelMapper fromMe()

Specified by:

fromMe in interface com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable

pruneArchivedReferences

protected User pruneArchivedReferences(org.modelmapper.spi.MappingContext<JpaUser,User> mappingContext)

Used as the TypeMap.setPostConverter(Converter) for fromMe().

JPA will eagerly fetch roles and permissions if they exist in the data store, but we have a soft-deletion concept that JPA does not account for. This ensures that any references to entities that have been archived are pruned before being mapped to the business domain. This protects against those entities being usable despite being archived.

Parameters:

mappingContext - the model mapper mapping context

Returns:

the business-domain user after removing any references to archived records

toMe

public org.modelmapper.ModelMapper toMe()

Specified by:

toMe in interface com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable

toMeParentUserBackReferenceAdder

protected <U extends User,
J extends JpaUser> J toMeParentUserBackReferenceAdder(org.modelmapper.spi.MappingContext<U,J> mappingContext)

Used as the TypeMap.setPostConverter(Converter) for JpaUser in toMe().

For each of the parent-user back-references in managed collections like getRestrictions(), getRestrictedRoles(), and getRestrictedPermissions(), explicitly sets their value to the user instance being mapped.

As documented in TypeMap.include(Class, Class), extensions will not automatically inherit this converter, and must manually set it on the extended type map.

Parameters:

mappingContext - the model mapper mapping context

Returns:

the persisted-domain user after setting each of its managed collection items' parent references to itself

getBusinessDomainType

public Class<?> getBusinessDomainType()

Specified by:

getBusinessDomainType in interface com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware

getId

public String getId()

getFirstName

public String getFirstName()

See Also:

• User.getFirstName()

getMiddleName

public String getMiddleName()

See Also:

• User.getMiddleName()

getLastName

public String getLastName()

See Also:

• User.getLastName()

getFullName

public String getFullName()

See Also:

• User.getFullName()

getUsername

public String getUsername()

See Also:

• User.getUsername()

getPassword

public String getPassword()

See Also:

• User.getPassword()

getPasswordLastUpdated

public Instant getPasswordLastUpdated()

See Also:

• User.getPasswordLastUpdated()

getPasswordHistory

public List<JpaUserHistoricalPassword> getPasswordHistory()

See Also:

• User.getPasswordHistory()

getPlainPassword

public String getPlainPassword()

getEmail

public String getEmail()

See Also:

• User.getEmail()

isActive

public boolean isActive()

See Also:

• User.isActive()

isChangePasswordRequired

public boolean isChangePasswordRequired()

See Also:

• User.isChangePasswordRequired()

isLocked

public boolean isLocked()

See Also:

• User.isLocked()

isExpired

public boolean isExpired()

See Also:

• User.isExpired()

isImpersonationAllowed

public boolean isImpersonationAllowed()

See Also:

• User.isImpersonationAllowed()

getServiceId

public String getServiceId()

See Also:

• User.getServiceId()

getType

public String getType()

See Also:

• User.getType()

getExternalId

public String getExternalId()

See Also:

• User.getExternalId()

isTenantAccess

public boolean isTenantAccess()

See Also:

• User.isTenantAccess()

isApplicationAccess

public boolean isApplicationAccess()

See Also:

• User.isApplicationAccess()

getTenantId

public String getTenantId()

See Also:

• User.getTenantId()

getApplicationIds

public Set<String> getApplicationIds()

See Also:

• User.getApplicationIds()

getCustomerContextId

public String getCustomerContextId()

See Also:

• User.getCustomerContextId()

getAttributes

public Map<String,Object> getAttributes()

See Also:

• User.getAttributes()

getRoles

public Set<JpaUserRole> getRoles()

See Also:

• User.getRoles()

getPermissions

public Set<JpaUserPermission> getPermissions()

See Also:

• User.getPermissions()

getRestrictions

public Set<JpaUserRestriction> getRestrictions()

See Also:

• User.getRestrictions()

getRestrictedRoles

public Set<JpaUserRestrictedRole> getRestrictedRoles()

See Also:

• User.getRestrictedRoles()

getRestrictedPermissions

public Set<JpaUserRestrictedPermission> getRestrictedPermissions()

See Also:

• User.getRestrictedPermissions()

getServerId

public String getServerId()

See Also:

• User.getServerId()

getLastUpdated

public Instant getLastUpdated()

We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).

See Also:

• User.getLastUpdated()

isArchived

public boolean isArchived()

See Also:

• User.isArchived()

getLockedTime

public Instant getLockedTime()

See Also:

• User.getLockedTime()

getAccountRoles

public List<JpaAccountRoleXref> getAccountRoles()

See Also:

• User.getAccountRoles()

getDefaultAccountId

public String getDefaultAccountId()

setId

public void setId(String id)

setFirstName

public void setFirstName(String firstName)

See Also:

• User.getFirstName()

setMiddleName

public void setMiddleName(String middleName)

See Also:

• User.getMiddleName()

setLastName

public void setLastName(String lastName)

See Also:

• User.getLastName()

setFullName

public void setFullName(String fullName)

See Also:

• User.getFullName()

setUsername

public void setUsername(String username)

See Also:

• User.getUsername()

setPassword

public void setPassword(String password)

See Also:

• User.getPassword()

setPasswordLastUpdated

public void setPasswordLastUpdated(Instant passwordLastUpdated)

See Also:

• User.getPasswordLastUpdated()

setPasswordHistory

public void setPasswordHistory(List<JpaUserHistoricalPassword> passwordHistory)

See Also:

• User.getPasswordHistory()

setPlainPassword

public void setPlainPassword(String plainPassword)

setEmail

public void setEmail(String email)

See Also:

• User.getEmail()

setActive

public void setActive(boolean active)

See Also:

• User.isActive()

setChangePasswordRequired

public void setChangePasswordRequired(boolean changePasswordRequired)

See Also:

• User.isChangePasswordRequired()

setLocked

public void setLocked(boolean locked)

See Also:

• User.isLocked()

setExpired

public void setExpired(boolean expired)

See Also:

• User.isExpired()

setImpersonationAllowed

public void setImpersonationAllowed(boolean impersonationAllowed)

See Also:

• User.isImpersonationAllowed()

setServiceId

public void setServiceId(String serviceId)

See Also:

• User.getServiceId()

setType

public void setType(String type)

See Also:

• User.getType()

setExternalId

public void setExternalId(String externalId)

See Also:

• User.getExternalId()

setTenantAccess

public void setTenantAccess(boolean tenantAccess)

See Also:

• User.isTenantAccess()

setApplicationAccess

public void setApplicationAccess(boolean applicationAccess)

See Also:

• User.isApplicationAccess()

setTenantId

public void setTenantId(String tenantId)

See Also:

• User.getTenantId()

setApplicationIds

public void setApplicationIds(Set<String> applicationIds)

See Also:

• User.getApplicationIds()

setCustomerContextId

public void setCustomerContextId(String customerContextId)

See Also:

• User.getCustomerContextId()

setAttributes

public void setAttributes(Map<String,Object> attributes)

See Also:

• User.getAttributes()

setRoles

public void setRoles(Set<JpaUserRole> roles)

See Also:

• User.getRoles()

setPermissions

public void setPermissions(Set<JpaUserPermission> permissions)

See Also:

• User.getPermissions()

setRestrictions

public void setRestrictions(Set<JpaUserRestriction> restrictions)

See Also:

• User.getRestrictions()

setRestrictedRoles

public void setRestrictedRoles(Set<JpaUserRestrictedRole> restrictedRoles)

See Also:

• User.getRestrictedRoles()

setRestrictedPermissions

public void setRestrictedPermissions(Set<JpaUserRestrictedPermission> restrictedPermissions)

See Also:

• User.getRestrictedPermissions()

setServerId

public void setServerId(String serverId)

See Also:

• User.getServerId()

setLastUpdated

public void setLastUpdated(Instant lastUpdated)

We don't use LastModifiedDate here because we want to enable manually setting this value (ex: for setting the lastUpdated to a value received in a persistence message).

See Also:

• User.getLastUpdated()

setArchived

public void setArchived(boolean archived)

See Also:

• User.isArchived()

setLockedTime

public void setLockedTime(Instant lockedTime)

See Also:

• User.getLockedTime()

setAccountRoles

public void setAccountRoles(List<JpaAccountRoleXref> accountRoles)

See Also:

• User.getAccountRoles()

setDefaultAccountId

public void setDefaultAccountId(String defaultAccountId)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object