de.adorsys.ledgers.middleware.api.service

Interface MiddlewareOnlineBankingService

public interface MiddlewareOnlineBankingService

Interface used for the initialization of user interaction. Implementation of this interface will generally not require user interaction.

Author:

fpo

Method Summary

Modifier and Type	Method and Description
SCALoginResponseTO	authenticateForLogin(String authorisationId, String authCode) PROC: 02c
SCALoginResponseTO	authorise(String login, String pin, UserRoleTO role) Performs user authorization.
SCALoginResponseTO	authoriseForConsent(String login, String pin, String consentId, String authorisationId, OpTypeTO opType) Special login associated with a account information, a payment or a payment cancellation consent.
SCALoginResponseTO	generateLoginAuthCode(String scaUserDataId, String authorisationId, String userMessage, int validitySeconds) After the PSU selects the SCA method, this is called to generate and send the login auth code.
UserTO	register(String login, String email, String pin, UserRoleTO role) Registers a User.
BearerTokenTO	validate(String accessToken) Caller can be sure that returned user object contains a mirror of permissions contained in the token.

Method Detail

register

UserTO register(String login,
                String email,
                String pin,
                UserRoleTO role)
         throws UserAlreadyExistsMiddlewareException

Registers a User.

Parameters:

login - the login of the user

email - the email of the user

pin - the pin of this user

role - the initial role of the user.

Returns:

: user

Throws:

UserAlreadyExistsMiddlewareException - : user with login exists.

authorise

SCALoginResponseTO authorise(String login,
                             String pin,
                             UserRoleTO role)
                      throws UserNotFoundMiddlewareException,
                             InsufficientPermissionMiddlewareException

Performs user authorization. The returned String will be a signed JWT containing user access rights and sca data.

Parameters:

login - User login

pin - User PIN

role - The intended role.

Returns:

a session id for success, false for failure or trows a

Throws:

UserNotFoundMiddlewareException - :sis thrown if user can`t be found

InsufficientPermissionMiddlewareException - : permission not sufficient

authoriseForConsent

SCALoginResponseTO authoriseForConsent(String login,
                                       String pin,
                                       String consentId,
                                       String authorisationId,
                                       OpTypeTO opType)
                                throws UserNotFoundMiddlewareException,
                                       InsufficientPermissionMiddlewareException

Special login associated with a account information, a payment or a payment cancellation consent.

Parameters:

login - the login of the customer

pin - the password of the customer

consentId - the consentId or paymentId

authorisationId - the authorisationId

opType - the operation type

Returns:

Throws:

UserNotFoundMiddlewareException - :sis thrown if user can`t be found

InsufficientPermissionMiddlewareException - : permission not sufficient

validate

BearerTokenTO validate(String accessToken)
                throws UserNotFoundMiddlewareException,
                       InsufficientPermissionMiddlewareException

Caller can be sure that returned user object contains a mirror of permissions contained in the token. This is generally a subset of permissions really held by the user. If during validation we notice that the user has less permission for the listed account, the token will be discarded an no user object will be returned.

Parameters:

accessToken - : the access token

Returns:

the bearer token

Throws:

UserNotFoundMiddlewareException - : user not found in db.

InsufficientPermissionMiddlewareException - : token contains more permission than the assigned to the user in the database.

generateLoginAuthCode

SCALoginResponseTO generateLoginAuthCode(String scaUserDataId,
                                         String authorisationId,
                                         String userMessage,
                                         int validitySeconds)
                                  throws SCAOperationNotFoundMiddlewareException,
                                         InsufficientPermissionMiddlewareException,
                                         SCAMethodNotSupportedMiddleException,
                                         UserScaDataNotFoundMiddlewareException,
                                         SCAOperationValidationMiddlewareException

After the PSU selects the SCA method, this is called to generate and send the login auth code.

Parameters:

scaUserDataId - scaMethod

authorisationId - the id of the auth process

userMessage - message to user

validitySeconds - validity in secondn.

Returns:

SCALoginResponseTO the response object.

Throws:

SCAOperationNotFoundMiddlewareException - op not found

InsufficientPermissionMiddlewareException - : missing permissions

SCAMethodNotSupportedMiddleException - if user sca method doesn't support by ledgers

UserScaDataNotFoundMiddlewareException - if sca user data not found by id

SCAOperationValidationMiddlewareException - : inputs not valid

authenticateForLogin

SCALoginResponseTO authenticateForLogin(String authorisationId,
                                        String authCode)
                                 throws SCAOperationNotFoundMiddlewareException,
                                        SCAOperationValidationMiddlewareException,
                                        SCAOperationExpiredMiddlewareException,
                                        SCAOperationUsedOrStolenMiddlewareException,
                                        InsufficientPermissionMiddlewareException

PROC: 02c

This is called when the user enters the received code.

Parameters:

authorisationId - : the operation id

authCode - the auth code.

Returns:

the login response.

Throws:

SCAOperationNotFoundMiddlewareException - : operation not found.

SCAOperationValidationMiddlewareException - : input data not valid.

SCAOperationExpiredMiddlewareException - : expired

SCAOperationUsedOrStolenMiddlewareException - : malicious input

InsufficientPermissionMiddlewareException - : not enough permissions.