Package org.alfresco.repo.batch

Interface BatchMonitor

All Known Implementing Classes:
BatchProcessor
public interface BatchMonitor
An interface that allows the monitoring of metrics relating to a potentially long-running batch process.
Author:
dward

  • Method Details

    • getProcessName

      String getProcessName()
      Gets the process name.
      Returns:
      the process name

    • getStartTime

      Date getStartTime()
      Gets the start time.
      Returns:
      the start time

    • getTotalResults

      @Deprecated int getTotalResults()
      Deprecated.
      use getTotalResultsLong() instead
      Gets the total number of results.
      Returns:
      the total number of results

    • getCurrentEntryId

      String getCurrentEntryId()
      Gets the ID of the entry being processed
      Returns:
      the current entry id

    • getSuccessfullyProcessedEntries

      @Deprecated int getSuccessfullyProcessedEntries()
      Deprecated.
      use getSuccessfullyProcessedEntriesLong() instead
      Gets the number of successfully processed entries.
      Returns:
      the successfully processed entries

    • getPercentComplete

      String getPercentComplete()
      Gets the progress expressed as a percentage.
      Returns:
      the progress expressed as a percentage

    • getTotalErrors

      @Deprecated int getTotalErrors()
      Deprecated.
      use getTotalErrorsLong() instead
      Gets the total number of errors.
      Returns:
      the total number of errors

    • getLastError

      String getLastError()
      Gets the stack trace of the last error.
      Returns:
      the stack trace of the last error

    • getLastErrorEntryId

      String getLastErrorEntryId()
      Gets the entry id that caused the last error.
      Returns:
      the last error entry id

    • getEndTime

      Date getEndTime()
      Gets the end time.
      Returns:
      the end time

    • getTotalResultsLong

      default long getTotalResultsLong()
      Gets the total number of results.
      Returns:
      the total number of results

    • getTotalErrorsLong

      default long getTotalErrorsLong()
      Gets the total number of errors.
      Returns:
      the total number of errors

    • getSuccessfullyProcessedEntriesLong

      default long getSuccessfullyProcessedEntriesLong()
      Gets the number of successfully processed entries.
      Returns:
      the successfully processed entries