Package fr.becpg.repo.audit.plugin

Interface DatabaseAuditPlugin

All Superinterfaces:
AuditPlugin
All Known Subinterfaces:
ExtraQueryDatabaseAuditPlugin
All Known Implementing Classes:
ActivityAuditPlugin, BatchAuditPlugin, ExportSearchAuditPlugin, FormulationAuditPlugin, ReportAuditPlugin
public interface DatabaseAuditPlugin extends AuditPlugin

DatabaseAuditPlugin interface.

Version:
$Id: $Id
Author:
matthieu

  • Method Details

    • beforeRecordAuditEntry

      void beforeRecordAuditEntry(Map<String,Serializable> auditValues)

      beforeRecordAuditEntry.

      Parameters:
      auditValues - a Map object

    • afterRecordAuditEntry

      void afterRecordAuditEntry(Map<String,Serializable> auditValues)

      afterRecordAuditEntry.

      Parameters:
      auditValues - a Map object

    • getAuditApplicationId

      String getAuditApplicationId()

      getAuditApplicationId.

      Returns:
      a String object

    • getAuditApplicationPath

      String getAuditApplicationPath()

      getAuditApplicationPath.

      Returns:
      a String object

    • getKeyMap

      Map<String,AuditDataType> getKeyMap()

      getKeyMap.

      Returns:
      a Map object

    • isRecordOnStart

      default boolean isRecordOnStart()
      Whether the entry has to be recorded when the audited operation starts and completed when it ends, instead of being recorded once at the end. An operation heavy enough to bring the server down leaves no trace at all when its entry is only written on completion. Recording it upfront keeps the author, the volume and the start time available even when the operation never returns: such an entry simply stays flagged as not completed.
      Returns:
      a boolean

    • getFilterHierarchy

      default List<String> getFilterHierarchy()
      The audit keys a query may filter on, the most selective first. The database matches a single filter, the other ones being applied in memory on the entries it returns: the query reads with the most selective of its filters, so that the database returns as few entries as possible. A key missing from the hierarchy comes after the listed ones.
      Returns:
      a List object