Package com.inductiveautomation.ignition.gateway.audit.storeforward

Class PersistentAuditRecord

java.lang.Object

com.inductiveautomation.ignition.gateway.audit.storeforward.PersistentAuditRecord

All Implemented Interfaces:

AuditRecord, PersistentData

public class PersistentAuditRecord
extends Object
implements AuditRecord, PersistentData

An AuditRecord wrapper that contains PersistentFlavor information that can be used within the Store & Forward system.

Field Summary

Fields

Modifier and Type	Field	Description
static final PersistentFlavor<PersistentAuditRecord>	FLAVOR

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAction()	A description of the action.
String	getActionTarget()	The target of the action.
String	getActionValue()	The value of the action.
String	getActor()	Who performed the event.
String	getActorHost()	Where the actor was when the action was performed.
PersistentFlavor<PersistentAuditRecord>	getFlavor()	Retrieves the PersistentFlavor associated with this kind of persistent data.
int	getOriginatingContext()	The ApplicationScope where this record was generated from
String	getOriginatingSystem()	A Description of the originating system for this record
int	getStatusCode()	The StatusCode that represents whether this action was successful or not.
Date	getTimestamp()	The timestamp at which this record occured
int	hashCode()
static PersistentAuditRecord	wrap(AuditRecord auditRecord)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.storeforward.data.PersistentData

getDataCount

Field Details

FLAVOR

public static final PersistentFlavor<PersistentAuditRecord> FLAVOR

Method Details

wrap

public static PersistentAuditRecord wrap(AuditRecord auditRecord)

getActor

public String getActor()

Description copied from interface: AuditRecord

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

Specified by:

getActor in interface AuditRecord

getActorHost

public String getActorHost()

Description copied from interface: AuditRecord

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

Specified by:

getActorHost in interface AuditRecord

getAction

public String getAction()

Description copied from interface: AuditRecord

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

Specified by:

getAction in interface AuditRecord

getActionTarget

public String getActionTarget()

Description copied from interface: AuditRecord

The target of the action.

Specified by:

getActionTarget in interface AuditRecord

getActionValue

public String getActionValue()

Description copied from interface: AuditRecord

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

Specified by:

getActionValue in interface AuditRecord

getStatusCode

public int getStatusCode()

Description copied from interface: AuditRecord

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

Specified by:

getStatusCode in interface AuditRecord

getTimestamp

public Date getTimestamp()

Description copied from interface: AuditRecord

The timestamp at which this record occured

Specified by:

getTimestamp in interface AuditRecord

getOriginatingSystem

public String getOriginatingSystem()

Description copied from interface: AuditRecord

A Description of the originating system for this record

Specified by:

getOriginatingSystem in interface AuditRecord

getOriginatingContext

public int getOriginatingContext()

Description copied from interface: AuditRecord

The ApplicationScope where this record was generated from

Specified by:

getOriginatingContext in interface AuditRecord

getFlavor

@Nonnull
public PersistentFlavor<PersistentAuditRecord> getFlavor()

Description copied from interface: PersistentData

Retrieves the PersistentFlavor associated with this kind of persistent data.

Specified by:

getFlavor in interface PersistentData

Returns:

a PersistentFlavor object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object