Package org.forgerock.openam.cts.monitoring

Interface CTSReaperMonitoringStore

  • All Known Implementing Classes:
    CTSMonitoringStoreImpl
    public interface CTSReaperMonitoringStore
    A data structure for storing monitoring information about the CTS Reaper. The CTS Reaper will use an instance of this data structure to store information about runs as and when they occur and then the CTS monitoring framework will us the same instance to pull information out to send to clients as monitoring requests are made.
    Since:
    12.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addReaperRun​(long startTime, long runTime, long numberOfDeletedSessions)
      Adds a CTS Reaper run to the monitoring store.
      double getRateOfDeletedSessions()
      Gets the average rate of deletion based from all of the reaper runs since server start up.

    • Method Detail

      • addReaperRun

        void addReaperRun​(long startTime,
                  long runTime,
                  long numberOfDeletedSessions)
        Adds a CTS Reaper run to the monitoring store.
        Parameters:
        startTime - The start time of the reaper run.
        runTime - The end time of the reaper run.
        numberOfDeletedSessions - The total number of deleted sessions.

      • getRateOfDeletedSessions

        double getRateOfDeletedSessions()
        Gets the average rate of deletion based from all of the reaper runs since server start up.
        Returns:
        The rate of session deletion by the CTS Reaper.