com.inductiveautomation.ignition.gateway.audit

Interface AuditManager

All Superinterfaces:

ExtensionPointManager

public interface AuditManager
extends ExtensionPointManager

Method Summary

Modifier and Type	Method and Description
void	addAuditProfileType(AuditProfileType type) Adds a new type of audit profile to the system.
AuditInfo	getAuditInfo() Attempts to return useful contextual information about the current thread by accessing internal session threadlocals.
AuditProfile	getGatewayAuditProfile() Returns the audit profile specified by SystemPropertiesRecord.GatewayAuditProfile, or null.
AuditProfile	getProfile(java.lang.String name) Returns the named audit profile, or null if none exists with that name
AuditProfile	getProfileForProject(java.lang.Long projectId, ProjectVersion version) Returns the audit profile for a given project.

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointManager

getExtensionPoint, getExtensionPoints

Method Detail

getAuditInfo

AuditInfo getAuditInfo()

Attempts to return useful contextual information about the current thread by accessing internal session threadlocals.

getProfile

@Nullable
AuditProfile getProfile(java.lang.String name)
                           throws java.lang.Exception

Returns the named audit profile, or null if none exists with that name

Throws:

java.lang.Exception

getProfileForProject

@Nullable
AuditProfile getProfileForProject(java.lang.Long projectId,
                                            ProjectVersion version)

Returns the audit profile for a given project. May be null

getGatewayAuditProfile

@Nullable
AuditProfile getGatewayAuditProfile()

Returns the audit profile specified by SystemPropertiesRecord.GatewayAuditProfile, or null.

addAuditProfileType

void addAuditProfileType(AuditProfileType type)
                  throws java.lang.Exception

Adds a new type of audit profile to the system. Also makes sure that the persistent settings record indicated in the type is known by the internal schema manager

Parameters:

type - The new type of audit profile to add.

Throws:

java.lang.Exception - If automatic schema updating fails.