Package com.inductiveautomation.ignition.gateway.audit

Interface AuditProfile

  • public interface AuditProfile

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  AuditProfile.QueryAuditRecordBuilder
      Convenience object - if you're building audit records from some DB query, this will create them for you.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void audit​(AuditRecord record)
      Logs the given record to the audit log
      java.util.List<AuditRecord> query​(java.lang.String actorFilter, java.lang.String actionFilter, java.lang.String actionTargetFilter, java.lang.String actionValueFilter, java.util.Date startTime, java.util.Date endTime, java.lang.String systemFilter, java.lang.Integer contextFilter)
      Queries the audit log for any records that match the given filter elements.
      default void shutdown()
      Override to implement specific shutdown behavior.
      default void startup()
      Override to implement specific startup behavior.

    • Method Detail

      • startup

        default void startup()
              throws java.lang.Exception
        Override to implement specific startup behavior. Defaults to no-op.
        Throws:
        java.lang.Exception
        Since:
        8.0.5

      • shutdown

        default void shutdown()
        Override to implement specific shutdown behavior. Defaults to no-op.
        Since:
        8.0.5

      • audit

        void audit​(AuditRecord record)
        Logs the given record to the audit log

      • query

        java.util.List<AuditRecord> query​(@Nullable
                                  java.lang.String actorFilter,
                                  @Nullable
                                  java.lang.String actionFilter,
                                  @Nullable
                                  java.lang.String actionTargetFilter,
                                  @Nullable
                                  java.lang.String actionValueFilter,
                                  @Nullable
                                  java.util.Date startTime,
                                  @Nullable
                                  java.util.Date endTime,
                                  @Nullable
                                  java.lang.String systemFilter,
                                  @Nullable
                                  java.lang.Integer contextFilter)
                           throws java.lang.Exception
        Queries the audit log for any records that match the given filter elements. All filter arguments can be null, which means to not filter by that field. String based filters can include a wildcard character of '%' which means any characters (zero or more)
        Parameters:
        contextFilter - A bitmask for ApplicationScope
        Throws:
        java.lang.Exception