Package org.salespointframework.useraccount

Interface UserAccountManagement

@Service
public interface UserAccountManagement

Central service to manager UserAccount instances.

Author:

Paul Henke, Oliver Gierke

Method Summary

Modifier and Type	Method	Description
void	changePassword(UserAccount userAccount, Password.UnencryptedPassword password)	Changes the password of the UserAccount.
boolean	contains(UserAccount.UserAccountIdentifier userAccountIdentifier)	Checks if an UserAccount exists.
UserAccount	create(String userName, Password.UnencryptedPassword password, Iterable<Role> roles)	Creates a new UserAccount from the given username, Password.UnencryptedPassword and roles.
UserAccount	create(String userName, Password.UnencryptedPassword password, String emailAddress, Iterable<Role> roles)	Creates a new UserAccount from the given username, Password.UnencryptedPassword, email address and roles.
UserAccount	create(String userName, Password.UnencryptedPassword password, String emailAddress, Role... roles)	Creates a new UserAccount from the given username, Password.UnencryptedPassword, email address and roles.
UserAccount	create(String userName, Password.UnencryptedPassword password, Role... roles)	Creates a new UserAccount from the given username, Password.UnencryptedPassword and roles.
UserAccount	delete(UserAccount account)	Deletes the given UserAccount.
void	disable(UserAccount.UserAccountIdentifier userAccountIdentifier)	Disables the UserAccount.
void	enable(UserAccount.UserAccountIdentifier userAccountIdentifier)	Enables the UserAccount.
Streamable<UserAccount>	findAll()	Finds all UserAccounts.
Optional<UserAccount>	findByUsername(String username)	Returns the user with the given user name.
Streamable<UserAccount>	findDisabled()	Finds only disabled UserAccounts.
Streamable<UserAccount>	findEnabled()	Finds only enabled UserAccounts.
Optional<UserAccount>	get(UserAccount.UserAccountIdentifier userAccountIdentifier)	Returns an UserAccount for a given identifier.
UserAccount	save(UserAccount userAccount)	Saves the UserAccount

Method Details

create

UserAccount create(String userName,
 Password.UnencryptedPassword password,
 Role... roles)

Creates a new UserAccount from the given username, Password.UnencryptedPassword and roles.

Parameters:

userName - the unique name of the user, the name is also used as login name.

password - the unencrypted password which will be encrypted.

roles - zero or more roles.

Returns:

a UserAccount, will never be null.

create

UserAccount create(String userName,
 Password.UnencryptedPassword password,
 Iterable<Role> roles)

Creates a new UserAccount from the given username, Password.UnencryptedPassword and roles.

Parameters:

userName - the unique name of the user, the name is also used as login name.

password - the unencrypted password which will be encrypted.

roles - zero or more roles.

Returns:

a UserAccount, will never be null.

Since:

7.5

create

UserAccount create(String userName,
 Password.UnencryptedPassword password,
 String emailAddress,
 Role... roles)

Creates a new UserAccount from the given username, Password.UnencryptedPassword, email address and roles.

Parameters:

userName - the unique name of the user, the name is also used as login name.

password - the unencrypted password which will be encrypted.

emailAddress - the email address to be used.

roles - zero or more roles.

Returns:

a UserAccount, will never be null.

Since:

7.1

create

UserAccount create(String userName,
 Password.UnencryptedPassword password,
 String emailAddress,
 Iterable<Role> roles)

Creates a new UserAccount from the given username, Password.UnencryptedPassword, email address and roles.

Parameters:

userName - the unique name of the user, the name is also used as login name.

password - the unencrypted password which will be encrypted.

emailAddress - the email address to be used.

roles - zero or more roles.

Returns:

a UserAccount, will never be null.

Since:

7.5

get

Optional<UserAccount> get(UserAccount.UserAccountIdentifier userAccountIdentifier)

Returns an UserAccount for a given identifier.

Parameters:

userAccountIdentifier -

Returns:

will never be null.

save

UserAccount save(UserAccount userAccount)

Saves the UserAccount

Parameters:

userAccount -

Returns:

will never be null.

enable

void enable(UserAccount.UserAccountIdentifier userAccountIdentifier)

Enables the UserAccount.

Parameters:

userAccountIdentifier -

disable

void disable(UserAccount.UserAccountIdentifier userAccountIdentifier)

Disables the UserAccount.

Parameters:

userAccountIdentifier -

changePassword

void changePassword(UserAccount userAccount,
 Password.UnencryptedPassword password)

Changes the password of the UserAccount.

Parameters:

userAccount -

password - must not be null.

contains

boolean contains(UserAccount.UserAccountIdentifier userAccountIdentifier)

Checks if an UserAccount exists.

Parameters:

userAccountIdentifier -

Returns:

whether a UserAccount with the given identifier exists.

findAll

Streamable<UserAccount> findAll()

Finds all UserAccounts.

Returns:

will never be null.

findEnabled

Streamable<UserAccount> findEnabled()

Finds only enabled UserAccounts.

Returns:

will never be null.

findDisabled

Streamable<UserAccount> findDisabled()

Finds only disabled UserAccounts.

Returns:

will never be null.

findByUsername

Optional<UserAccount> findByUsername(String username)

Returns the user with the given user name.

Parameters:

username - must not be null or empty.

Returns:

will never be null.

delete

UserAccount delete(UserAccount account)

Deletes the given UserAccount. Note, that other aggregates that keep references to a UserAccount have to be deleted before a UserAccount can be deleted in the first place.

Parameters:

account - must not be null.

Returns:

the deleted UserAccount

Since:

7.1