Record Class AuditProvenance
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.audit.AuditProvenance
- Record Components:
actor- the acting user (orunknown) recorded as the audit actor.host- the host the action originated from.scope- theApplicationScopethe action originated in, recorded as the originating context.originatingSystem- the originating-system path recorded on the audit record.project- the project whose audit profile the emitter resolves whengatewayProfileis false; ignored otherwise. A null or empty project withgatewayProfilefalse leaves the action unaudited.timestampMillis- the audit timestamp, in epoch milliseconds.gatewayProfile- true when the emitter resolves the single gateway-wide audit profile rather thanproject's. Says nothing about where the action came from: Gateway Network writes and Gateway web API writes both set it.
public record AuditProvenance(String actor, String host, int scope, String originatingSystem, @Nullable String project, long timestampMillis, boolean gatewayProfile)
extends Record
Where an audited action came from, captured at the origin site and carried to whichever component
emits the audit record — so one emitter builds the record instead of every origin site
building its own.
These are the fields known when the user acts; the rest of an AuditRecord (target,
value, previous value, status) is only knowable at completion, which is why this is its own type
rather than a half-populated record. project() and gatewayProfile() have no
counterpart on the record at all — the emitter needs them to resolve the audit profile.
Nothing here is subsystem-specific. A tag write carries it on its most-recent TagReferenceLocation, which holds it
in a transient field: provenance is gateway-local and never travels.
-
Constructor Summary
ConstructorsConstructorDescriptionAuditProvenance(String actor, String host, int scope, String originatingSystem, @Nullable String project, long timestampMillis, boolean gatewayProfile) Creates an instance of aAuditProvenancerecord class. -
Method Summary
Modifier and TypeMethodDescriptionactor()Returns the value of theactorrecord component.final booleanIndicates whether some other object is "equal to" this one.booleanReturns the value of thegatewayProfilerecord component.final inthashCode()Returns a hash code value for this object.host()Returns the value of thehostrecord component.Returns the value of theoriginatingSystemrecord component.@Nullable Stringproject()Returns the value of theprojectrecord component.intscope()Returns the value of thescoperecord component.longReturns the value of thetimestampMillisrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
AuditProvenance
public AuditProvenance(String actor, String host, int scope, String originatingSystem, @Nullable String project, long timestampMillis, boolean gatewayProfile) Creates an instance of aAuditProvenancerecord class.- Parameters:
actor- the value for theactorrecord componenthost- the value for thehostrecord componentscope- the value for thescoperecord componentoriginatingSystem- the value for theoriginatingSystemrecord componentproject- the value for theprojectrecord componenttimestampMillis- the value for thetimestampMillisrecord componentgatewayProfile- the value for thegatewayProfilerecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
actor
-
host
-
scope
-
originatingSystem
Returns the value of theoriginatingSystemrecord component.- Returns:
- the value of the
originatingSystemrecord component
-
project
-
timestampMillis
public long timestampMillis()Returns the value of thetimestampMillisrecord component.- Returns:
- the value of the
timestampMillisrecord component
-
gatewayProfile
public boolean gatewayProfile()Returns the value of thegatewayProfilerecord component.- Returns:
- the value of the
gatewayProfilerecord component
-