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

Modifier and Type	Method	Description
void	audit(AuditRecord record)	Logs the given record to the audit log
List<AuditRecord>	query(String actorFilter, String actionFilter, String actionTargetFilter, String actionValueFilter, Date startTime, Date endTime, String systemFilter, 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 Details

startup

default void startup()
              throws Exception

Override to implement specific startup behavior. Defaults to no-op.

Throws:

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

List<AuditRecord> query(@Nullable
 String actorFilter,
 @Nullable
 String actionFilter,
 @Nullable
 String actionTargetFilter,
 @Nullable
 String actionValueFilter,
 @Nullable
 Date startTime,
 @Nullable
 Date endTime,
 @Nullable
 String systemFilter,
 @Nullable
 Integer contextFilter)
                 throws 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:

Exception