Package org.broadleafcommerce.openadmin.server.security.domain

Class AdminUserImpl

java.lang.Object

org.broadleafcommerce.openadmin.server.security.domain.AdminUserImpl

All Implemented Interfaces:

Serializable, AdminMainEntity, AdminSecurityContext, AdminUser, AdminUserAdminPresentation

@Entity
public class AdminUserImpl
extends Object
implements AdminUser, AdminMainEntity, AdminUserAdminPresentation

Author:

jfischer

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.broadleafcommerce.openadmin.server.security.domain.AdminUserAdminPresentation

AdminUserAdminPresentation.FieldOrder, AdminUserAdminPresentation.GroupName, AdminUserAdminPresentation.GroupOrder, AdminUserAdminPresentation.TabName, AdminUserAdminPresentation.TabOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	activeStatusFlag
protected Map<String,AdminUserAttribute>	additionalFields
protected Set<AdminPermission>	allPermissions
protected Set<AdminRole>	allRoles	All roles that this user has
protected String	email
protected static final String	LAST_USED_SANDBOX
protected String	login
protected String	name
protected SandBox	overrideSandBox
protected String	password
protected String	phoneNumber
protected String	unencodedPassword

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AdminUserImpl()

Method Summary

Modifier and Type	Method	Description
Boolean	getActiveStatusFlag()	Returns the users active status.
Map<String,AdminUserAttribute>	getAdditionalFields()
Set<AdminPermission>	getAllPermissions()
Set<AdminRole>	getAllRoles()
String	getContextKey()
ContextType	getContextType()
String	getEmail()
Map<String,String>	getFlatAdditionalFields()	Returns a map representing just the key-value pairs inside the AdminUser.getAdditionalFields() map.
Long	getId()
Long	getLastUsedSandBoxId()
String	getLogin()
String	getMainEntityName()
String	getName()
SandBox	getOverrideSandBox()	The current sandbox associated with this user.
String	getPassword()
String	getPhoneNumber()	Returns the users phone number.
String	getUnencodedPassword()
void	setActiveStatusFlag(Boolean activeStatusFlag)	Sets the users active status.
void	setAdditionalFields(Map<String,AdminUserAttribute> additionalFields)
void	setAllPermissions(Set<AdminPermission> allPermissions)
void	setAllRoles(Set<AdminRole> allRoles)
void	setContextKey(String contextKey)
void	setContextType(ContextType contextType)
void	setEmail(String email)
void	setId(Long id)
void	setLastUsedSandBoxId(Long sandBoxId)	Sets the last used sandbox for this admin user
void	setLogin(String login)
void	setName(String name)
void	setOverrideSandBox(SandBox overrideSandBox)	Overrides the user's sandbox.
void	setPassword(String password)
void	setPhoneNumber(String phoneNumber)	Stores the user's phone number.
void	setUnencodedPassword(String unencodedPassword)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LAST_USED_SANDBOX

protected static final String LAST_USED_SANDBOX

See Also:

• Constant Field Values

name

protected String name

login

protected String login

password

protected String password

email

protected String email

phoneNumber

protected String phoneNumber

activeStatusFlag

protected Boolean activeStatusFlag

allRoles

protected Set<AdminRole> allRoles

All roles that this user has

allPermissions

protected Set<AdminPermission> allPermissions

unencodedPassword

protected String unencodedPassword

overrideSandBox

protected SandBox overrideSandBox

additionalFields

protected Map<String,AdminUserAttribute> additionalFields

Constructor Details

AdminUserImpl

public AdminUserImpl()

Method Details

getUnencodedPassword

public String getUnencodedPassword()

Specified by:

getUnencodedPassword in interface AdminUser

setUnencodedPassword

public void setUnencodedPassword(String unencodedPassword)

Specified by:

setUnencodedPassword in interface AdminUser

getId

public Long getId()

Specified by:

getId in interface AdminUser

setId

public void setId(Long id)

Specified by:

setId in interface AdminUser

getName

public String getName()

Specified by:

getName in interface AdminUser

setName

public void setName(String name)

Specified by:

setName in interface AdminUser

getLogin

public String getLogin()

Specified by:

getLogin in interface AdminUser

