org.salespointframework.useraccount

Interface UserAccountManager

public interface UserAccountManager

Central service to manager UserAccount instances.

Author:

Paul Henke, Oliver Gierke

Method Summary

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

Method Detail

create

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

Creates a new UserAccount and persists it right away.

Parameters:

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

password - the password

roles - zero or more roles

Returns:

a UserAccount, will never be null.

create

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

Creates a new UserAccount and persists it right away.

Parameters:

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

password - the password

emailAddress - the email address to be used

roles - zero or more roles

Returns:

a UserAccount, will never be null.

Since:

7.1

get

Optional<UserAccount> get(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(UserAccountIdentifier userAccountIdentifier)

Enables the UserAccount.

Parameters:

userAccountIdentifier -

disable

void disable(UserAccountIdentifier userAccountIdentifier)

Disables the UserAccount.

Parameters:

userAccountIdentifier -

changePassword

void changePassword(UserAccount userAccount,
                    String password)

Changes the password of the UserAccount.

Parameters:

userAccount -

password -

contains

boolean contains(UserAccountIdentifier userAccountIdentifier)

Checks if an UserAccount exists.

Parameters:

userAccountIdentifier -

Returns:

findAll

org.springframework.data.util.Streamable<UserAccount> findAll()

Finds all UserAccounts.

Returns:

findEnabled

org.springframework.data.util.Streamable<UserAccount> findEnabled()

Finds only enabled UserAccounts.

Returns:

findDisabled

org.springframework.data.util.Streamable<UserAccount> findDisabled()

Finds only disabled UserAccounts.

Returns:

findByUsername

Optional<UserAccount> findByUsername(String username)

Returns the user with the given user name.

Parameters:

username - must not be null or empty.

Returns:

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