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(AccessTokenBO accessToken, AisConsentBO aisConsent) Provides a token used to gain read access to an account.
UserBO	create(UserBO user) Creates a new user
UserBO	findById(String id) Finds a User by its identifier
UserBO	findByLogin(String login) Finds a User by its login
List<UserBO>	getAll()
List<UserBO>	listUsers(int page, int size)
AisConsentBO	loadConsent(String consentId) Loads a consent given the consent id.
BearerTokenBO	loginToken(AccessTokenBO loginToken, String authorisationId) Create a new token for the current user, with a new authorization id
BearerTokenBO	scaToken(AccessTokenBO loginToken) Create a new token for the current user, after a successfull auth code proces..
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)
       throws UserAlreadyExistsException

Creates a new user

Parameters:

user - User business object

Returns:

A persisted user or trows a UserAlreadyExistsException

Throws:

UserAlreadyExistsException - is thrown if user already exists

authorise

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

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, false for failure or throws a UserNotFoundException

Throws:

UserNotFoundException - is thrown if user can`t be found

InsufficientPermissionException - usder does not have requested role

findById

UserBO findById(String id)
         throws UserNotFoundException

Finds a User by its identifier

Parameters:

id - User identifier

Returns:

a User or throws a UserNotFoundException

Throws:

UserNotFoundException - is thrown if user can`t be found

findByLogin

UserBO findByLogin(String login)
            throws UserNotFoundException

Finds a User by its login

Parameters:

login - User identifier

Returns:

a User or throws a UserNotFoundException

Throws:

UserNotFoundException - is thrown if user can`t be found

updateScaData

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

Update SCA methods by user login

Parameters:

scaDataList - user methods

userLogin - user login

Returns:

The user object.

Throws:

UserNotFoundException - no user with given login.

updateAccountAccess

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

Throws:

UserNotFoundException

listUsers

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

getAll

List<UserBO> getAll()

validate

BearerTokenBO validate(String accessToken,
                       Date refTime)
                throws UserNotFoundException,
                       InsufficientPermissionException

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

Throws:

UserNotFoundException - : user is no longer in the database.

InsufficientPermissionException - access permissions contained in the token are no longer supported by the user.

consentToken

BearerTokenBO consentToken(AccessTokenBO accessToken,
                           AisConsentBO aisConsent)
                    throws InsufficientPermissionException

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

Parameters:

accessToken - the token used by the user currently granting permission

aisConsent - the ais consent.

Returns:

the bearer token

Throws:

InsufficientPermissionException - the current user does not have sufficient permission.

scaToken

BearerTokenBO scaToken(AccessTokenBO loginToken)
                throws InsufficientPermissionException,
                       UserNotFoundException

Create a new token for the current user, after a successfull auth code proces..

Parameters:

loginToken - : the token obtained in the preceeding request.

Returns:

the bearer token

Throws:

InsufficientPermissionException - : user does not have the required role.

UserNotFoundException - : underlying user non longer existent.

loginToken

BearerTokenBO loginToken(AccessTokenBO loginToken,
                         String authorisationId)
                  throws InsufficientPermissionException,
                         UserNotFoundException

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

Parameters:

loginToken - : the token to clone

authorisationId - : the authorization id to exchange

Returns:

the bearer token

Throws:

InsufficientPermissionException - : user does not have the required role.

UserNotFoundException - : underlying user non longer existent.

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)
                  throws ConsentNotFoundException

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

Parameters:

consentId - the consent id

Returns:

the corresponding ais consent.

Throws:

ConsentNotFoundException