Package de.adorsys.psd2.logger.context

Interface LoggingContextService

  • All Known Implementing Classes:
    MdcLoggingContextService
    public interface LoggingContextService
    Service for storing and retrieving information about the current request for further usage in logs. Should be cleared manually after every request.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearContext()
      Clears current logging context.
      String getConsentStatus()
      Retrieves consent status from current logging context as string
      RequestInfo getRequestInformation()
      Retrieves information about the request from current logging context
      String getScaStatus()
      Retrieves SCA status from current logging context as string
      String getTransactionStatus()
      Retrieves transaction status from current logging context as string
      void storeConsentStatus​(@NotNull de.adorsys.psd2.xs2a.core.consent.ConsentStatus consentStatus)
      Records given consent status into current context
      void storeRequestInformation​(RequestInfo requestInfo)
      Records information about the request into current logging context
      void storeScaStatus​(@NotNull de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus)
      Records given SCA status into current context
      void storeTransactionAndScaStatus​(@NotNull de.adorsys.psd2.xs2a.core.pis.TransactionStatus transactionStatus, @Nullable de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus)
      Records given transaction status and optional SCA status into current context
      void storeTransactionStatus​(@NotNull de.adorsys.psd2.xs2a.core.pis.TransactionStatus transactionStatus)
      Records given transaction status into current context

    • Method Detail

      • storeConsentStatus

        void storeConsentStatus​(@NotNull
                        @NotNull de.adorsys.psd2.xs2a.core.consent.ConsentStatus consentStatus)
        Records given consent status into current context
        Parameters:
        consentStatus - status to be stored

      • getConsentStatus

        String getConsentStatus()
        Retrieves consent status from current logging context as string
        Returns:
        string representation of consent status

      • storeTransactionStatus

        void storeTransactionStatus​(@NotNull
                            @NotNull de.adorsys.psd2.xs2a.core.pis.TransactionStatus transactionStatus)
        Records given transaction status into current context
        Parameters:
        transactionStatus - status to be stored

      • getTransactionStatus

        String getTransactionStatus()
        Retrieves transaction status from current logging context as string
        Returns:
        string representation of transaction status

      • storeScaStatus

        void storeScaStatus​(@NotNull
                    @NotNull de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus)
        Records given SCA status into current context
        Parameters:
        scaStatus - status to be stored

      • storeTransactionAndScaStatus

        void storeTransactionAndScaStatus​(@NotNull
                                  @NotNull de.adorsys.psd2.xs2a.core.pis.TransactionStatus transactionStatus,
                                  @Nullable
                                  @Nullable de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus)
        Records given transaction status and optional SCA status into current context
        Parameters:
        transactionStatus - transaction status to be stored
        scaStatus - optional SCA status to be stored

      • getScaStatus

        String getScaStatus()
        Retrieves SCA status from current logging context as string
        Returns:
        string representation of SCA status

      • storeRequestInformation

        void storeRequestInformation​(RequestInfo requestInfo)
        Records information about the request into current logging context
        Parameters:
        requestInfo - information about the request

      • getRequestInformation

        RequestInfo getRequestInformation()
        Retrieves information about the request from current logging context
        Returns:
        information about the request

      • clearContext

        void clearContext()
        Clears current logging context.

        Should be called for every request.