de.adorsys.psd2.consent.api.service

Interface AisConsentService

public interface AisConsentService

AisConsentService without any encryption/decryption. Should not be used in XS2A directly.

See Also:

AisConsentServiceBase, AisConsentServiceEncrypted

Method Summary

Modifier and Type	Method and Description
void	checkConsentAndSaveActionLog(AisConsentActionRequest request) Saves information about uses of consent
Optional<String>	createConsent(CreateAisConsentRequest request) Create AIS consent
boolean	findAndTerminateOldConsentsByNewConsentId(String newConsentId) Finds old consents for current TPP and PSU and terminates them.
Optional<AisAccountConsent>	getAisAccountConsentById(String consentId) Reads full information of consent by 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)
Optional<String>	updateAspspAccountAccess(String consentId, AisAccountAccessInfo request) Updates AIS consent aspsp account access by id
Optional<AisAccountConsent>	updateAspspAccountAccessWithResponse(String consentId, AisAccountAccessInfo request) Updates AIS consent aspsp account access by id and return consent
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

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

updateAspspAccountAccessWithResponse

Optional<AisAccountConsent> updateAspspAccountAccessWithResponse(String consentId,
                                                                 AisAccountAccessInfo request)

Updates AIS consent aspsp account access by id and return consent

Parameters:

request - needed parameters for updating AIS consent

consentId - id of the consent to be updated

Returns:

AisAccountConsent consent

getPsuDataByConsentId

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

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