org.salespointframework.useraccount

Class UserAccount

java.lang.Object

org.salespointframework.core.AbstractEntity<UserAccountIdentifier>

org.salespointframework.useraccount.UserAccount

All Implemented Interfaces:

Serializable, org.springframework.data.domain.Persistable<UserAccountIdentifier>

@Entity
public class UserAccount
extends AbstractEntity<UserAccountIdentifier>

Domain class for a user.

Author:

Oliver Gierke, Paul Henke

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserAccount()
UserAccount(UserAccountIdentifier userAccountIdentifier, String password, Role... roles)
UserAccount(UserAccountIdentifier userAccountIdentifier, String password, String firstname, String lastname, String email, Collection<Role> roles)

Method Summary

Modifier and Type	Method and Description
boolean	add(Role role) Adds a Role to the UserAccount.
String	getEmail()
String	getFirstname()
UserAccountIdentifier	getId() Get the unique identifier of this UserAccount.
String	getLastname()
Password	getPassword()
Streamable<Role>	getRoles()
String	getUsername() Returns the user's username.
boolean	hasRole(Role role) Checks if a UserAccount has a specific Role
boolean	isEnabled()
boolean	remove(Role role) Removes a Role from a UserAccount.
void	setEmail(String email)
void	setEnabled(boolean enabled)
void	setFirstname(String firstname)
void	setLastname(String lastname)
(package private) void	setPassword(Password password)

Methods inherited from class org.salespointframework.core.AbstractEntity

equals, hashCode, isNew

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAccount

UserAccount(UserAccountIdentifier userAccountIdentifier,
            String password,
            Role... roles)

UserAccount

UserAccount(UserAccountIdentifier userAccountIdentifier,
            String password,
            String firstname,
            String lastname,
            String email,
            Collection<Role> roles)

UserAccount

@Generated(value="lombok")
public UserAccount()

Method Detail

getId

public UserAccountIdentifier getId()

Get the unique identifier of this UserAccount.

Returns:

the UserAccountIdentifier of this UserAccount

getUsername

public String getUsername()

Returns the user's username.

Returns:

will never be null.

add

public boolean add(Role role)

Adds a Role to the UserAccount.

Parameters:

role - role which the user will receive, must not be null.

Returns:

true if successful, false otherwise.

remove

public boolean remove(Role role)

Removes a Role from a UserAccount.

Parameters:

role - role which will be removed from user, must not be null.

Returns:

true if successful, false otherwise.

hasRole

public boolean hasRole(Role role)

Checks if a UserAccount has a specific Role

Parameters:

role - Role for which the user will be checked for, must not be null.

Returns:

true if role was granted to user

getRoles

public Streamable<Role> getRoles()

Returns:

An Iterable/code> with all Roles of the user

getPassword

@Generated(value="lombok")
public Password getPassword()

setPassword

@Generated(value="lombok")
void setPassword(Password password)

getFirstname

@Generated(value="lombok")
public String getFirstname()

setFirstname

@Generated(value="lombok")
public void setFirstname(String firstname)

getLastname

@Generated(value="lombok")
public String getLastname()

setLastname

@Generated(value="lombok")
public void setLastname(String lastname)

getEmail

@Generated(value="lombok")
public String getEmail()

setEmail

@Generated(value="lombok")
public void setEmail(String email)

isEnabled

@Generated(value="lombok")
public boolean isEnabled()

setEnabled

@Generated(value="lombok")
public void setEnabled(boolean enabled)