AuditContext

java.lang.Object
- com.inductiveautomation.ignition.gateway.audit.AuditContext

public final class AuditContext
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AuditContext.Builder

Field Summary

Fields
Modifier and Type Field Description

static java.util.function.Supplier<AuditContext> UNKNOWN

static java.lang.String UNKNOWN_ACTOR

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getActor()`
`java.lang.String`	`getHost()`
`QualifiedPath`	`getPath()`
`int`	`getScope()`
`int`	`getStatusCode()`
`java.util.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`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNKNOWN_ACTOR
```
public static final java.lang.String UNKNOWN_ACTOR
```
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final java.util.function.Supplier<AuditContext> UNKNOWN
```
- Method Detail
  - getActor
```
@Nonnull
public java.lang.String getActor()
```
  - getHost
```
@Nonnull
public java.lang.String getHost()
```
  - getScope
```
public int getScope()
```
  - getPath
```
@Nonnull
public QualifiedPath getPath()
```
  - getTimestamp
```
@Nonnull
public java.util.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