Package com.inductiveautomation.ignition.gateway.config

Interface ResourceAuditDelegate

public interface ResourceAuditDelegate

Part of a ResourceTypeMeta that provides custom auditing of the resource.

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceAuditDelegate	DEFAULT	A ResourceAuditDelegate that will perform default auditing of ChangeOperations.
static final ResourceAuditDelegate	DISABLED	A ResourceAuditDelegate that will not audit any ChangeOperations.
static final Set<String>	sensitiveKeys

Method Summary

Modifier and Type	Method	Description
default Optional<AuditRecord>	auditChangeOp(ChangeOperation operation, Resource resource, AuditContext auditContext)	Audit a ChangeOperation on a resource.

Field Details

DEFAULT

static final ResourceAuditDelegate DEFAULT

A ResourceAuditDelegate that will perform default auditing of ChangeOperations.

Default auditing includes the resource.json and the data.bin and/or the config.json if they exist.

DISABLED

static final ResourceAuditDelegate DISABLED

A ResourceAuditDelegate that will not audit any ChangeOperations.

sensitiveKeys

static final Set<String> sensitiveKeys

Method Details

auditChangeOp

default Optional<AuditRecord> auditChangeOp(ChangeOperation operation,
 Resource resource,
 @Nonnull
 AuditContext auditContext)

Audit a ChangeOperation on a resource.

Parameters:

operation - The operation to audit.

resource - The resource undergoing the change operation.

auditContext - The context used for generating the returned AuditRecord

Returns:

An Optional containing the AuditRecord to audit. Returning an empty Optional will result in no record being audited for this ChangeOperation.