Package pl.edu.icm.unity.engine.api

Interface AuditEventManagement

  • public interface AuditEventManagement
    AuditEvent management API.
    Author:
    R. Ledzinski

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void disableAuditEvents()
      Disable Audit Logs feature (Audit Logs gathering) n the system.
      void enableAuditEvents()
      Enable Audit Logs feature (Audit Logs gathering) in the system.
      java.util.List<pl.edu.icm.unity.types.basic.audit.AuditEvent> getAllEvents()
      List of AuditEvent objects.
      java.util.Set<java.lang.String> getAllTags()
      List of tags.
      java.util.List<pl.edu.icm.unity.types.basic.audit.AuditEvent> getAuditEvents​(java.util.Date from, java.util.Date until, int limit, java.lang.String order, int direction)
      Retrieve list of AuditEvents sorted by timestamp for given time period.
      boolean isPublisherEnabled()
      Checks, if Audit Logs feature (Audit Logs gathering) in enabled in the system.

    • Method Detail

      • getAllEvents

        java.util.List<pl.edu.icm.unity.types.basic.audit.AuditEvent> getAllEvents()
        List of AuditEvent objects.
        Returns:
        all AuditEvent sorted by timestamp .

      • getAuditEvents

        java.util.List<pl.edu.icm.unity.types.basic.audit.AuditEvent> getAuditEvents​(java.util.Date from,
                                                                             java.util.Date until,
                                                                             int limit,
                                                                             java.lang.String order,
                                                                             int direction)
        Retrieve list of AuditEvents sorted by timestamp for given time period.
        Parameters:
        from - From date or from the earliest timestamp (if null)
        until - Until date or till the latest timestamp (if null)
        limit - Maximum number of returned records
        order - AuditEvent field for sorting purposes - at this moment only "timestamp" value is supported
        direction - Descending in case of negative value, ascending order in other cases.
        Returns:
        AuditEvent list sorted by timestamp.

      • getAllTags

        java.util.Set<java.lang.String> getAllTags()
        List of tags.
        Returns:
        all Tags sorted by name.

      • isPublisherEnabled

        boolean isPublisherEnabled()
        Checks, if Audit Logs feature (Audit Logs gathering) in enabled in the system.
        Returns:
        Audit Logs feature status

      • enableAuditEvents

        void enableAuditEvents()
        Enable Audit Logs feature (Audit Logs gathering) in the system.

      • disableAuditEvents

        void disableAuditEvents()
        Disable Audit Logs feature (Audit Logs gathering) n the system.