Class AuditActor

java.lang.Object
com.inductiveautomation.ignition.common.audit.AuditActor
Direct Known Subclasses:
AuditActor.ClassicUser, AuditActor.IdpUser, AuditActor.Unauthenticated, AuditActor.Unknown

public abstract sealed class AuditActor extends Object permits AuditActor.Unknown, AuditActor.Unauthenticated, AuditActor.ClassicUser, AuditActor.IdpUser
An actor for an audit record.
  • Field Details

    • UNKNOWN

      public static final AuditActor.Unknown UNKNOWN
      An unknown actor. Use this actor when the user driving the action being audited is unknown.
    • UNAUTHENTICATED

      public static final AuditActor.Unauthenticated UNAUTHENTICATED
      An unauthenticated actor. Use this actor when the user driving the action being audited is known to have not been authenticated.
  • Method Details

    • forIdpUser

      public static AuditActor forIdpUser(@Nullable String idpName, @Nullable String username)
      Create an AuditActor for a user authenticated via an IdP.

      If username is null, returns UNKNOWN. If idpName is null or blank, the resulting actor's toString() will be the bare username.

      Parameters:
      idpName - the IdP the user authenticated with.
      username - the username of the authenticated user.
      Returns:
      the AuditActor instance.
    • forClassicUser

      public static AuditActor forClassicUser(@Nullable String profileName, @Nullable String username)
      Create an AuditActor for a user authenticated via a classic user source.

      If username is null, returns UNKNOWN. If profileName is null or blank, the resulting actor's toString() will be the bare username.

      Parameters:
      profileName - the user source the user authenticated against.
      username - the username of the authenticated user.
      Returns:
      the AuditActor instance.
    • toString

      public abstract String toString()
      Overrides:
      toString in class Object