de.adorsys.ledgers.um.api.service

Interface UserService

public interface UserService

Method Summary

Modifier and Type	Method and Description
BearerTokenBO	authorise(String login, String pin, UserRoleBO role, String scaId, String authorisationId) Verify user credential and produces a corresponding login token.
BearerTokenBO	consentToken(ScaInfoBO scaInfoBO, AisConsentBO aisConsent) Provides a token used to gain read access to an account.
int	countUsersByBranch(String branch) Counts amount of users for a branch
UserBO	create(UserBO user) Creates a new user
List<UserBO>	findByBranchAndUserRolesIn(String branch, List<UserRoleBO> userRoles) Loads users collection by branch and the given roles
UserBO	findById(String id) Finds a User by its identifier
UserBO	findByLogin(String login) Finds a User by its login
List<UserBO>	listUsers(int page, int size)
AisConsentBO	loadConsent(String consentId) Loads a consent given the consent id.
BearerTokenBO	loginToken(ScaInfoBO scaInfoBO) Create a new token for the current user, with a new authorization id
BearerTokenBO	scaToken(ScaInfoBO scaInfoBO) Create a new token for the current user, after a successful auth code process..
AisConsentBO	storeConsent(AisConsentBO consentBO) Stores a consent in the consent database and returns the original consent if already existing there.
UserBO	updateAccountAccess(String userLogin, List<AccountAccessBO> accountAccessListBO)
UserBO	updateScaData(List<ScaUserDataBO> scaDataList, String userLogin) Update SCA methods by user login
BearerTokenBO	validate(String accessToken, Date refTime) Check if the provided token is valid at the given reference time and return the corresponding user.

Method Detail

create

UserBO create(UserBO user)

Creates a new user

Parameters:

user - User business object

Returns:

A persisted user

authorise

BearerTokenBO authorise(String login,
                        String pin,
                        UserRoleBO role,
                        String scaId,
                        String authorisationId)

Verify user credential and produces a corresponding login token.

The granted access token can no be used to access account information.

Parameters:

login - User login

pin - User PIN

role - the role of this user

scaId - the scaId

authorisationId - the authorization id

Returns:

BearerTokenBO representation of authorization status true for success

findById

UserBO findById(String id)

Finds a User by its identifier

Parameters:

id - User identifier

Returns:

a User

findByLogin

UserBO findByLogin(String login)

Finds a User by its login

Parameters:

login - User identifier

Returns:

a User

updateScaData

UserBO updateScaData(List<ScaUserDataBO> scaDataList,
                     String userLogin)

Update SCA methods by user login

Parameters:

scaDataList - user methods

userLogin - user login

Returns:

The user object.

updateAccountAccess

UserBO updateAccountAccess(String userLogin,
                           List<AccountAccessBO> accountAccessListBO)

listUsers

List<UserBO> listUsers(int page,
                       int size)

validate

BearerTokenBO validate(String accessToken,
                       Date refTime)

Check if the provided token is valid at the given reference time and return the corresponding user.

Parameters:

accessToken - the access token to validate

refTime - the reference time

Returns:

the bearer token

consentToken

BearerTokenBO consentToken(ScaInfoBO scaInfoBO,
                           AisConsentBO aisConsent)

Provides a token used to gain read access to an account.

Parameters:

scaInfoBO - SCA information

aisConsent - the ais consent.

Returns:

the bearer token

scaToken

BearerTokenBO scaToken(ScaInfoBO scaInfoBO)

Create a new token for the current user, after a successful auth code process..

Parameters:

scaInfoBO - : SCA information

Returns:

the bearer token

loginToken

BearerTokenBO loginToken(ScaInfoBO scaInfoBO)

Create a new token for the current user, with a new authorization id

Parameters:

scaInfoBO - : SCA information

Returns:

the bearer token

storeConsent

AisConsentBO storeConsent(AisConsentBO consentBO)

Stores a consent in the consent database and returns the original consent if already existing there.

Parameters:

consentBO - the consent object

Returns:

the ais consent stored

loadConsent

AisConsentBO loadConsent(String consentId)

Loads a consent given the consent id. Throws a consent not found exception.

Parameters:

consentId - the consent id

Returns:

the corresponding ais consent.

findByBranchAndUserRolesIn

List<UserBO> findByBranchAndUserRolesIn(String branch,
                                        List<UserRoleBO> userRoles)

Loads users collection by branch and the given roles

Parameters:

branch - branch ID

userRoles - list of user roles

Returns:

List of users filtered by branch and user roles

countUsersByBranch

int countUsersByBranch(String branch)

Counts amount of users for a branch

Parameters:

branch - branch

Returns:

amount of users