de.adorsys.psd2.consent.api.service

Interface AisConsentServiceEncrypted

public interface AisConsentServiceEncrypted

AisConsentService with enabled encryption and decryption

See Also:

AisConsentServiceBase, AisConsentService

Method Summary

Modifier and Type	Method and Description
void	checkConsentAndSaveActionLog(AisConsentActionRequest request) Saves information about uses of consent
Optional<String>	createAuthorization(String consentId, AisConsentAuthorizationRequest request) Creates consent authorization
Optional<String>	createConsent(CreateAisConsentRequest request) Create AIS consent
boolean	findAndTerminateOldConsentsByNewConsentId(String newConsentId) Finds old consents for current TPP and PSU and terminates them.
Optional<AisConsentAuthorizationResponse>	getAccountConsentAuthorizationById(String authorizationId, String consentId) Gets consent authorization
Optional<AisAccountConsent>	getAisAccountConsentById(String consentId) Reads full information of consent by id
Optional<List<String>>	getAuthorisationsByConsentId(String consentId) Gets list of consent authorisation IDs by consent ID
Optional<de.adorsys.psd2.xs2a.core.sca.ScaStatus>	getAuthorisationScaStatus(String consentId, String authorisationId) Gets SCA status of the authorisation by consent ID and authorisation ID
Optional<de.adorsys.psd2.xs2a.core.consent.ConsentStatus>	getConsentStatusById(String consentId) Reads status of consent by id
Optional<AisAccountConsent>	getInitialAisAccountConsentById(String consentId) Reads full initial information of consent by id
Optional<List<de.adorsys.psd2.xs2a.core.psu.PsuIdData>>	getPsuDataByConsentId(String consentId)
boolean	isAuthenticationMethodDecoupled(String authorisationId, String authenticationMethodId) Checks if requested authentication method is decoupled.
boolean	saveAuthenticationMethods(String authorisationId, List<CmsScaMethod> methods) Saves authentication methods in provided authorisation
Optional<String>	updateAspspAccountAccess(String consentId, AisAccountAccessInfo request) Updates AIS consent aspsp account access by id
boolean	updateConsentAuthorization(String authorizationId, AisConsentAuthorizationRequest request) Updates consent authorization
boolean	updateConsentStatusById(String consentId, de.adorsys.psd2.xs2a.core.consent.ConsentStatus status) Updates consent status by id
boolean	updateMultilevelScaRequired(String consentId, boolean multilevelScaRequired) Updates multilevel SCA required field
boolean	updateScaApproach(String authorisationId, de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach) Updates AIS SCA approach in authorisation

Method Detail

createConsent

Optional<String> createConsent(CreateAisConsentRequest request)

Create AIS consent

Parameters:

request - needed parameters for creating AIS consent

Returns:

String consent id

getConsentStatusById

Optional<de.adorsys.psd2.xs2a.core.consent.ConsentStatus> getConsentStatusById(String consentId)

Reads status of consent by id

Parameters:

consentId - id of consent

Returns:

ConsentStatus

updateConsentStatusById

boolean updateConsentStatusById(String consentId,
                                de.adorsys.psd2.xs2a.core.consent.ConsentStatus status)

Updates consent status by id

Parameters:

consentId - id of consent

status - new consent status

Returns:

Boolean

getAisAccountConsentById

Optional<AisAccountConsent> getAisAccountConsentById(String consentId)

Reads full information of consent by id

Parameters:

consentId - id of consent

Returns:

AisAccountConsent

getInitialAisAccountConsentById

Optional<AisAccountConsent> getInitialAisAccountConsentById(String consentId)

Reads full initial information of consent by id

Parameters:

consentId - id of consent

Returns:

AisAccountConsent

findAndTerminateOldConsentsByNewConsentId

boolean findAndTerminateOldConsentsByNewConsentId(String newConsentId)

Finds old consents for current TPP and PSU and terminates them. This method should be invoked, when a new consent is authorised.

Parameters:

newConsentId - id of new consent

Returns:

true if any consents have been terminated, false - if none

checkConsentAndSaveActionLog

void checkConsentAndSaveActionLog(AisConsentActionRequest request)

Saves information about uses of consent

Parameters:

request - needed parameters for logging usage AIS consent

updateAspspAccountAccess

Optional<String> updateAspspAccountAccess(String consentId,
                                          AisAccountAccessInfo request)

Updates AIS consent aspsp account access by id

Parameters:

request - needed parameters for updating AIS consent

consentId - id of the consent to be updated

Returns:

String consent id

createAuthorization

Optional<String> createAuthorization(String consentId,
                                     AisConsentAuthorizationRequest request)

Creates consent authorization

Parameters:

consentId - id of consent

request - needed parameters for creating consent authorization

Returns:

String authorization id

getAccountConsentAuthorizationById

Optional<AisConsentAuthorizationResponse> getAccountConsentAuthorizationById(String authorizationId,
                                                                             String consentId)

Gets consent authorization

Parameters:

consentId - id of consent

authorizationId - id of authorisation session

Returns:

AisConsentAuthorizationResponse

updateConsentAuthorization

boolean updateConsentAuthorization(String authorizationId,
                                   AisConsentAuthorizationRequest request)

Updates consent authorization

Parameters:

authorizationId - id of authorisation session

request - needed parameters for updating consent authorization

Returns:

boolean

getPsuDataByConsentId

Optional<List<de.adorsys.psd2.xs2a.core.psu.PsuIdData>> getPsuDataByConsentId(String consentId)

getAuthorisationsByConsentId

Optional<List<String>> getAuthorisationsByConsentId(String consentId)

Gets list of consent authorisation IDs by consent ID

Parameters:

consentId - id of consent

Returns:

list of consent authorisation IDs

getAuthorisationScaStatus

Optional<de.adorsys.psd2.xs2a.core.sca.ScaStatus> getAuthorisationScaStatus(String consentId,
                                                                            String authorisationId)

Gets SCA status of the authorisation by consent ID and authorisation ID

Parameters:

consentId - String representation of the consent identifier

authorisationId - String representation of the authorisation identifier

Returns:

SCA status of the authorisation

isAuthenticationMethodDecoupled

boolean isAuthenticationMethodDecoupled(String authorisationId,
                                        String authenticationMethodId)

Checks if requested authentication method is decoupled.

Parameters:

authorisationId - String representation of the authorisation identifier

authenticationMethodId - String representation of the available authentication method identifier

Returns:

true, if authentication method is decoupled and false otherwise.

saveAuthenticationMethods

boolean saveAuthenticationMethods(String authorisationId,
                                  List<CmsScaMethod> methods)

Saves authentication methods in provided authorisation

Parameters:

authorisationId - String representation of the authorisation identifier

methods - List of authentication methods to be saved

Returns:

true if authorisation was found and updated, false otherwise

updateScaApproach

boolean updateScaApproach(String authorisationId,
                          de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach)

Updates AIS SCA approach in authorisation

Parameters:

authorisationId - String representation of the authorisation identifier

scaApproach - Chosen SCA approach

Returns:

true if authorisation was found and SCA approach updated, false otherwise

updateMultilevelScaRequired

boolean updateMultilevelScaRequired(String consentId,
                                    boolean multilevelScaRequired)

Updates multilevel SCA required field

Parameters:

consentId - String representation of the consent identifier

multilevelScaRequired - multilevel SCA required indicator

Returns:

true if authorisation was found and SCA required field updated, false otherwise