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

Modifier	Constructor and Description
protected	UserAccount() Deprecated.
(package private)	UserAccount(UserAccountIdentifier userAccountIdentifier, String password, Role... roles)
(package private)	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	getIdentifier() Get the unique identifier of this UserAccount.
String	getLastname()
Password	getPassword()
Iterable<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)
(package private) void	setEnabled(boolean isEnabled)
void	setFirstname(String firstname)
void	setLastname(String lastname)
(package private) void	setPassword(Password password)

Methods inherited from class org.salespointframework.core.AbstractEntity

equals, getId, hashCode, isNew

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAccount

@Deprecated
protected UserAccount()

Deprecated.

UserAccount

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

UserAccount

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

Method Detail

getIdentifier

public final UserAccountIdentifier getIdentifier()

Get the unique identifier of this UserAccount.

Specified by:

getIdentifier in class AbstractEntity<UserAccountIdentifier>

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 Iterable<Role> getRoles()

Returns:

An Iterable/code> with all Roles of the user

getPassword

public Password getPassword()

setPassword

void setPassword(Password password)

isEnabled

public boolean isEnabled()

setEnabled

void setEnabled(boolean isEnabled)

getFirstname

public String getFirstname()

setFirstname

public void setFirstname(String firstname)

getLastname

public String getLastname()

setLastname

public void setLastname(String lastname)

getEmail

public String getEmail()

setEmail

public void setEmail(String email)