setLogin

public void setLogin(String login)

Specified by:

setLogin in interface AdminUser

getPassword

public String getPassword()

Specified by:

getPassword in interface AdminUser

setPassword

public void setPassword(String password)

Specified by:

setPassword in interface AdminUser

getEmail

public String getEmail()

Specified by:

getEmail in interface AdminUser

setEmail

public void setEmail(String email)

Specified by:

setEmail in interface AdminUser

getPhoneNumber

public String getPhoneNumber()

Description copied from interface: AdminUser

Returns the users phone number.

Specified by:

getPhoneNumber in interface AdminUser

Returns:

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

Description copied from interface: AdminUser

Stores the user's phone number.

Specified by:

setPhoneNumber in interface AdminUser

getActiveStatusFlag

public Boolean getActiveStatusFlag()

Description copied from interface: AdminUser

Returns the users active status. A user whose active status is set to false will not be able to login.

Specified by:

getActiveStatusFlag in interface AdminUser

Returns:

setActiveStatusFlag

public void setActiveStatusFlag(Boolean activeStatusFlag)

Description copied from interface: AdminUser

Sets the users active status. A user whose active status is set to false will not be able to login.

Specified by:

setActiveStatusFlag in interface AdminUser

getAllRoles

public Set<AdminRole> getAllRoles()

Specified by:

getAllRoles in interface AdminSecurityContext

Specified by:

getAllRoles in interface AdminUser

setAllRoles

public void setAllRoles(Set<AdminRole> allRoles)

Specified by:

setAllRoles in interface AdminSecurityContext

Specified by:

setAllRoles in interface AdminUser

getOverrideSandBox

public SandBox getOverrideSandBox()

Description copied from interface: AdminUser

The current sandbox associated with this user. This is primarily intended to be used by the BLC-CMS workflow processes.

If null, the user is using their own SandBox.

Specified by:

getOverrideSandBox in interface AdminUser

Returns:

setOverrideSandBox

public void setOverrideSandBox(SandBox overrideSandBox)

Description copied from interface: AdminUser

Overrides the user's sandbox. This could be used to setup shared sandboxes. Setting to null will mean that the user is setup to use the sandbox associated with their user.

Specified by:

setOverrideSandBox in interface AdminUser

getAllPermissions

public Set<AdminPermission> getAllPermissions()

Specified by:

getAllPermissions in interface AdminSecurityContext

Specified by:

getAllPermissions in interface AdminUser

setAllPermissions

public void setAllPermissions(Set<AdminPermission> allPermissions)

Specified by:

setAllPermissions in interface AdminSecurityContext

Specified by:

setAllPermissions in interface AdminUser

getContextType

public ContextType getContextType()

Specified by:

getContextType in interface AdminSecurityContext

setContextType

public void setContextType(ContextType contextType)

Specified by:

setContextType in interface AdminSecurityContext

getContextKey

public String getContextKey()

Specified by:

getContextKey in interface AdminSecurityContext

setContextKey

public void setContextKey(String contextKey)

Specified by:

setContextKey in interface AdminSecurityContext

getFlatAdditionalFields

public Map<String,String> getFlatAdditionalFields()

Description copied from interface: AdminUser

Returns a map representing just the key-value pairs inside the AdminUser.getAdditionalFields() map.

Specified by:

getFlatAdditionalFields in interface AdminUser

Returns:

the collapsed map

getAdditionalFields

public Map<String,AdminUserAttribute> getAdditionalFields()

Specified by:

getAdditionalFields in interface AdminUser

setAdditionalFields

public void setAdditionalFields(Map<String,AdminUserAttribute> additionalFields)

Specified by:

setAdditionalFields in interface AdminUser

getLastUsedSandBoxId

public Long getLastUsedSandBoxId()

Specified by:

getLastUsedSandBoxId in interface AdminUser

Returns:

the id of the last sandbox this admin user used

setLastUsedSandBoxId

public void setLastUsedSandBoxId(Long sandBoxId)

Description copied from interface: AdminUser

Sets the last used sandbox for this admin user

Specified by:

setLastUsedSandBoxId in interface AdminUser

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface AdminMainEntity

Returns:

the display name of this entity for the admin screen