Package com.inductiveautomation.ignition.gateway.audit

Interface AuditManager

All Superinterfaces:

ExtensionPointManager

All Known Implementing Classes:

DelegatingAuditManager

public interface AuditManager
extends ExtensionPointManager

Method Summary

Modifier and Type	Method	Description
void	addAuditProfileType(AuditProfileType type)	Adds a new type of audit profile to the system.
void	clearAuditContext()	Removes the threadlocal AuditContext
java.util.Optional<AuditContext>	getAuditContext()	Returns a populated AuditContext if the current thread is attached to a valid http session, ie a ClientReqSession or IgnitionSession.
java.util.List<java.lang.String>	getAvailableAuditProfiles()	Return the list of audit profiles known to this manager.
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.String projectName)	Returns the audit profile for a given project.
void	removeAuditProfileType(java.lang.String typeId)	Remove an audit profile type with the given type ID.
void	setAuditContext(AuditContext auditContext)	Sets an threadlocal for AuditContext that will be returned by getAuditContext() on the calling thread until clearAuditContext() is invoked.

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

getExtensionPoint, getExtensionPoints

Method Detail

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.String projectName)

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.

getAuditContext

java.util.Optional<AuditContext> getAuditContext()

Returns a populated AuditContext if the current thread is attached to a valid http session, ie a ClientReqSession or IgnitionSession. Returns an empty optional if no contextual information could be found.

setAuditContext

void setAuditContext(AuditContext auditContext)

Sets an threadlocal for AuditContext that will be returned by getAuditContext() on the calling thread until clearAuditContext() is invoked.

clearAuditContext

void clearAuditContext()

Removes the threadlocal AuditContext

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.

removeAuditProfileType

void removeAuditProfileType(java.lang.String typeId)

Remove an audit profile type with the given type ID.

Parameters:

typeId - The typeId associated with the audit profile to remove.

Throws:

java.lang.IllegalArgumentException - if the typeId to remove is associated with a built-in audit profile type or a type which does not exist

getAvailableAuditProfiles

java.util.List<java.lang.String> getAvailableAuditProfiles()

Return the list of audit profiles known to this manager.

Since:

8.0.5