Package com.inductiveautomation.ignition.gateway.audit

Class AuditContext

java.lang.Object

com.inductiveautomation.ignition.gateway.audit.AuditContext

public final class AuditContext
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuditContext.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Supplier<AuditContext>	UNKNOWN	Deprecated. use unknown(int) instead.
static final String	UNKNOWN_ACTOR

Method Summary

Modifier and Type	Method	Description
String	getActor()
String	getHost()
QualifiedPath	getPath()
int	getScope()
int	getStatusCode()
Date	getTimestamp()
AuditContext.Builder	toContextBuilder()
AuditRecordBuilder	toRecordBuilder()	Pull fields from this AuditContext into a new AuditRecordBuilder instance, which should then be supplied with (at minimum) an action, target, and value.
static Supplier<AuditContext>	unknown(int scope)	Convenience method to create a new unknown AuditContext with the given scope.

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_ACTOR

public static final String UNKNOWN_ACTOR

See Also:

• Constant Field Values

UNKNOWN

@Deprecated(since="8.1.41")
public static final Supplier<AuditContext> UNKNOWN

Deprecated.

use unknown(int) instead. Not slated for removal

Only use this AuditContext when the context of the audit is unknown. It is preferrable to call the unknown(int) method to provide an ApplicationScope other than ApplicationScope.NONE.

Method Details

unknown

public static Supplier<AuditContext> unknown(int scope)

Convenience method to create a new unknown AuditContext with the given scope. This will return an AuditContext identical to UNKNOWN, except with the given scope instead of #ApplicationScope.NONE.

Parameters:

scope - The application scope.

Returns:

The Supplier of the AuditContext.

See Also:

• UNKNOWN

getActor

@Nonnull
public String getActor()

getHost

@Nonnull
public String getHost()

getScope

public int getScope()

getPath

@Nonnull
public QualifiedPath getPath()

getTimestamp

@Nonnull
public Date getTimestamp()

getStatusCode

public int getStatusCode()

toRecordBuilder

public AuditRecordBuilder toRecordBuilder()

Pull fields from this AuditContext into a new AuditRecordBuilder instance, which should then be supplied with (at minimum) an action, target, and value. Project specific, or otherwise more 'narrow' systems, should also extend the QualifiedPath available on this AuditContext, to provide more specific context; see also WellKnownPathTypes for inspiration.

toContextBuilder

public AuditContext.Builder toContextBuilder()

Returns:

a new AuditContext.Builder with all fields set to this context's fields