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

Interface CmsAspspTppService

  • public interface CmsAspspTppService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean blockTpp​(@NotNull String tppAuthorisationNumber, @NotNull String instanceId, @Nullable Duration lockPeriod)
      Blocks requests from TPP by given TPP ID.
      @NotNull Optional<de.adorsys.psd2.xs2a.core.tpp.TppInfo> getTppInfo​(@NotNull String tppAuthorisationNumber, @NotNull String instanceId)
      Loads TPP info record by TPP authorisation number
      @NotNull Optional<de.adorsys.psd2.xs2a.core.tpp.TppStopListRecord> getTppStopListRecord​(@NotNull String tppAuthorisationNumber, @NotNull String instanceId)
      Loads TPP stop list record by TPP ID
      boolean unblockTpp​(@NotNull String tppAuthorisationNumber, @NotNull String instanceId)
      Releases lock of requests from TPP by given TPP ID.

    • Method Detail

      • getTppStopListRecord

        @NotNull
@NotNull Optional<de.adorsys.psd2.xs2a.core.tpp.TppStopListRecord> getTppStopListRecord​(@NotNull
                                                                                        @NotNull String tppAuthorisationNumber,
                                                                                        @NotNull
                                                                                        @NotNull String instanceId)
        Loads TPP stop list record by TPP ID
        Parameters:
        tppAuthorisationNumber - ID of TPP to load
        instanceId - optional ID of particular service instance
        Returns:
        TPP Stop list object object if found in DB

      • blockTpp

        boolean blockTpp​(@NotNull
                 @NotNull String tppAuthorisationNumber,
                 @NotNull
                 @NotNull String instanceId,
                 @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 Record with given ID doesn't exist in DB, creates an empty one with given ID
        Parameters:
        tppAuthorisationNumber - ID of TPP to lock
        instanceId - optional ID of particular service instance
        lockPeriod - Time period of locking. May be omitted.
        Returns:
        true if lock was done. false otherwise.

      • unblockTpp

        boolean unblockTpp​(@NotNull
                   @NotNull String tppAuthorisationNumber,
                   @NotNull
                   @NotNull String instanceId)
        Releases lock of requests from TPP by given TPP ID. If Record with given ID doesn't exist in DB, does nothing.
        Parameters:
        tppAuthorisationNumber - ID of TPP to lock
        instanceId - optional ID of particular service instance
        Returns:
        true if TPP was found and unlock was done. false otherwise.

      • getTppInfo

        @NotNull
@NotNull Optional<de.adorsys.psd2.xs2a.core.tpp.TppInfo> getTppInfo​(@NotNull
                                                                    @NotNull String tppAuthorisationNumber,
                                                                    @NotNull
                                                                    @NotNull String instanceId)
        Loads TPP info record by TPP authorisation number
        Parameters:
        tppAuthorisationNumber - ID of TPP to load
        instanceId - optional ID of particular service instance
        Returns:
        TPP info object if found in DB