com.inductiveautomation.ignition.gateway.audit

Interface AuditRecord

All Known Implementing Classes:

DefaultAuditRecord

public interface AuditRecord

A record about a single audit event

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAction() A description of the action.
java.lang.String	getActionTarget() The target of the action.
java.lang.String	getActionValue() The value of the action.
java.lang.String	getActor() Who performed the event.
java.lang.String	getActorHost() Where the actor was when the action was performed.
int	getOriginatingContext() The ApplicationScope where this record was generated from
java.lang.String	getOriginatingSystem() A Description of the originating system for this record
int	getStatusCode() The StatusCode that represents whether this action was successful or not.
java.util.Date	getTimestamp() The timestamp at which this record occured

Method Detail

getActor

java.lang.String getActor()

Who performed the event. Should be a username or appropriate system equivalent if the event was performed automatically by a program

getActorHost

java.lang.String getActorHost()

Where the actor was when the action was performed. Should be an IP address or a hostname of a computer

getAction

java.lang.String getAction()

A description of the action. Examples: "tag write", "tag delete", "tag edit", " query update", " login", "logout" "project save"

getActionTarget

java.lang.String getActionTarget()

The target of the action.

getActionValue

java.lang.String getActionValue()

The value of the action. Might not be present for all action types

getStatusCode

int getStatusCode()

The StatusCode that represents whether this action was successful or not.

getTimestamp

java.util.Date getTimestamp()

The timestamp at which this record occured

getOriginatingSystem

java.lang.String getOriginatingSystem()

A Description of the originating system for this record

getOriginatingContext

int getOriginatingContext()

The ApplicationScope where this record was generated from