de.adorsys.psd2.consent.aspsp.api.tpp

Interface CmsAspspTppService

public interface CmsAspspTppService

Method Summary

Modifier and Type	Method and Description
boolean	blockTpp(@NotNull String tppAuthorizationNumber, @Nullable Duration lockPeriod) Blocks requests from TPP by given TPP ID.
@NotNull Optional<de.adorsys.psd2.xs2a.core.tpp.TppInfo>	getTppInfoById(@NotNull String tppAuthorizationNumber) Loads TPP Information by its ID
boolean	unblockTpp(@NotNull String tppAuthorisationNumber) Releases lock of requests from TPP by given TPP ID.

Method Detail

getTppInfoById

@NotNull
@NotNull Optional<de.adorsys.psd2.xs2a.core.tpp.TppInfo> getTppInfoById(@NotNull
                                                                                 @NotNull String tppAuthorizationNumber)

Loads TPP Information by its ID

Parameters:

tppAuthorizationNumber - ID of TPP to load

Returns:

TPP Info object if found in DB

blockTpp

boolean blockTpp(@NotNull
                 @NotNull String tppAuthorizationNumber,
                 @Nullable
                 @Nullable Duration lockPeriod)

Blocks requests from TPP by given TPP ID. If lockPeriod parameter is passed, locks TPP for certain time. If lockPeriod is not passed, lock TPP without time limitation. If TPP with given ID doesn't exist in DB, creates an empty one with given ID

Parameters:

tppAuthorizationNumber - ID of TPP to lock

lockPeriod - Time period of locking. May be omitted.

Returns:

true if lock was done. false otherwise.

unblockTpp

boolean unblockTpp(@NotNull
                   @NotNull String tppAuthorisationNumber)

Releases lock of requests from TPP by given TPP ID. If TPP with given ID doesn't exist in DB, does nothing.

Parameters:

tppAuthorisationNumber - ID of TPP to lock

Returns:

true if TPP was found and unlock was done. false otherwise.