de.adorsys.psd2.consent.api.service

Interface AuthorisationServiceBase

All Known Subinterfaces:

AuthorisationService, AuthorisationServiceEncrypted

public interface AuthorisationServiceBase

Base version of AuthorisationService that contains all method declarations. Should not be implemented directly, consider using one of the interfaces that extends this one.

See Also:

AuthorisationService, AuthorisationServiceEncrypted

Method Summary

Modifier and Type	Method and Description
CmsResponse<CreateAuthorisationResponse>	createAuthorisation(AuthorisationParentHolder parentHolder, CreateAuthorisationRequest request) Creates authorisation and return response object
CmsResponse<de.adorsys.psd2.xs2a.core.authorisation.Authorisation>	getAuthorisationById(String authorisationId) Gets authorisation
CmsResponse<List<String>>	getAuthorisationsByParentId(AuthorisationParentHolder parentHolder) Gets list of authorisation IDs by parent ID
CmsResponse<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse>	getAuthorisationScaApproach(String authorisationId) Gets SCA approach from the authorisation by authorisation ID
CmsResponse<de.adorsys.psd2.xs2a.core.sca.ScaStatus>	getAuthorisationScaStatus(String authorisationId, AuthorisationParentHolder parentHolder) Gets SCA status of the authorisation by parent ID and authorisation ID
CmsResponse<Boolean>	isAuthenticationMethodDecoupled(String authorisationId, String authenticationMethodId) Checks if requested authentication method is decoupled.
CmsResponse<Boolean>	saveAuthenticationMethods(String authorisationId, List<CmsScaMethod> methods) Saves authentication methods in provided authorisation
CmsResponse<de.adorsys.psd2.xs2a.core.authorisation.Authorisation>	updateAuthorisation(String authorisationId, UpdateAuthorisationRequest request) Updates authorisation
CmsResponse<Boolean>	updateAuthorisationStatus(String authorisationId, de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus) Updates authorisation status
CmsResponse<Boolean>	updateScaApproach(String authorisationId, de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach) Updates AIS SCA approach in authorisation

Method Detail

createAuthorisation

CmsResponse<CreateAuthorisationResponse> createAuthorisation(AuthorisationParentHolder parentHolder,
                                                             CreateAuthorisationRequest request)

Creates authorisation and return response object

Parameters:

parentHolder - holder contains authorisation type and parent ID

request - needed parameters for creating authorisation

Returns:

CreateAuthorisationResponse object with authorisation ID and scaStatus

getAuthorisationById

CmsResponse<de.adorsys.psd2.xs2a.core.authorisation.Authorisation> getAuthorisationById(String authorisationId)

Gets authorisation

Parameters:

authorisationId - ID of authorisation session

Returns:

AuthorisationResponse

updateAuthorisation

CmsResponse<de.adorsys.psd2.xs2a.core.authorisation.Authorisation> updateAuthorisation(String authorisationId,
                                                                                       UpdateAuthorisationRequest request)

Updates authorisation

Parameters:

authorisationId - ID of authorisation session

request - needed parameters for updating authorisation

Returns:

AuthorisationResponse

updateAuthorisationStatus

CmsResponse<Boolean> updateAuthorisationStatus(String authorisationId,
                                               de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus)

Updates authorisation status

Parameters:

authorisationId - ID of authorisation session

scaStatus - to be updated status

Returns:

boolean

getAuthorisationsByParentId

CmsResponse<List<String>> getAuthorisationsByParentId(AuthorisationParentHolder parentHolder)

Gets list of authorisation IDs by parent ID

Parameters:

parentHolder - holder contains authorisation type and parent ID

Returns:

list of parent authorisation IDs

getAuthorisationScaStatus

CmsResponse<de.adorsys.psd2.xs2a.core.sca.ScaStatus> getAuthorisationScaStatus(String authorisationId,
                                                                               AuthorisationParentHolder parentHolder)

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

Parameters:

parentHolder - holder contains authorisation type and parent ID

authorisationId - String representation of the authorisation identifier

Returns:

SCA status of the authorisation

isAuthenticationMethodDecoupled

CmsResponse<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

CmsResponse<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

CmsResponse<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

getAuthorisationScaApproach

CmsResponse<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse> getAuthorisationScaApproach(String authorisationId)

Gets SCA approach from the authorisation by authorisation ID

Parameters:

authorisationId - String representation of the authorisation identifier

Returns:

SCA approach of the authorisation