Package com.avoka.fc.core.service

Interface ITransactionProcessor

  • All Known Implementing Classes:
    TransactionProcessor
    public interface ITransactionProcessor
    Provides a transaction processor service interface. A transaction processor is a service that does a number of operations (abandonment, expiry, receipting, delivery) for the set of transactions in the system that need to be processed.
    Since:
    4.1.0

    • Method Detail

      • isIncludeTaskExpiry

        boolean isIncludeTaskExpiry()
        Returns:
        whether the transaction processor will perform task expiry.

      • isIncludeAbandonment

        boolean isIncludeAbandonment()
        Returns:
        whether the transaction processor will perform submission abandonment.

      • isIncludeDelivery

        boolean isIncludeDelivery()
        Returns:
        whether the transaction processor will perform submission delivery.

      • isIncludeRESTDeliveryRetry

        boolean isIncludeRESTDeliveryRetry()
        Returns:
        whether the transaction processor will perform REST delivery retry.
        Since:
        4.1.8

      • isIncludeTransactionHistory

        boolean isIncludeTransactionHistory()
        Returns:
        whether the transaction processor will create transaction history records
        Since:
        18.5.0

      • isIncludeDataRetention

        boolean isIncludeDataRetention()
        Returns:
        whether the transaction processor will perform data retention.
        Since:
        4.3.3

      • setLogToEventLog

        void setLogToEventLog​(boolean value)
        Specify whether to log the results of the transaction processing to the event log.
        Parameters:
        value - to specify whether to log the results of the transaction processing to the event log
        Since:
        4.3.3

      • getSystemAlertTimeMinutes

        int getSystemAlertTimeMinutes()
        Returns the number of minutes that the system monitoring job will use when determining whether system alerts need to be raised about the transaction processing service. For example, if the transaction processing job has not run in the last n minutes (as determined by this setting) and is not paused, a system alert will be raised.
        Returns:
        the number of minutes to use in system monitoring

      • processTransactions

        void processTransactions()
        Process the list of transactions in the system, performing necessary steps such as abandonment, receipting and delivery in a meaningful sequence. Each step will operate only on the set of transactions eligible for it and commit its work before the next step starts.

      • interruptProcessing

        void interruptProcessing()
        Interrupt ongoing transaction processing. This does not happen instantaneously, but the service will check at suitable occasions (e.g. after processing a submission) and stop processing.