io.vertigo.account.identity

Interface AccountStore

public interface AccountStore

This class defines the storage of accounts

Author:

pchretien

Method Summary

Modifier and Type	Method and Description
void	attach(URI<Account> accountURI, URI<AccountGroup> groupURI) Attaches an account to a group.
Account	getAccount(URI<Account> accountURI)
Optional<Account>	getAccountByAuthToken(String userAuthToken) Get an newly authentify user by his authToken.
long	getAccountsCount()
Set<URI<Account>>	getAccountURIs(URI<AccountGroup> groupURI) Lists the accounts for a defined group.
Collection<AccountGroup>	getAllGroups() Lists all the groups.
AccountGroup	getGroup(URI<AccountGroup> groupURI) Gets the group defined by an URI.
long	getGroupsCount()
Set<URI<AccountGroup>>	getGroupURIs(URI<Account> accountURI)
Optional<VFile>	getPhoto(URI<Account> accountURI) Gets the photo of an account defined by its URI.
void	reset() Reset: - All the accounts - All the groups - All the links accounts-group - All the Photos
void	saveAccounts(List<Account> accounts) Saves a collection of accounts.
void	saveGroup(AccountGroup group) Saves a group.
void	setPhoto(URI<Account> accountURI, VFile photo) Defines a photo to an account.

Method Detail

getAccountsCount

long getAccountsCount()

Returns:

the number of accounts

getAccount

Account getAccount(URI<Account> accountURI)

Parameters:

accountURI - the account defined by its URI

Returns:

the account

getGroupURIs

Set<URI<AccountGroup>> getGroupURIs(URI<Account> accountURI)

Parameters:

accountURI - the account defined by its URI

Returns:

Set of groups of this account

getGroupsCount

long getGroupsCount()

Returns:

the number of groups.

getAllGroups

Collection<AccountGroup> getAllGroups()

Lists all the groups.

Returns:

all the groups.

getGroup

AccountGroup getGroup(URI<AccountGroup> groupURI)

Gets the group defined by an URI.

Parameters:

groupURI - the group URI

Returns:

the group

getAccountURIs

Set<URI<Account>> getAccountURIs(URI<AccountGroup> groupURI)

Lists the accounts for a defined group.

Parameters:

groupURI - the group URI

Returns:

the list of acccounts.

getPhoto

Optional<VFile> getPhoto(URI<Account> accountURI)

Gets the photo of an account defined by its URI.

Parameters:

accountURI - the account defined by its URI

Returns:

the photo as a file

saveAccounts

void saveAccounts(List<Account> accounts)

Saves a collection of accounts. Caution : all the accounts must have an id.

Parameters:

accounts - the list of accounts

saveGroup

void saveGroup(AccountGroup group)

Saves a group.

Parameters:

group - the group

attach

void attach(URI<Account> accountURI,
            URI<AccountGroup> groupURI)

Attaches an account to a group.

Parameters:

accountURI - the account defined by its URI

groupURI - the group

reset

void reset()

Reset: - All the accounts - All the groups - All the links accounts-group - All the Photos

setPhoto

void setPhoto(URI<Account> accountURI,
              VFile photo)

Defines a photo to an account.

Parameters:

accountURI - the account defined by its URI

photo - the photo

getAccountByAuthToken

Optional<Account> getAccountByAuthToken(String userAuthToken)

Get an newly authentify user by his authToken.

Parameters:

userAuthToken - user authToken

Returns:

Logged account